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 
62 
69 
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 };
123 
126 
127 
130 class Combination FS_FINAL : public Base {
131  public:
137  typedef enum _CombineDocsOptions {
139  e_CombineDocsOptionBookmark = 0x0001,
141  e_CombineDocsOptionAcroformRename = 0x0002,
143  e_CombineDocsOptionStructrueTree = 0x0004,
145  e_CombineDocsOptionOutputIntents = 0x0008,
147  e_CombineDocsOptionOCProperties = 0x0010,
149  e_CombineDocsOptionMarkInfos = 0x0020,
151  e_CombineDocsOptionPageLabels = 0x0040,
156  e_CombineDocsOptionNames = 0x0080,
161  e_CombineDocsOptionObjectStream = 0x0100,
163  e_CombineDocsOptionDuplicateStream = 0x0200
164  } CombineDocsOptions;
165 
166 
186  static common::Progressive StartCombineDocuments(const char* dest_file_path, const CombineDocumentInfoArray& document_array, uint32 options, common::PauseCallback* pause = NULL);
187 
207  static common::Progressive StartCombineDocuments(const wchar_t* dest_file_path, const CombineDocumentInfoArray& document_array, uint32 options, common::PauseCallback* pause = NULL);
208 
229  static common::Progressive StartCombineDocuments(foxit::common::file::WriterCallback* dest_file, const CombineDocumentInfoArray& document_array, uint32 options, foxit::common::PauseCallback* pause = NULL);
230 };
231 
232 } // namespace pdf
233 } // namespace foxit
234 #endif // FS_COMBINATION_H_
235 
CombineDocumentInfo(const WString &file_path, const WString &password)
Constructor, with parameters.
CombineDocumentInfo & operator=(const CombineDocumentInfo &other)
Assign operator.
File writing interface.
Definition: fx_stream.h:451
Header file for PDF document related definitions and classes.
Definition: fs_combination.h:125
WIDE STRING CLASS.
Definition: fx_string.h:1452
Definition: fs_pdfdoc.h:389
bool operator==(const CombineDocumentInfo &other) const
Equal operator.
Definition: fs_combination.h:130
Definition: fx_basic.h:3752
bool operator!=(const CombineDocumentInfo &other) const
Not equal operator.
Definition: fs_common.h:281
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Header file for common definitions and classes.
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...
Definition: fs_basictypes.h:397
Definition: fs_combination.h:32
Foxit namespace.
Definition: fs_compare.h:27
bool IsEmpty() const
Check whether current object is empty or not.
#define NULL
The null-pointer value.
Definition: fx_system.h:767