PtlPDFDocument.h

// PtlPDFDocument.h
// Copyright (C) 2013-2020 Antenna House,Inc.
// All rights reserved.
#ifndef PDFTK_PTLPDFDOCUMENT_H_
#define PDFTK_PTLPDFDOCUMENT_H_
 
#include "PtlOutline.h"
#include "PtlParamString.h"
#include "PtlFormFieldValues.h"
#include "PtlSearchTextResults.h"
 
namespace PdfTk {
 
class PtlParamStream;
class PtlEncrypt;
class PtlDocProperty;
class PtlPages;
class PtlEmbeddedFiles;
class PtlParamWaterMark;
class PtlParamRestriction;
class PtlParamOptimize;
class PtlParamSearchTextAndHighlight;
class PtlParamSearchTextAndSetMask;
class PtlParamSearchText;
 
class PDFTK_API PtlPDFDocument
{
public:
    enum SAVE_OPTION {
        SAVE_RECONSTRUCT            = 0,    
        SAVE_LINEARIZE              = 1,    
        SAVE_INCREMENTAL_UPDATE     = 2     
    };
 
    enum PDFA_TYPE {
        PDFA_1A             = 101,      
        PDFA_1B             = 102,      
        PDFA_2A             = 201,      
        PDFA_2B             = 202,      
        PDFA_2U             = 221,      
        PDFA_3A             = 301,      
        PDFA_3B             = 302,      
        PDFA_3U             = 321,      
        PDFA_UNKNOWN        = 1000      
    };
 
private:
    int m_documentHandle;
public:
    int getHandle() const;
 
public:
    PtlPDFDocument();
 
    PtlPDFDocument(const PtlPDFDocument& obj);
 
    ‾PtlPDFDocument();
 
public:
    PtlPDFDocument& operator=(const PtlPDFDocument& obj);
 
public:
    void setPassword(const PtlParamString& password);
 
    void setPKCS12(PtlParamStream& inPKCS12);
 
    void load(PtlParamStream& inParam);
 
public:
    void setSaveOption(SAVE_OPTION option);
 
    void save(PtlParamStream& outParam);
 
public:
    bool isEncrypted() const;
 
    bool isEncryptedOnlyEmbeddedFiles() const;
 
    bool hasOwnerAuthority() const;
 
    const PtlEncrypt& getEncrypt();
 
    void setEncrypt(const PtlEncrypt& encrypt);
 
    void removeEncrypt();
 
    bool isSignatured() const;
 
    bool isPDFA() const;
 
    PDFA_TYPE getPDFAType() const;
 
    bool isPDFX() const;
 
public:
    PtlDocProperty& getDocProperty() const;
 
public:
    int getPageCount() const;
 
    PtlPages& getPages();
 
public:
    bool hasOutlines() const;
 
    PtlOutline getRootOutline() const;
 
public:
    bool hasEmbeddedFiles() const;
 
    PtlEmbeddedFiles& getEmbeddedFiles() const;
 
public:
    void appendWaterMark(const PtlParamWaterMark& waterMark);
 
    void removeWaterMark(const PtlParamString& name);
 
public:
    void setRestriction(const PtlParamRestriction& restriction);
 
public:
    bool optimize(const PtlParamOptimize& paramOptimize);
 
    bool embedFonts();
 
public:
    void importAnnotsFromFDF(PtlParamStream& inParam);
 
    void importAnnotsFromPDF(PtlParamStream& inParam);
 
    void exportAnnotsToFDF(PtlParamStream& outParam);
 
public:
    PtlFormFieldValues importFormFieldsFromFDF(PtlParamStream& inParam);
 
    void exportFormFieldsToFDF(PtlParamStream& outParam);
 
    void exportFormFieldsToXFDF(PtlParamStream& outParam);
 
    void importFormFieldsFromXFDF(PtlParamStream& inParam);
 
    void resetForm();
 
 
    void setExportEmptyDataFlg(bool flg);
 
public:
    int searchTextAndDoProcess(const PtlParamSearchText& paramSearchText);
 
    PtlSearchTextResults searchText(const PtlParamSearchText& paramSearchText);
};
 
} // namespace PdfTk
 
#endif // PDFTK_PTLPDFDOCUMENT_H_