Foxit PDF SDK
fs_pdfdoc.h
Go to the documentation of this file.
1 
15 #ifndef FS_PDFDOC_H_
16 #define FS_PDFDOC_H_
17 
18 #include "common/fs_common.h"
19 #include "common/file/fs_file.h"
20 #ifndef __EMSCRIPTEN_RENDER__
21 #include "pdf/fs_bookmark.h"
22 #include "pdf/fs_headerfooter.h"
23 #endif
24 #include "pdf/fs_pdfpage.h"
25 #ifndef __EMSCRIPTEN_RENDER__
26 #include "pdf/fs_readingbookmark.h"
27 #endif
29 
35 namespace foxit {
36 namespace fdf {
37 #ifndef __EMSCRIPTEN_RENDER__
38 class FDFDoc;
39 #endif
40 } // namespace fdf
41 namespace pdf {
42 // forward declaration
43 namespace actions {
44 class Action;
45 } // namespace actions
46 namespace interform {
47 class Form;
48 } // namespace interform;
49 class ReadingBookmark;
50 class SecurityHandler;
51 class StdEncryptData;
52 class CertificateEncryptData;
53 class DRMEncryptData;
54 class CustomEncryptData;
55 class RMSEncryptData;
56 class PagingSealSignature;
57 
59 class WrapperData FS_FINAL : public Object {
60  public:
63  : version(0) {}
64 
74  WrapperData(int version, const wchar_t* type, const wchar_t* app_id, const wchar_t* uri, const wchar_t* description)
75  : version(version)
76  , type(type)
77  , app_id(app_id)
78  , uri(uri)
80 
86  WrapperData(const WrapperData& wrapper_data)
87  : version(wrapper_data.version)
88  , type(wrapper_data.type)
89  , app_id(wrapper_data.app_id)
90  , uri(wrapper_data.uri)
91  , description(wrapper_data.description) {}
92 
100  WrapperData& operator = (const WrapperData& wrapper_data) {
101  version = wrapper_data.version;
102  type = wrapper_data.type;
103  app_id = wrapper_data.app_id;
104  uri = wrapper_data.uri;
105  description = wrapper_data.description;
106  return *this;
107  }
108 
120  void Set(int version, const wchar_t* type, const wchar_t* app_id, const wchar_t* uri, const wchar_t* description) {
121  this->version = version;
122  this->type = type;
123  this->app_id = app_id;
124  this->uri = uri;
125  this->description = description;
126  }
127 
129  int version;
138 };
139 
141 class PayLoadData FS_FINAL {
142  public:
145  : version(0.0f)
146  , file_size (0){}
147 
157  PayLoadData(float version, const wchar_t* crypto_filter, const wchar_t* file_name,
159  const wchar_t* description)
160  : version(version)
165  {}
166 
172  PayLoadData(const PayLoadData& payload_data)
173  : version(payload_data.version)
174  , crypto_filter(payload_data.crypto_filter)
175  , file_name(payload_data.file_name)
176  , file_size(payload_data.file_size)
177  , description(payload_data.description)
178  {}
179 
187  PayLoadData& operator=(const PayLoadData& payload_data) {
188  version = payload_data.version;
189  crypto_filter = payload_data.crypto_filter;
190  description = payload_data.description;
191  file_name = payload_data.file_name;
192  file_size = payload_data.file_size;
193  return *this;
194  }
195 
205  void Set(float version, const wchar_t* crypto_filter, const wchar_t* file_name,
207  const wchar_t* description) {
208  this->version = version;
209  this->crypto_filter = crypto_filter;
210  this->file_name = file_name;
211  this->file_size = file_size;
212  this->description = description;
213  }
214 
216  float version;
225 };
226 
231 class PageBasicInfo FS_FINAL : public Object {
232  public:
242  : width(width)
243  , height(height)
244  , rotation(rotation) {}
245 
248  : width(0)
249  , height(0)
250  , rotation(CommonDefines::e_RotationUnknown) {}
256  PageBasicInfo(const PageBasicInfo& page_info)
257  : width(page_info.width)
258  , height(page_info.height)
259  , rotation(page_info.rotation) {}
268  width = page_info.width;
269  height = page_info.height;
270  rotation = page_info.rotation;
271  return *this;
272  }
283  void Set(float width, float height, common::Rotation rotation) {
284  this->width = width;
285  this->height = height;
286  this->rotation = rotation;
287  }
288 
290  float width;
291 
293  float height;
299 };
300 
305 class EmbeddedFontData FS_FINAL : public Object {
306  public:
309 
318 
329  return *this;
330  }
331 
336 };
337 
339 class TableOfContentsConfig FS_FINAL : public Object{
340  public:
351  : title(title)
355 
358  : title(L"")
360  , is_show_serial_number(false)
361  , include_toc_pages(false){}
362 
365 
374  this->title = other.title;
377  this->include_toc_pages = other.include_toc_pages;
378  return *this;
379  }
380 
388  bool operator == (const TableOfContentsConfig& other) const {
389  if (this->title == other.title && this->is_show_serial_number == other.is_show_serial_number && this->include_toc_pages == other.include_toc_pages) {
391  return false;
392  for (int i = 0; i < this->bookmark_level_array.GetSize(); i++) {
393  if (this->bookmark_level_array.GetAt(i) != other.bookmark_level_array.GetAt(i))
394  return false;
395  }
396  return true;
397  }
398  return false;
399  }
400 
408  bool operator != (const TableOfContentsConfig& other) const {
409  if (this->title != other.title || this->is_show_serial_number != other.is_show_serial_number || this->include_toc_pages != other.include_toc_pages)
410  return true;
412  return true;
413  for (int i = 0; i < this->bookmark_level_array.GetSize(); i++) {
414  if (this->bookmark_level_array.GetAt(i) != other.bookmark_level_array.GetAt(i))
415  return true;
416  }
417  return false;
418  }
419 
432  this->title = title;
433  this->bookmark_level_array = bookmark_level_array;
434  this->is_show_serial_number = is_show_serial_number;
435  this->include_toc_pages = include_toc_pages;
436  }
437 
454 };
455 
509 class PDFDoc FS_FINAL : public Base {
510  public:
516  typedef enum _PasswordType {
525  } PasswordType;
526 
532  typedef enum _EncryptType {
549  } EncryptType;
550 
556  typedef enum _UserPermissions {
562  e_PermPrint = 0x0004,
569  e_PermModify = 0x0008,
575  e_PermExtract = 0x0010,
581  e_PermAnnotForm = 0x0020,
587  e_PermFillForm = 0x0100,
600  e_PermAssemble = 0x0400,
607  } UserPermissions;
608 
613  typedef enum _SaveFlags {
647  } SaveFlags;
648 
654  typedef enum _ImportPageFlags {
665  } ImportPageFlags;
666 
672  typedef enum _ExtractPagesOptions {
689 
695  typedef enum _InsertDocOptions {
699 
705  typedef enum _DisplayMode {
721  } DisplayMode;
722 
729  typedef enum _DataType {
731  e_Forms = 0x0001,
733  e_Annots = 0x0002,
735  e_Links = 0x0004
736  } DataType;
737 
743  typedef enum _WrapperType {
750  } WrapperType;
751 
752 
759  PDFDoc();
760 
769  explicit PDFDoc(const char* path);
770 
779  explicit PDFDoc(const wchar_t* path);
780 
791  explicit PDFDoc(const void* buffer, size_t size);
792 
807  explicit PDFDoc(common::file::ReaderCallback* file_read, bool is_async = false);
808  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
809  explicit PDFDoc(FS_HANDLE handle);
811  ~PDFDoc();
812 
818  PDFDoc(const PDFDoc& other);
819 
827  PDFDoc& operator = (const PDFDoc& other);
835  bool operator == (const PDFDoc& other) const;
836 
844  bool operator != (const PDFDoc& other) const;
845 
853  bool IsEmpty() const;
854 
861 
881  bool IsLinearized() const;
882 
889  bool IsTaggedPDF() const;
890 
912  ErrorCode Load(const String& password = "");
913 
936  ErrorCode LoadW(const WString& password = WString());
937 
969  common::Progressive StartLoad(const String& password = "", bool is_cache_stream = true,
970  common::PauseCallback* pause = NULL);
1002  common::Progressive StartLoadW(const WString& password = WString(), bool is_cache_stream = true,
1003  common::PauseCallback* pause = NULL);
1004 
1014  int GetFirstAvailPageIndex() const;
1015 
1026  bool IsXFA() const;
1027 
1034  bool IsEncrypted() const;
1035 
1041  void ClearRenderCache();
1042 
1056  PasswordType GetPasswordType() const;
1057 
1065 
1080  PasswordType CheckPassword(const String& password);
1081 
1096  PasswordType CheckPassword(const foxit::WString& password);
1097 
1106  bool IsUserPassword(const String& password);
1107 
1116  bool IsUserPassword(const foxit::WString& password);
1117 
1126  bool IsOwnerPassword(const String& password);
1127 
1136  bool IsOwnerPassword(const foxit::WString& password);
1137 
1147  String GetUserPassword(const String& owner_password);
1148 #ifndef __EMSCRIPTEN_RENDER__
1149 
1157 
1166 
1175 
1184 
1197 #endif
1198 
1224  bool SaveAs(const char* file_path, uint32 save_flags = PDFDoc::e_SaveFlagNormal);
1225 
1252  bool SaveAs(const wchar_t* file_path, uint32 save_flags = PDFDoc::e_SaveFlagNormal);
1253 
1287  common::Progressive StartSaveAs(const char* file_path,
1288  uint32 save_flags = PDFDoc::e_SaveFlagNormal,
1289  common::PauseCallback* pause = NULL);
1290 
1324  common::Progressive StartSaveAs(const wchar_t* file_path,
1325  uint32 save_flags = PDFDoc::e_SaveFlagNormal,
1326  common::PauseCallback* pause = NULL);
1327 
1364 #ifndef __EMSCRIPTEN_RENDER__
1365 
1373 
1383 
1390  int GetBookmarkLevelDepth();
1391 
1399  bool RemoveBookmark(const Bookmark& bookmark);
1400 
1407  bool HasLayer() const;
1408 
1415  bool HasHeaderFooter();
1416 
1426 
1437  void AddHeaderFooter(const HeaderFooter& headerfooter);
1438 
1449  void UpdateHeaderFooter(const HeaderFooter& headerfooter);
1450 
1456  bool RemoveAllHeaderFooters();
1457 #endif
1458 
1463  int GetPageCount() const;
1464 
1478  PDFPage GetPage(int index);
1479 
1488  DisplayMode GetDisplayMode() const;
1489 
1500  void SetDisplayMode(DisplayMode display_mode);
1501 
1509 
1517 
1527 
1535 
1543 
1552 
1570 
1578  void DeleteIndirectObject(uint32 object_number);
1579 
1586  uint32 GetUserPermissions() const;
1587 
1594  bool IsWrapper() const;
1595 
1602  WrapperType GetWrapperType() const;
1603 
1610  WrapperData GetWrapperData() const;
1611 
1618  int64 GetWrapperOffset() const;
1619 
1627 
1645 
1671  bool SaveAsWrapperFile(const wchar_t* file_path, const WrapperData* wrapper_data = NULL,
1672  uint32 user_permissions = 0xFFFFFFFC, const char* owner_password = "");
1673 
1701  common::Progressive StartSaveAsPayloadFile(const wchar_t* file_path, const wchar_t* payload_file_path,
1702  const wchar_t* crypto_filter, const wchar_t* description, float version,
1703  uint32 save_flags = PDFDoc::e_SaveFlagNormal,
1704  common::PauseCallback* pause = NULL);
1716  bool HasForm() const;
1717 
1724 #ifndef __EMSCRIPTEN_RENDER__
1725 
1734 
1748  ReadingBookmark InsertReadingBookmark(int reading_bookmark_index, const WString& title, int dest_page_index);
1749 
1757  bool RemoveReadingBookmark(const ReadingBookmark& reading_bookmark);
1758 
1764  int GetSignatureCount();
1765 
1775 
1785  void RemoveSignature(const foxit::pdf::Signature& signature);
1786 #endif
1787 
1799  PDFPage InsertPage(int index, float width, float height);
1813 
1832  PDFPage AddPageFromTemplate(const wchar_t* template_name);
1833 
1849  bool HidePageTemplate(const wchar_t* template_name);
1850 
1859  bool RemovePage(int index);
1870  bool RemovePage(const foxit::pdf::PDFPage& page);
1871 
1887  bool MovePageTo(const PDFPage& page, int dest_index);
1888 
1909  bool MovePagesTo(const common::Range& page_range, int dest_index);
1910 
1964  const wchar_t* src_file_path, const String& password,
1965  uint32 flags = PDFDoc::e_ImportFlagNormal, const char* layer_name = "",
1966  const common::Range& page_range = common::Range(),
1967  common::PauseCallback* pause = NULL);
2020  const wchar_t* src_file_path, const WString& password,
2021  uint32 flags = PDFDoc::e_ImportFlagNormal, const char* layer_name = "",
2022  const common::Range& page_range = common::Range(),
2023  common::PauseCallback* pause = NULL);
2073  common::Progressive StartImportPages(int dest_index, const PDFDoc& src_doc,
2074  uint32 flags = PDFDoc::e_ImportFlagNormal, const char* layer_name = "",
2075  const common::Range& page_range = common::Range(),
2076  common::PauseCallback* pause = NULL);
2077 
2100  common::Progressive StartExtractPages(const char* file_path, uint32 options, const common::Range& page_range = common::Range(),
2101  common::PauseCallback* pause = NULL);
2102 
2125  common::Progressive StartExtractPages(const wchar_t* file_path, uint32 options, const common::Range& page_range = common::Range(),
2126  common::PauseCallback* pause = NULL);
2127 
2153 
2170  void InsertDocument(int dest_index, const PDFDoc& src_doc, uint32 options);
2171 
2172 #ifndef __EMSCRIPTEN_RENDER__
2173 
2196  bool ImportFromFDF(const fdf::FDFDoc& fdf_doc, int types = pdf::PDFDoc::e_Forms | pdf::PDFDoc::e_Annots, const common::Range& page_range = common::Range());
2197 
2217  bool ExportToFDF(const fdf::FDFDoc& fdf_doc, int types = pdf::PDFDoc::e_Forms | pdf::PDFDoc::e_Annots, const common::Range& page_range = common::Range());
2218 
2227  bool ExportAnnotToFDF(const annots::Annot& pdf_annot,const fdf::FDFDoc& fdf_doc);
2228 
2241  bool ExportFormFieldsToFDF(const pdf::interform::FieldArray& field_array, bool is_include, const fdf::FDFDoc& fdf_doc);
2242 #endif
2243 
2248  String GetHeader() const;
2249 
2255  int GetFileVersion();
2256 
2272  void SetFileVersion(int version);
2273 
2286  bool SetSecurityHandler(const SecurityHandler& handler);
2287 
2298 
2308  bool RemoveSecurity();
2309 
2317  int GetFontCount();
2318 
2327  common::Font GetFont(int index);
2328 
2335 
2347  bool SetOpenAction(actions::Action& action);
2348 
2354  bool RemoveOpenAction();
2355 
2361  bool DoJSOpenAction();
2362 
2368  bool IsPortfolio();
2369 
2384  PageBasicInfo GetPageBasicInfo(int index);
2385 
2392 
2393 #ifdef _SUPPORTWEBSDK_
2394  objects::PDFStream* CreateIcon(String imgStream,int width, int height);
2395 #endif
2396 
2403  void CreateDSS();
2404 
2420  void AddTableOfContents(const wchar_t* title, Int32Array bookmark_level_array);
2421 
2431  void AddTableOfContents(const TableOfContentsConfig& table_of_contents_config);
2432 
2449  void SetCacheFile(foxit::common::file::StreamCallback* file_stream, bool is_own_file_stream);
2450 
2467 
2476  WString GetPageText(int page_index) const;
2477 
2493  PagingSealSignature AddPagingSealSignature(const common::Range& page_range, float width, float height);
2494 
2514 };
2515 } // namespace pdf
2516 } // namespace foxit
2517 #endif // FS_PDFDOC_H_
2518 
bool include_toc_pages
true means to include catalog page(s) in the calculation of pages number in the table of contents,...
Definition: fs_pdfdoc.h:453
PageBasicInfo GetPageBasicInfo(int index)
Get the basic information of a page specified by index.
ImportPageFlags
Enumeration for flags used for importing pages.
Definition: fs_pdfdoc.h:654
common::Progressive StartRecognizeForm(common::PauseCallback *pause=0)
Start to recognize form in current PDF document.
bool SaveAsWrapperFile(const wchar_t *file_path, const WrapperData *wrapper_data=0, uint32 user_permissions=0xFFFFFFFC, const char *owner_password="")
Save current PDF document as a wrapper file.
Bookmark GetRootBookmark()
Get bookmark root node.
Operate text annotations and fill in interactive form fields. (Bit 6 in permission value)
Definition: fs_pdfdoc.h:581
Definition: fs_pdfobject.h:422
int version
Wrapper version.
Definition: fs_pdfdoc.h:129
If set, form fields are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:731
~PDFDoc()
Destructor.
int GetReadingBookmarkCount()
Get the count of reading bookmarks.
bool RemoveBookmark(const Bookmark &bookmark)
Remove a specified bookmark.
WStringArray standard_font_name_array
Font name array of embedded fonts which are standard fonts and can be replaced by system fonts if the...
Definition: fs_pdfdoc.h:335
void Set(float version, const wchar_t *crypto_filter, const wchar_t *file_name, int64 file_size, const wchar_t *description)
Set value.
Definition: fs_pdfdoc.h:205
If set, annotations (except link annotations) are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:733
Bookmark CreateRootBookmark()
Create new bookmark root node.
bool SetSecurityHandler(const SecurityHandler &handler)
Set a PDF security handler for encryption, such as standard encryption(password), certificate encrypt...
common::Progressive StartSaveAs(const char *file_path, uint32 save_flags=PDFDoc::e_SaveFlagNormal, common::PauseCallback *pause=0)
Start to save current PDF document as another PDF file.
bool operator==(const PDFDoc &other) const
Equal operator.
Definition: fs_common.h:1189
File writing interface.
Definition: fx_stream.h:451
int GetFirstAvailPageIndex() const
Get the page index of the fist available page.
void ClearRenderCache()
Clear the cache used during rendering, to reduce the memory usage.
bool HasForm() const
Check whether current PDF document has interactive form (also known as AcroForm).
StdEncryptData GetStdEncryptData() const
Get encrypt data of standard encryption (known as password encryption).
TableOfContentsConfig(const wchar_t *title, Int32Array bookmark_level_array, bool is_show_serial_number, bool include_toc_pages)
Constructor, with parameter.
Definition: fs_pdfdoc.h:350
ErrorCode Load(const String &password="")
Load current document content by using a specified password.
bool is_show_serial_number
true means to show the serial number in the table of contents, while false means not to show the seri...
Definition: fs_pdfdoc.h:448
RMSEncryptData GetRMSEncryptData() const
Get encrypt data of RMS encryption.
common::Progressive StartSaveAsPayloadFile(const wchar_t *file_path, const wchar_t *payload_file_path, const wchar_t *crypto_filter, const wchar_t *description, float version, uint32 save_flags=PDFDoc::e_SaveFlagNormal, common::PauseCallback *pause=0)
Start to save current PDF document as a wrapper document with a payload document (defined in PDF 2....
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
Save document normally, without using any special flag. This can only be used alone.
Definition: fs_pdfdoc.h:615
Extract PDF contents. (Bit 5 in permission value)
Definition: fs_pdfdoc.h:575
bool HidePageTemplate(const wchar_t *template_name)
Hide a named page.
float version
The version number of the cryptographic filter used to encrypt the encrypted payload referenced by th...
Definition: fs_pdfdoc.h:216
Assemble PDF document. (Bit 11 in permission value)
Definition: fs_pdfdoc.h:600
Unknown rotation.
Definition: fs_common.h:67
Encryption type: password, which is the standard encryption.
Definition: fs_pdfdoc.h:538
Header file for header-footer related definitions and classes.
bool operator==(const TableOfContentsConfig &other) const
Equal operator.
Definition: fs_pdfdoc.h:388
bool ExportAnnotToFDF(const annots::Annot &pdf_annot, const fdf::FDFDoc &fdf_doc)
Export specified annotation to a FDF/XFDF document.
PayLoadData(const PayLoadData &payload_data)
Constructor, with another payload data object.
Definition: fs_pdfdoc.h:172
objects::PDFDictionary * GetTrailer() const
Get the trailer dictionary.
WrapperType
Enumeration for wrapper type.
Definition: fs_pdfdoc.h:743
Modify PDF contents. (Bit 4 in permission value)
Definition: fs_pdfdoc.h:569
SecurityHandler GetSecurityHandler()
Get current PDF security handler of current document.
Int32Array bookmark_level_array
A bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents"....
Definition: fs_pdfdoc.h:446
Definition: fs_basictypes.h:224
bool SetOpenAction(actions::Action &action)
Set the action to be performed when the document is opened.
Definition: fs_pdfdoc.h:305
A user password is used in PDF document.
Definition: fs_pdfdoc.h:522
WString description
Description for payload file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:224
bool ImportFromFDF(const fdf::FDFDoc &fdf_doc, int types=pdf::PDFDoc::e_Forms|pdf::PDFDoc::e_Annots, const common::Range &page_range=common::Range())
Import form fields and annotations from a FDF/XFDF document.
PageBasicInfo()
Constructor.
Definition: fs_pdfdoc.h:247
common::Progressive StartLoad(const String &password="", bool is_cache_stream=true, common::PauseCallback *pause=0)
Start to loading current document content by using a specified password.
int64 GetWrapperOffset() const
Get wrapper offset if current document's wrapper type is PDFDoc::e_WrapperFoxit.
common::Progressive StartImportPages(int dest_index, const PDFDoc &src_doc, uint32 flags=PDFDoc::e_ImportFlagNormal, const char *layer_name="", const common::Range &page_range=common::Range(), common::PauseCallback *pause=0)
Start to import pages from another PDF document (via PDF document object).
bool MovePagesTo(const common::Range &page_range, int dest_index)
Move one or more pages (specified by index) to a new index position.
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
WString crypto_filter
The name of the cryptographic filter used to encrypt the encrypted payload document.
Definition: fs_pdfdoc.h:218
Header file for file operation related definitions and functions.
bool operator !=(const TableOfContentsConfig &other) const
Not equal operator.
Definition: fs_pdfdoc.h:408
File reading interface.
Definition: fx_stream.h:566
void UpdateHeaderFooter(const HeaderFooter &headerfooter)
Update header-footer.
Import pages with layers.
Definition: fs_pdfdoc.h:658
If set, that means structure tree will be extracted as well.
Definition: fs_pdfdoc.h:676
objects::PDFDictionary * GetCatalog() const
Get the catalog dictionary.
Encryption type: customized encryption.
Definition: fs_pdfdoc.h:544
WIDE STRING CLASS.
Definition: fx_string.h:1452
bool IsLinearized() const
Check if current PDF document is a linearized file.
WString description
Description for wrapper file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:137
Save document without original data or unchanged objects.
Definition: fs_pdfdoc.h:629
Save document incrementally.
Definition: fs_pdfdoc.h:622
bool IsWrapper() const
Check whether current document is a wrapper file or not.
CFX_WideString WString
Wide string.
Definition: fs_basictypes.h:219
void SetFileVersion(int version)
Set the PDF file version which will be stored in PDF header section of the saved PDF file.
bool ExportFormFieldsToFDF(const pdf::interform::FieldArray &field_array, bool is_include, const fdf::FDFDoc &fdf_doc)
Export specified form fields to a FDF/XFDF document.
int GetFileVersion()
Get PDF file version stored in PDF header section.
float height
Page height (unit is 1/72 inch).
Definition: fs_pdfdoc.h:293
No password is used in PDF document.
Definition: fs_pdfdoc.h:520
PasswordType CheckPassword(const String &password)
Check the type of a specified password.
PasswordType GetPasswordType() const
Get the type of current used password.
FX_UINT64 uint64
Unsigned 64-bit integer.
Definition: fs_basictypes.h:192
uint32 GetUserPermissions() const
Get user access permissions.
HeaderFooter GetEditableHeaderFooter()
Get the editable header footer object.
If set, that means attachment files will be extracted as well.
Definition: fs_pdfdoc.h:687
Print PDF document with higher qualities. (Bit 12 in permission value)
Definition: fs_pdfdoc.h:606
Definition: fs_pdfdoc.h:141
Definition: fs_pdfdoc.h:509
Normal document.
Definition: fs_pdfdoc.h:745
Definition: fs_security.h:586
PayLoadData & operator=(const PayLoadData &payload_data)
Assign operator.
Definition: fs_pdfdoc.h:187
ReadingBookmark InsertReadingBookmark(int reading_bookmark_index, const WString &title, int dest_page_index)
Insert a reading bookmark to current PDF document.
int GetBookmarkLevelDepth()
Get bookmark level depth.
bool IsEmpty() const
Check whether current object is empty or not.
~TableOfContentsConfig()
Destructor.
Definition: fs_pdfdoc.h:364
bool RemoveAllHeaderFooters()
Remove all header-footers.
int64 file_size
The payload file size.
Definition: fs_pdfdoc.h:222
(Reserved, not supported yet) If set, only link annotations are to imported from or exported to XFDF ...
Definition: fs_pdfdoc.h:735
bool ExportToFDF(const fdf::FDFDoc &fdf_doc, int types=pdf::PDFDoc::e_Forms|pdf::PDFDoc::e_Annots, const common::Range &page_range=common::Range())
Export form fields and annotations to a FDF/XFDF document.
bool IsOwnerPassword(const String &password)
Check if input password is the owner password of current PDF document.
An owner password is used in PDF document.
Definition: fs_pdfdoc.h:524
ExtractPagesOptions
Enumeration for options used for extracting pages.
Definition: fs_pdfdoc.h:672
Header file for bookmark related definitions and classes.
PDFDoc()
Constructor.
Definition: fs_fdfdoc.h:51
objects::PDFDictionary * GetPagesDict() const
Get the dictionary of "Pages".
PagingSealSignature AddPagingSealSignature(const common::Range &page_range, float width, float height)
Add a paging seal signature to document by page range.
Definition: fs_security.h:973
EmbeddedFontData(const EmbeddedFontData &other)
Constructor, with another embedded font data object.
Definition: fs_pdfdoc.h:315
Definition: fs_security.h:137
Import pages without cloning stream objects into memory.
Definition: fs_pdfdoc.h:664
common::Progressive StartGetPayloadFile(foxit::common::file::WriterCallback *payload_file, common::PauseCallback *pause=0)
Start to get payload file.
Header file for reading bookmark related definitions and classes.
bool DoJSOpenAction()
Perform JavaScript actions when the document is opened.
If set, that means OCProperties will be extracted as well.
Definition: fs_pdfdoc.h:680
int GetSignatureCount()
Get the count of signature.
uint64 GetFileSize()
Get file size.
WStringArray nonstandard_font_name_array
Font name array of embedded fonts which cannot be replaced by system fonts if they are to be unembede...
Definition: fs_pdfdoc.h:333
Definition: fs_signature.h:1953
Definition: fs_pdfdoc.h:231
SaveFlags
Enumeration for PDF document saving flags.
Definition: fs_pdfdoc.h:613
ErrorCode LoadW(const WString &password=WString())
Load current document content by using a specified password.
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:233
PageBasicInfo(float width, float height, common::Rotation rotation)
Constructor, with parameters.
Definition: fs_pdfdoc.h:241
WString type
Wrapper type to indicate a type of the current wrapper file.
Definition: fs_pdfdoc.h:131
EmbeddedFontData & operator=(const EmbeddedFontData &other)
Assign operator.
Definition: fs_pdfdoc.h:326
EmbeddedFontData()
Constructor.
Definition: fs_pdfdoc.h:308
int GetFontCount()
Count all the PDF fonts used in current PDF document.
Import pages normally.
Definition: fs_pdfdoc.h:656
Definition: fs_pdfdoc.h:59
File stream interface, reading & writing.
Definition: fx_stream.h:669
bool RemoveOpenAction()
Remove the action to be performed when the document is opened.
When document is opened, neither document outlines nor thumbnail images are visible.
Definition: fs_pdfdoc.h:707
DisplayMode
Enumeration for display mode which specifies how the document should be displayed when opened.
Definition: fs_pdfdoc.h:705
bool IsUserPassword(const String &password)
Check if input password is the user password of current PDF document.
float width
Page width (unit is 1/72 inch).
Definition: fs_pdfdoc.h:290
void Set(const wchar_t *title, Int32Array bookmark_level_array, bool is_show_serial_number, bool include_toc_pages)
Set value.
Definition: fs_pdfdoc.h:431
EncryptType GetEncryptionType() const
Get the encryption type.
bool HasLayer() const
Check whether current PDF document has layer (known as "Optional content group" in <PDF reference 1....
objects::PDFDictionary * GetEncryptDict() const
Get the encrypt dictionary.
common::Progressive StartEmbedAllFonts(common::PauseCallback *pause=0)
Start to convert all un-embeded fonts to embeded fonts.
WString GetPageText(int page_index) const
Get the specified PDF page text which the text is in display order.
Size
Enumeration for page size type.
Definition: fs_pdfpage.h:489
WString file_name
The payload file name.
Definition: fs_pdfdoc.h:220
Definition: fx_basic.h:3761
objects::PDFDictionary * GetInfo() const
Get the information dictionary.
bool IsXFA() const
Check whether current PDF document is an XFA document.
When document is opened, full-screen mode, with no menu bar, window controls, or any other windows ar...
Definition: fs_pdfdoc.h:716
Print PDF document with normal mode. (Bit 3 in permission value)
Definition: fs_pdfdoc.h:562
(Reserved, currently, this value is not used.) Encryption type: Foxit connected PDF DRM encryption.
Definition: fs_pdfdoc.h:548
Save document as a linearized file.
Definition: fs_pdfdoc.h:640
When document is opened, document outlines (bookmarks) are visible.
Definition: fs_pdfdoc.h:709
bool IsPortfolio()
Check whether current PDF document is a portfolio file or not.
PasswordType
Enumeration for the type of current used password in a PDF document.
Definition: fs_pdfdoc.h:516
When document is opened, optional content group panels are visible.
Definition: fs_pdfdoc.h:718
Definition: fs_common.h:342
PDFPage AddPageFromTemplate(const wchar_t *template_name)
Adds a new PDF page to document, from a named template.
FX_INT64 int64
Signed 64-bit integer.
Definition: fs_basictypes.h:190
const TYPE GetAt(int nIndex) const
This method retrieves an element specified by an index number.
Definition: fx_basic.h:1396
CustomEncryptData GetCustomEncryptData() const
Get encrypt data of custom encryption.
If set, that means annotations related to extracted pages will be extracted as well.
Definition: fs_pdfdoc.h:674
InsertDocOptions
Enumeration for options used for inserting a PDF document to another.
Definition: fs_pdfdoc.h:695
Disabilities support. (Bit 10 in permission value)
Definition: fs_pdfdoc.h:593
DataType
Enumeration for data type used to decide which object(s) will be imported from or exported to FDF/XFD...
Definition: fs_pdfdoc.h:729
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
void SetDisplayMode(DisplayMode display_mode)
Set the display mode.
Save document with removing redundant PDF objects.
Definition: fs_pdfdoc.h:646
Definition: fs_pdfpage.h:411
bool RemoveReadingBookmark(const ReadingBookmark &reading_bookmark)
Remove a reading bookmark from current PDF document.
Encryption type: digital certificate encryption.
Definition: fs_pdfdoc.h:540
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
WrapperType GetWrapperType() const
Get Wrapper type.
EmbeddedFontData GetEmbeddedFontData()
Get embedded font data.
Header file for common definitions and classes.
When document is opened, attachment panels are visible.
Definition: fs_pdfdoc.h:720
ReadingBookmark GetReadingBookmark(int index)
Get a reading bookmark by index.
No encryption pattern.
Definition: fs_pdfdoc.h:536
void Set(int version, const wchar_t *type, const wchar_t *app_id, const wchar_t *uri, const wchar_t *description)
Set value.
Definition: fs_pdfdoc.h:120
The password is invalid.
Definition: fs_pdfdoc.h:518
PDFDoc & operator=(const PDFDoc &other)
Assign operator.
void DeleteIndirectObject(uint32 object_number)
Delete an indirect object by indirect object number.
Definition: fs_security.h:833
bool operator !=(const PDFDoc &other) const
Not equal operator.
objects::PDFObject * GetIndirectObject(uint32 object_number)
Get an indirect object by indirect object number.
WString uri
The URI for consumers to get more information.
Definition: fs_pdfdoc.h:135
Header file for PDF object related definitions and classes.
Encryption type: Microsoft RMS encryption.
Definition: fs_pdfdoc.h:546
Definition: fs_basictypes.h:413
If set, that means attachments will be inserted to target document as well.
Definition: fs_pdfdoc.h:697
DisplayMode GetDisplayMode() const
Get the display mode.
String GetHeader() const
Get PDF header identifying the version of the PDF specification to which the file conforms.
common::Font GetFont(int index)
Get a font by index.
Fill PDF form. (Bit 9 in permission value)
Definition: fs_pdfdoc.h:587
int GetPageCount() const
Get the count of pages.
Header file for PDF page related definitions and classes.
PDFPage GetPage(int index)
Get a PDF page by index.
bool RemoveSecurity()
Remove the security handler from current document, so that the later saved document will be unencrypt...
CertificateEncryptData GetCertificateEncryptData() const
Get encrypt data of certificate encryption.
WrapperData(int version, const wchar_t *type, const wchar_t *app_id, const wchar_t *uri, const wchar_t *description)
Constructor, with parameters.
Definition: fs_pdfdoc.h:74
Definition: fs_annot.h:964
PDFPage InsertPage(int index, float width, float height)
Insert a new blank PDF page to document, by index.
Save document by using XRef stream.
Definition: fs_pdfdoc.h:634
Definition: fs_security.h:56
Definition: fs_common.h:1344
Definition: fs_pdfobject.h:809
bool IsEncrypted() const
Check whether current document is an encrypted file or not.
String GetUserPassword(const String &owner_password)
Get the user password based on owner password.
If set, that means to use PDFDoc::e_SaveFlagXRefStream saving flag for the result file in order to re...
Definition: fs_pdfdoc.h:685
actions::Action GetOpenAction()
Get the action to be performed when the document is opened.
PayLoadData(float version, const wchar_t *crypto_filter, const wchar_t *file_name, foxit::int64 file_size, const wchar_t *description)
Constructor, with parameters.
Definition: fs_pdfdoc.h:157
bool SaveAs(const char *file_path, uint32 save_flags=PDFDoc::e_SaveFlagNormal)
Save current PDF document as another PDF file.
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Foxit namespace.
Definition: fs_taggedpdf.h:27
Definition: fs_pdfobject.h:55
WrapperData & operator=(const WrapperData &wrapper_data)
Assign operator.
Definition: fs_pdfdoc.h:100
DRMEncryptData GetDRMEncryptData() const
Get encrypt data of Foxit DRM encryption.
Definition: fs_action.h:418
WString app_id
Application identity to indicate applications to open this wrapper data.
Definition: fs_pdfdoc.h:133
common::Progressive StartLoadW(const WString &password=WString(), bool is_cache_stream=true, common::PauseCallback *pause=0)
Start to loading current document content by using a specified password.
If set, that means Javascript will be extracted as well.
Definition: fs_pdfdoc.h:678
BYTE STRING CLASS.
Definition: fx_string.h:317
Unknown encryption type.
Definition: fs_pdfdoc.h:534
EncryptType
Enumeration for encryption type.
Definition: fs_pdfdoc.h:532
void CreateDSS()
Create DSS information in current PDF document.
common::Progressive StartExtractPages(const char *file_path, uint32 options, const common::Range &page_range=common::Range(), common::PauseCallback *pause=0)
Start to extract pages from current PDF document.
bool IsTaggedPDF() const
Check if current PDF document is a Tagged PDF file.
PDF 2.0 wrapper document.
Definition: fs_pdfdoc.h:749
Definition: fs_pdfform.h:44
common::Rotation rotation
Page rotation. Please refer to values starting from common::e_Rotation0 and this should be one of the...
Definition: fs_pdfdoc.h:298
TableOfContentsConfig & operator=(const TableOfContentsConfig &other)
Assign operator.
Definition: fs_pdfdoc.h:373
When document is opened, thumbnail images are visible.
Definition: fs_pdfdoc.h:711
void InsertDocument(int dest_index, const PDFDoc &src_doc, uint32 options)
Insert another PDF document to the specified location of current PDF document.
TableOfContentsConfig()
Constructor.
Definition: fs_pdfdoc.h:357
#define NULL
The null-pointer value.
Definition: fx_system.h:780
Definition: fs_signature.h:97
Page size: letter.
Definition: fs_pdfpage.h:491
void RemoveSignature(const foxit::pdf::Signature &signature)
Remove a signature.
WString title
Title for the table of contents. If this is an empty string, the default value "Table of Contents" wi...
Definition: fs_pdfdoc.h:439
PayLoadData()
Constructor.
Definition: fs_pdfdoc.h:144
Encryption type: Foxit DRM encryption.
Definition: fs_pdfdoc.h:542
common::Progressive StartImportPagesFromFilePath(int dest_index, const wchar_t *src_file_path, const String &password, uint32 flags=PDFDoc::e_ImportFlagNormal, const char *layer_name="", const common::Range &page_range=common::Range(), common::PauseCallback *pause=0)
Start to import pages from another PDF document (via file path).
WrapperData GetWrapperData() const
Get wrapper data if current document's wrapper type is PDFDoc::e_WrapperFoxit.
PageBasicInfo & operator=(const PageBasicInfo &page_info)
Assign operator.
Definition: fs_pdfdoc.h:267
PageBasicInfo(const PageBasicInfo &page_info)
Constructor, with another page basic information object.
Definition: fs_pdfdoc.h:256
void AddHeaderFooter(const HeaderFooter &headerfooter)
Add new header-footer.
foxit::pdf::Signature GetSignature(int index)
Get a signature by index.
Definition: fs_security.h:368
void AddTableOfContents(const wchar_t *title, Int32Array bookmark_level_array)
Insert page(s) as the table of contents to the front of current PDF document.
Definition: fs_pdfdoc.h:339
bool RemovePage(int index)
Remove a PDF page by page index.
void SetCacheFile(foxit::common::file::StreamCallback *file_stream, bool is_own_file_stream)
Set cache file (represented by a file stream) to current PDF document.
WrapperData()
Constructor.
Definition: fs_pdfdoc.h:62
Definition: fs_bookmark.h:58
bool HasHeaderFooter()
Check whether current document has header-footer.
void Set(float width, float height, common::Rotation rotation)
Set value.
Definition: fs_pdfdoc.h:283
Definition: fs_readingbookmark.h:43
UserPermissions
Enumeration for user access permissions in a PDF document.
Definition: fs_pdfdoc.h:556
WrapperData(const WrapperData &wrapper_data)
Constructor, with another wrapper data object.
Definition: fs_pdfdoc.h:86
Foxit wrapper document.
Definition: fs_pdfdoc.h:747
PayLoadData GetPayLoadData()
Get payload data if current document's wrapper type is PDFDoc::e_WrapperPDFV2.
uint32 AddIndirectObject(objects::PDFObject *pdf_object)
Add a PDF object to current PDF document, to be an indirect object.
bool MovePageTo(const PDFPage &page, int dest_index)
Move a specified page to a new index position.