Foxit PDF SDK

fs_combination.h
Go to the documentation of this file.
1
15 #ifndef FS_COMBINATION_H_
16 #define FS_COMBINATION_H_
17
18 #include "common/fs_common.h"
19 #include "pdf/fs_pdfdoc.h"
20
26 namespace foxit {
30 namespace pdf {
32 class CombineDocumentInfo FS_FINAL : public Base {
33 public:
43 CombineDocumentInfo(const WString& file_path, const WString& password);
44
55 CombineDocumentInfo(const PDFDoc& doc);
56
57 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
58 explicit CombineDocumentInfo(FS_HANDLE handle);
59
61 ~CombineDocumentInfo();
62
68 CombineDocumentInfo(const CombineDocumentInfo& other);
69
77 CombineDocumentInfo& operator=(const CombineDocumentInfo& other);
78
86 bool operator==(const CombineDocumentInfo& other) const;
87
95 bool operator!=(const CombineDocumentInfo& other) const;
96
104 bool IsEmpty() const;
105
121 void SetBookmarkTitle(const WString& bookmark_title);
122
135 void SetPDFFileName(const WString& pdf_file_name);
136 };
137
139 FSDK_DEFINE_ARRAY(CombineDocumentInfoArray, CombineDocumentInfo)
140
141
144 class Combination FS_FINAL : public Base {
145 public:
151 typedef enum _CombineDocsOptions {
153 e_CombineDocsOptionBookmark = 0x0001,
155 e_CombineDocsOptionAcroformRename = 0x0002,
157 e_CombineDocsOptionStructrueTree = 0x0004,
159 e_CombineDocsOptionOutputIntents = 0x0008,
161 e_CombineDocsOptionOCProperties = 0x0010,
163 e_CombineDocsOptionMarkInfos = 0x0020,
165 e_CombineDocsOptionPageLabels = 0x0040,
170 e_CombineDocsOptionNames = 0x0080,
175 e_CombineDocsOptionObjectStream = 0x0100,
177 e_CombineDocsOptionDuplicateStream = 0x0200
178 } CombineDocsOptions;
179
180
201 static common::Progressive StartCombineDocuments(const char* dest_file_path, const CombineDocumentInfoArray& document_array, uint32 options, common::PauseCallback* pause = NULL);
202
223 static common::Progressive StartCombineDocuments(const wchar_t* dest_file_path, const CombineDocumentInfoArray& document_array, uint32 options, common::PauseCallback* pause = NULL);
224
246 static common::Progressive StartCombineDocuments(foxit::common::file::WriterCallback* dest_file, const CombineDocumentInfoArray& document_array, uint32 options, foxit::common::PauseCallback* pause = NULL);
247 };
248
249 } // namespace pdf
250 } // namespace foxit
251 #endif // FS_COMBINATION_H_
252
foxit::pdf::CombineDocumentInfo::CombineDocumentInfo
CombineDocumentInfo(const WString &file_path, const WString &password)
Constructor, with parameters.
foxit::pdf::CombineDocumentInfo::operator=
CombineDocumentInfo & operator=(const CombineDocumentInfo &other)
Assign operator.
IFX_FileWrite
File writing interface.
Definition: fx_stream.h:470
fs_pdfdoc.h
Header file for PDF document related definitions and classes.
foxit::pdf::CombineDocumentInfoArray
Definition: fs_combination.h:139
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
foxit::pdf::CombineDocumentInfo::~CombineDocumentInfo
~CombineDocumentInfo()
Destructor.
foxit::pdf::CombineDocumentInfo::operator==
bool operator==(const CombineDocumentInfo &other) const
Equal operator.
foxit::pdf::Combination
Definition: fs_combination.h:144
IFX_Pause
Definition: fx_basic.h:3758
foxit::pdf::CombineDocumentInfo::operator!=
bool operator!=(const CombineDocumentInfo &other) const
Not equal operator.
foxit::common::Progressive
Definition: fs_common.h:373
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
fs_common.h
Header file for common definitions and classes.
foxit::pdf::CombineDocumentInfo::SetBookmarkTitle
void SetBookmarkTitle(const WString &bookmark_title)
Set the title of a new parent bookmark for the root bookmark of related source PDF document in combin...
foxit::Base
Definition: fs_basictypes.h:451
foxit::pdf::CombineDocumentInfo
Definition: fs_combination.h:32
foxit
Foxit namespace.
Definition: fs_pdf3d.h:26
foxit::pdf::CombineDocumentInfo::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
foxit::pdf::CombineDocumentInfo::SetPDFFileName
void SetPDFFileName(const WString &pdf_file_name)
Set the name of the PDF file, which will be combined with other PDF files.