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 class WatermarkTextProperties;
59 class TiledWatermarkSettings FS_FINAL : public Object{
60  public:
74  explicit TiledWatermarkSettings(float row_space, float col_space, float rotation, int opacity ,int scale)
78  , opacity(opacity)
79  , scale(scale) {}
80 
89  : row_space(2.0)
90  , col_space(2.0)
91  , rotation(0)
92  , opacity(100)
93  , scale(100) {}
94 
101  : row_space(settings.row_space)
102  , col_space(settings.col_space)
103  , rotation(settings.rotation)
104  , opacity(settings.opacity)
105  , scale(settings.scale) {}
106 
115  row_space = settings.row_space;
116  col_space = settings.col_space;
117  rotation = settings.rotation;
118  opacity = settings.opacity;
119  scale = settings.scale;
120  return *this;
121  }
122 
137  void Set(float row_space, float col_space, float rotation, int opacity, int scale) {
138  this->row_space = row_space;
139  this->col_space = col_space;
140  this->rotation = rotation;
141  this->opacity = opacity;
142  this->scale = scale;
143  }
144 
146  float row_space;
148  float col_space;
150  float rotation;
155  int opacity;
160  int scale;
161 };
163 class WrapperData FS_FINAL : public Object {
164  public:
167  : version(0) {}
168 
178  WrapperData(int version, const wchar_t* type, const wchar_t* app_id, const wchar_t* uri, const wchar_t* description)
179  : version(version)
180  , type(type)
181  , app_id(app_id)
182  , uri(uri)
184 
190  WrapperData(const WrapperData& wrapper_data)
191  : version(wrapper_data.version)
192  , type(wrapper_data.type)
193  , app_id(wrapper_data.app_id)
194  , uri(wrapper_data.uri)
195  , description(wrapper_data.description) {}
196 
204  WrapperData& operator = (const WrapperData& wrapper_data) {
205  version = wrapper_data.version;
206  type = wrapper_data.type;
207  app_id = wrapper_data.app_id;
208  uri = wrapper_data.uri;
209  description = wrapper_data.description;
210  return *this;
211  }
212 
224  void Set(int version, const wchar_t* type, const wchar_t* app_id, const wchar_t* uri, const wchar_t* description) {
225  this->version = version;
226  this->type = type;
227  this->app_id = app_id;
228  this->uri = uri;
229  this->description = description;
230  }
231 
233  int version;
242 };
243 
245 class PayLoadData FS_FINAL {
246  public:
249  : version(0.0f)
250  , file_size (0){}
251 
261  PayLoadData(float version, const wchar_t* crypto_filter, const wchar_t* file_name,
263  const wchar_t* description)
264  : version(version)
269  {}
270 
276  PayLoadData(const PayLoadData& payload_data)
277  : version(payload_data.version)
278  , crypto_filter(payload_data.crypto_filter)
279  , file_name(payload_data.file_name)
280  , file_size(payload_data.file_size)
281  , description(payload_data.description)
282  {}
283 
291  PayLoadData& operator=(const PayLoadData& payload_data) {
292  version = payload_data.version;
293  crypto_filter = payload_data.crypto_filter;
294  description = payload_data.description;
295  file_name = payload_data.file_name;
296  file_size = payload_data.file_size;
297  return *this;
298  }
299 
309  void Set(float version, const wchar_t* crypto_filter, const wchar_t* file_name,
311  const wchar_t* description) {
312  this->version = version;
313  this->crypto_filter = crypto_filter;
314  this->file_name = file_name;
315  this->file_size = file_size;
316  this->description = description;
317  }
318 
320  float version;
329 };
330 
335 class PageBasicInfo FS_FINAL : public Object {
336  public:
346  : width(width)
347  , height(height)
348  , rotation(rotation) {}
349 
352  : width(0)
353  , height(0)
354  , rotation(CommonDefines::e_RotationUnknown) {}
360  PageBasicInfo(const PageBasicInfo& page_info)
361  : width(page_info.width)
362  , height(page_info.height)
363  , rotation(page_info.rotation) {}
372  width = page_info.width;
373  height = page_info.height;
374  rotation = page_info.rotation;
375  return *this;
376  }
387  void Set(float width, float height, common::Rotation rotation) {
388  this->width = width;
389  this->height = height;
390  this->rotation = rotation;
391  }
392 
394  float width;
395 
397  float height;
403 };
404 
409 class EmbeddedFontData FS_FINAL : public Object {
410  public:
413 
422 
433  return *this;
434  }
435 
440 };
441 
443 class TableOfContentsConfig FS_FINAL : public Object{
444  public:
455  : title(title)
459 
462  : title(L"")
464  , is_show_serial_number(false)
465  , include_toc_pages(false){}
466 
475  this->title = other.title;
478  this->include_toc_pages = other.include_toc_pages;
479  return *this;
480  }
481 
489  bool operator == (const TableOfContentsConfig& other) const {
490  if (this->title == other.title && this->is_show_serial_number == other.is_show_serial_number && this->include_toc_pages == other.include_toc_pages) {
492  return false;
493  for (int i = 0; i < this->bookmark_level_array.GetSize(); i++) {
494  if (this->bookmark_level_array.GetAt(i) != other.bookmark_level_array.GetAt(i))
495  return false;
496  }
497  return true;
498  }
499  return false;
500  }
501 
509  bool operator != (const TableOfContentsConfig& other) const {
510  if (this->title != other.title || this->is_show_serial_number != other.is_show_serial_number || this->include_toc_pages != other.include_toc_pages)
511  return true;
513  return true;
514  for (int i = 0; i < this->bookmark_level_array.GetSize(); i++) {
515  if (this->bookmark_level_array.GetAt(i) != other.bookmark_level_array.GetAt(i))
516  return true;
517  }
518  return false;
519  }
520 
533  this->title = title;
534  this->bookmark_level_array = bookmark_level_array;
535  this->is_show_serial_number = is_show_serial_number;
536  this->include_toc_pages = include_toc_pages;
537  }
538 
555 };
556 
610 class PDFDoc FS_FINAL : public Base {
611  public:
617  typedef enum _PasswordType {
626  } PasswordType;
627 
633  typedef enum _EncryptType {
650  } EncryptType;
651 
657  typedef enum _UserPermissions {
663  e_PermPrint = 0x0004,
670  e_PermModify = 0x0008,
676  e_PermExtract = 0x0010,
682  e_PermAnnotForm = 0x0020,
688  e_PermFillForm = 0x0100,
701  e_PermAssemble = 0x0400,
708  } UserPermissions;
709 
714  typedef enum _SaveFlags {
762  } SaveFlags;
763 
769  typedef enum _ImportPageFlags {
780  } ImportPageFlags;
781 
787  typedef enum _ExtractPagesOptions {
804 
810  typedef enum _InsertDocOptions {
814 
820  typedef enum _DisplayMode {
836  } DisplayMode;
837 
844  typedef enum _DataType {
846  e_Forms = 0x0001,
848  e_Annots = 0x0002,
850  e_Links = 0x0004
851  } DataType;
852 
858  typedef enum _WrapperType {
865  } WrapperType;
866 
867 
874  PDFDoc();
875 
884  explicit PDFDoc(const char* path);
885 
894  explicit PDFDoc(const wchar_t* path);
895 
906  explicit PDFDoc(const void* buffer, size_t size);
907 
922  explicit PDFDoc(common::file::ReaderCallback* file_read, bool is_async = false);
923  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
924  explicit PDFDoc(FS_HANDLE handle);
926  ~PDFDoc();
927 
933  PDFDoc(const PDFDoc& other);
934 
942  PDFDoc& operator = (const PDFDoc& other);
950  bool operator == (const PDFDoc& other) const;
951 
959  bool operator != (const PDFDoc& other) const;
960 
968  bool IsEmpty() const;
969 
976 
996  bool IsLinearized() const;
997 
1004  bool IsTaggedPDF() const;
1005 
1027  ErrorCode Load(const String& password = "");
1028 
1051  ErrorCode LoadW(const WString& password = WString());
1052 
1084  common::Progressive StartLoad(const String& password = "", bool is_cache_stream = true,
1085  common::PauseCallback* pause = NULL);
1117  common::Progressive StartLoadW(const WString& password = WString(), bool is_cache_stream = true,
1118  common::PauseCallback* pause = NULL);
1119 
1129  int GetFirstAvailPageIndex() const;
1130 
1141  bool IsXFA() const;
1142 
1149  bool IsEncrypted() const;
1150 
1156  void ClearRenderCache();
1157 
1171  PasswordType GetPasswordType() const;
1172 
1180 
1195  PasswordType CheckPassword(const String& password);
1196 
1211  PasswordType CheckPassword(const foxit::WString& password);
1212 
1221  bool IsUserPassword(const String& password);
1222 
1231  bool IsUserPassword(const foxit::WString& password);
1232 
1241  bool IsOwnerPassword(const String& password);
1242 
1251  bool IsOwnerPassword(const foxit::WString& password);
1252 
1262  String GetUserPassword(const String& owner_password);
1263 #ifndef __EMSCRIPTEN_RENDER__
1264 
1272 
1281 
1290 
1299 
1312 #endif
1313 
1339  bool SaveAs(const char* file_path, uint32 save_flags = PDFDoc::e_SaveFlagNormal);
1340 
1367  bool SaveAs(const wchar_t* file_path, uint32 save_flags = PDFDoc::e_SaveFlagNormal);
1368 
1402  common::Progressive StartSaveAs(const char* file_path,
1403  uint32 save_flags = PDFDoc::e_SaveFlagNormal,
1404  common::PauseCallback* pause = NULL);
1405 
1439  common::Progressive StartSaveAs(const wchar_t* file_path,
1440  uint32 save_flags = PDFDoc::e_SaveFlagNormal,
1441  common::PauseCallback* pause = NULL);
1442 
1479 #ifndef __EMSCRIPTEN_RENDER__
1480 
1488 
1498 
1505  int GetBookmarkLevelDepth();
1506 
1514  bool RemoveBookmark(const Bookmark& bookmark);
1515 
1522  bool HasLayer() const;
1523 
1530  bool HasHeaderFooter();
1531 
1541 
1552  void AddHeaderFooter(const HeaderFooter& headerfooter);
1553 
1564  void UpdateHeaderFooter(const HeaderFooter& headerfooter);
1565 
1571  bool RemoveAllHeaderFooters();
1572 #endif
1573 
1578  int GetPageCount() const;
1579 
1593  PDFPage GetPage(int index);
1594 
1603  DisplayMode GetDisplayMode() const;
1604 
1615  void SetDisplayMode(DisplayMode display_mode);
1616 
1624 
1632 
1642 
1650 
1658 
1667 
1685 
1693  void DeleteIndirectObject(uint32 object_number);
1694 
1701  uint32 GetUserPermissions() const;
1702 
1709  bool IsWrapper() const;
1710 
1717  WrapperType GetWrapperType() const;
1718 
1725  WrapperData GetWrapperData() const;
1726 
1733  int64 GetWrapperOffset() const;
1734 
1742 
1760 
1786  bool SaveAsWrapperFile(const wchar_t* file_path, const WrapperData* wrapper_data = NULL,
1787  uint32 user_permissions = 0xFFFFFFFC, const char* owner_password = "");
1788 
1816  common::Progressive StartSaveAsPayloadFile(const wchar_t* file_path, const wchar_t* payload_file_path,
1817  const wchar_t* crypto_filter, const wchar_t* description, float version,
1818  uint32 save_flags = PDFDoc::e_SaveFlagNormal,
1819  common::PauseCallback* pause = NULL);
1831  bool HasForm() const;
1832 
1839 #ifndef __EMSCRIPTEN_RENDER__
1840 
1849 
1863  ReadingBookmark InsertReadingBookmark(int reading_bookmark_index, const WString& title, int dest_page_index);
1864 
1872  bool RemoveReadingBookmark(const ReadingBookmark& reading_bookmark);
1873 
1879  int GetSignatureCount();
1880 
1890 
1900  void RemoveSignature(const foxit::pdf::Signature& signature);
1901 #endif
1902 
1915  PDFPage InsertPage(int index, float width, float height);
1929 
1948  PDFPage AddPageFromTemplate(const wchar_t* template_name);
1949 
1965  bool HidePageTemplate(const wchar_t* template_name);
1966 
1975  bool RemovePage(int index);
1976 
1987  bool RemovePage(const foxit::pdf::PDFPage& page);
1988 
2004  bool MovePageTo(const PDFPage& page, int dest_index);
2005 
2026  bool MovePagesTo(const common::Range& page_range, int dest_index);
2027 
2081  const wchar_t* src_file_path, const String& password,
2082  uint32 flags = PDFDoc::e_ImportFlagNormal, const char* layer_name = "",
2083  const common::Range& page_range = common::Range(),
2084  common::PauseCallback* pause = NULL);
2137  const wchar_t* src_file_path, const WString& password,
2138  uint32 flags = PDFDoc::e_ImportFlagNormal, const char* layer_name = "",
2139  const common::Range& page_range = common::Range(),
2140  common::PauseCallback* pause = NULL);
2190  common::Progressive StartImportPages(int dest_index, const PDFDoc& src_doc,
2191  uint32 flags = PDFDoc::e_ImportFlagNormal, const char* layer_name = "",
2192  const common::Range& page_range = common::Range(),
2193  common::PauseCallback* pause = NULL);
2194 
2217  common::Progressive StartExtractPages(const char* file_path, uint32 options, const common::Range& page_range = common::Range(),
2218  common::PauseCallback* pause = NULL);
2219 
2242  common::Progressive StartExtractPages(const wchar_t* file_path, uint32 options, const common::Range& page_range = common::Range(),
2243  common::PauseCallback* pause = NULL);
2244 
2270 
2287  void InsertDocument(int dest_index, const PDFDoc& src_doc, uint32 options);
2288 
2289 #ifndef __EMSCRIPTEN_RENDER__
2290 
2313  bool ImportFromFDF(const fdf::FDFDoc& fdf_doc, int types = pdf::PDFDoc::e_Forms | pdf::PDFDoc::e_Annots, const common::Range& page_range = common::Range());
2314 
2334  bool ExportToFDF(const fdf::FDFDoc& fdf_doc, int types = pdf::PDFDoc::e_Forms | pdf::PDFDoc::e_Annots, const common::Range& page_range = common::Range());
2335 
2344  bool ExportAnnotToFDF(const annots::Annot& pdf_annot,const fdf::FDFDoc& fdf_doc);
2345 
2358  bool ExportFormFieldsToFDF(const pdf::interform::FieldArray& field_array, bool is_include, const fdf::FDFDoc& fdf_doc);
2359 #endif
2360 
2365  String GetHeader() const;
2366 
2372  int GetFileVersion();
2373 
2389  void SetFileVersion(int version);
2390 
2403  bool SetSecurityHandler(const SecurityHandler& handler);
2404 
2415 
2425  bool RemoveSecurity();
2426 
2434  int GetFontCount();
2435 
2444  common::Font GetFont(int index);
2445 
2452 
2464  bool SetOpenAction(actions::Action& action);
2465 
2471  bool RemoveOpenAction();
2472 
2478  bool DoJSOpenAction();
2479 
2485  bool IsPortfolio();
2486 
2501  PageBasicInfo GetPageBasicInfo(int index);
2502 
2509 
2510 #ifdef _SUPPORTWEBSDK_
2511  objects::PDFStream* CreateIcon(String imgStream,int width, int height);
2512 #endif
2513 
2520  void CreateDSS();
2521 
2537  void AddTableOfContents(const wchar_t* title, Int32Array bookmark_level_array);
2538 
2548  void AddTableOfContents(const TableOfContentsConfig& table_of_contents_config);
2549 
2566  void SetCacheFile(foxit::common::file::StreamCallback* file_stream, bool is_own_file_stream);
2567 
2584 
2593  WString GetPageText(int page_index) const;
2594 
2610  PagingSealSignature AddPagingSealSignature(const common::Range& page_range, float width, float height);
2611 
2660  common::Progressive StartAddTiledWatermark(const wchar_t* text, const TiledWatermarkSettings& settings, const WatermarkTextProperties& properties, const common::Range& page_range, common::PauseCallback* pause = NULL);
2688  common::Progressive StartAddTiledWatermark(const wchar_t* src_img_file_path, const TiledWatermarkSettings& settings, const common::Range& page_range, common::PauseCallback* pause = NULL);
2689 
2746 
2747 };
2748 } // namespace pdf
2749 } // namespace foxit
2750 #endif // FS_PDFDOC_H_
2751 
foxit::int64
FX_INT64 int64
Signed 64-bit integer.
Definition: fs_basictypes.h:190
foxit::pdf::PDFDoc::e_DisplayFullScreen
When document is opened, full-screen mode, with no menu bar, window controls, or any other windows ar...
Definition: fs_pdfdoc.h:831
foxit::pdf::TiledWatermarkSettings::row_space
float row_space
The row spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative nu...
Definition: fs_pdfdoc.h:146
foxit::pdf::PDFDoc::GetFileVersion
int GetFileVersion()
Get PDF file version stored in PDF header section.
foxit::pdf::PDFDoc::ImportFromFDF
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.
foxit::pdf::PDFDoc::GetReadingBookmarkCount
int GetReadingBookmarkCount()
Get the count of reading bookmarks.
foxit::pdf::PDFDoc::GetPasswordType
PasswordType GetPasswordType() const
Get the type of current used password.
foxit::pdf::TiledWatermarkSettings::Set
void Set(float row_space, float col_space, float rotation, int opacity, int scale)
Set value.
Definition: fs_pdfdoc.h:137
IFX_FileWrite
File writing interface.
Definition: fx_stream.h:453
foxit::pdf::PDFDoc::AddTableOfContents
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.
CFX_ArrayTemplate::GetSize
int GetSize() const
Get the number of elements in the array.
Definition: fx_basic.h:1360
foxit::pdf::TableOfContentsConfig::include_toc_pages
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:554
foxit::pdf::PDFDoc::SetDisplayMode
void SetDisplayMode(DisplayMode display_mode)
Set the display mode.
foxit::pdf::PDFDoc::RemoveReadingBookmark
bool RemoveReadingBookmark(const ReadingBookmark &reading_bookmark)
Remove a reading bookmark from current PDF document.
foxit::pdf::PDFDoc::IsTaggedPDF
bool IsTaggedPDF() const
Check if current PDF document is a Tagged PDF file.
foxit::pdf::PDFDoc::GetEncryptDict
objects::PDFDictionary * GetEncryptDict() const
Get the encrypt dictionary.
foxit::pdf::PDFDoc::SaveFlags
SaveFlags
Enumeration for PDF document saving flags.
Definition: fs_pdfdoc.h:714
foxit::pdf::PDFDoc::RemoveOpenAction
bool RemoveOpenAction()
Remove the action to be performed when the document is opened.
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
foxit::pdf::TableOfContentsConfig
Definition: fs_pdfdoc.h:443
foxit::pdf::PDFDoc::e_ExtractPagesOptionOCProperties
If set, that means OCProperties will be extracted as well.
Definition: fs_pdfdoc.h:795
foxit::pdf::interform::FieldArray
Definition: fs_pdfform.h:44
foxit::pdf::PDFDoc::GetCatalog
objects::PDFDictionary * GetCatalog() const
Get the catalog dictionary.
foxit::pdf::PDFDoc::SetCacheFile
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.
foxit::pdf::PDFDoc::operator==
bool operator==(const PDFDoc &other) const
Equal operator.
foxit::pdf::WrapperData::WrapperData
WrapperData()
Constructor.
Definition: fs_pdfdoc.h:166
foxit::pdf::WrapperData::description
WString description
Description for wrapper file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:241
foxit::pdf::PDFDoc::GetWrapperOffset
int64 GetWrapperOffset() const
Get wrapper offset if current document's wrapper type is PDFDoc::e_WrapperFoxit.
foxit::pdf::PDFDoc::e_PwdUser
A user password is used in PDF document.
Definition: fs_pdfdoc.h:623
foxit::pdf::PDFDoc::UserPermissions
UserPermissions
Enumeration for user access permissions in a PDF document.
Definition: fs_pdfdoc.h:657
foxit::pdf::actions::Action
Definition: fs_action.h:418
foxit::pdf::PDFDoc::UpdateHeaderFooter
void UpdateHeaderFooter(const HeaderFooter &headerfooter)
Update header-footer.
foxit::pdf::PDFDoc::e_WrapperPDFV2
PDF 2.0 wrapper document.
Definition: fs_pdfdoc.h:864
foxit::pdf::annots::Annot
Definition: fs_annot.h:996
foxit::pdf::PDFDoc::DoJSOpenAction
bool DoJSOpenAction()
Perform JavaScript actions when the document is opened.
foxit::pdf::PDFDoc::GetUserPermissions
uint32 GetUserPermissions() const
Get user access permissions.
foxit::pdf::PDFDoc::MovePageTo
bool MovePageTo(const PDFPage &page, int dest_index)
Move a specified page to a new index position.
foxit::pdf::PDFDoc::GetSignature
foxit::pdf::Signature GetSignature(int index)
Get a signature by index.
foxit::pdf::PDFDoc::GetHeader
String GetHeader() const
Get PDF header identifying the version of the PDF specification to which the file conforms.
foxit::pdf::PDFDoc::ExportFormFieldsToFDF
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.
foxit::pdf::PayLoadData
Definition: fs_pdfdoc.h:245
foxit::pdf::TableOfContentsConfig::TableOfContentsConfig
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:454
foxit::pdf::WrapperData
Definition: fs_pdfdoc.h:163
foxit::pdf::PDFPage::Size
Size
Enumeration for page size type.
Definition: fs_pdfpage.h:490
foxit::Object
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
foxit::pdf::PayLoadData::file_name
WString file_name
The payload file name.
Definition: fs_pdfdoc.h:324
foxit::pdf::TableOfContentsConfig::is_show_serial_number
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:549
foxit::pdf::PDFDoc::GetSecurityHandler
SecurityHandler GetSecurityHandler()
Get current PDF security handler of current document.
foxit::common::Progressive
Definition: fs_common.h:346
foxit::pdf::CertificateEncryptData
Definition: fs_security.h:365
foxit::pdf::WrapperData::version
int version
Wrapper version.
Definition: fs_pdfdoc.h:233
foxit::pdf::PayLoadData::PayLoadData
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:261
foxit::pdf::EmbeddedFontData::EmbeddedFontData
EmbeddedFontData(const EmbeddedFontData &other)
Constructor, with another embedded font data object.
Definition: fs_pdfdoc.h:419
foxit::pdf::PDFDoc::ExportAnnotToFDF
bool ExportAnnotToFDF(const annots::Annot &pdf_annot, const fdf::FDFDoc &fdf_doc)
Export specified annotation to a FDF/XFDF document.
foxit::pdf::TableOfContentsConfig::operator==
bool operator==(const TableOfContentsConfig &other) const
Equal operator.
Definition: fs_pdfdoc.h:489
foxit::pdf::PDFDoc::IsLinearized
bool IsLinearized() const
Check if current PDF document is a linearized file.
foxit::pdf::PDFDoc::ExportToFDF
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.
foxit::pdf::EmbeddedFontData::EmbeddedFontData
EmbeddedFontData()
Constructor.
Definition: fs_pdfdoc.h:412
foxit::pdf::PDFDoc::WrapperType
WrapperType
Enumeration for wrapper type.
Definition: fs_pdfdoc.h:858
IFX_FileStream
File stream interface, reading & writing.
Definition: fx_stream.h:675
foxit::pdf::TableOfContentsConfig::bookmark_level_array
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:547
foxit::pdf::PDFDoc::StartLoadW
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.
foxit::pdf::PDFDoc::RemoveSecurity
bool RemoveSecurity()
Remove the security handler from current document, so that the later saved document will be unencrypt...
foxit::pdf::PDFDoc::PDFDoc
PDFDoc()
Constructor.
fs_common.h
Header file for common definitions and classes.
foxit::pdf::TiledWatermarkSettings::TiledWatermarkSettings
TiledWatermarkSettings()
Constructor and set the default value.
Definition: fs_pdfdoc.h:88
foxit::pdf::PDFDoc::SaveAsWrapperFile
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.
foxit::pdf::PDFDoc::RemoveAllHeaderFooters
bool RemoveAllHeaderFooters()
Remove all header-footers.
foxit::pdf::PDFDoc::DisplayMode
DisplayMode
Enumeration for display mode which specifies how the document should be displayed when opened.
Definition: fs_pdfdoc.h:820
foxit::pdf::PDFDoc::e_ExtractPagesOptionJavascript
If set, that means Javascript will be extracted as well.
Definition: fs_pdfdoc.h:793
foxit::pdf::PDFDoc::e_DisplayUseThumbs
When document is opened, thumbnail images are visible.
Definition: fs_pdfdoc.h:826
foxit::pdf::PDFDoc::e_EncryptNone
No encryption pattern.
Definition: fs_pdfdoc.h:637
CFX_ArrayTemplate< int32 >
foxit::pdf::PDFDoc::e_SaveFlagNoOriginal
Save document without original data or unchanged objects.
Definition: fs_pdfdoc.h:735
foxit::pdf::TiledWatermarkSettings::TiledWatermarkSettings
TiledWatermarkSettings(float row_space, float col_space, float rotation, int opacity, int scale)
Constructor, with parameters.
Definition: fs_pdfdoc.h:74
foxit::pdf::PDFDoc::operator!=
bool operator!=(const PDFDoc &other) const
Not equal operator.
foxit::pdf::PDFDoc::RemoveBookmark
bool RemoveBookmark(const Bookmark &bookmark)
Remove a specified bookmark.
IFX_FileRead
File reading interface.
Definition: fx_stream.h:570
foxit::pdf::PDFDoc::GetIndirectObject
objects::PDFObject * GetIndirectObject(uint32 object_number)
Get an indirect object by indirect object number.
foxit::pdf::PDFDoc::CreateDSS
void CreateDSS()
Create DSS information in current PDF document.
foxit::pdf::PDFDoc::e_SaveFlagNoUpdatingMetadataDateTime
Save document without updating metadata "ModDate" and "CreationDate".
Definition: fs_pdfdoc.h:761
fs_file.h
Header file for file operation related definitions and functions.
foxit::pdf::PDFDoc::GetStdEncryptData
StdEncryptData GetStdEncryptData() const
Get encrypt data of standard encryption (known as password encryption).
foxit::pdf::RMSEncryptData
Definition: fs_security.h:961
foxit::pdf::PDFDoc::GetInfo
objects::PDFDictionary * GetInfo() const
Get the information dictionary.
foxit::pdf::PDFDoc::SetFileVersion
void SetFileVersion(int version)
Set the PDF file version which will be stored in PDF header section of the saved PDF file.
foxit::pdf::PayLoadData::description
WString description
Description for payload file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:328
foxit::pdf::PDFDoc::GetUserPassword
String GetUserPassword(const String &owner_password)
Get the user password based on owner password.
foxit::pdf::EmbeddedFontData::operator=
EmbeddedFontData & operator=(const EmbeddedFontData &other)
Assign operator.
Definition: fs_pdfdoc.h:430
foxit::pdf::PDFDoc::GetWrapperData
WrapperData GetWrapperData() const
Get wrapper data if current document's wrapper type is PDFDoc::e_WrapperFoxit.
foxit::ErrorCode
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:237
foxit::pdf::PDFDoc::e_EncryptFoxitDRM
Encryption type: Foxit DRM encryption.
Definition: fs_pdfdoc.h:643
foxit::pdf::PDFDoc::e_ImportFlagNormal
Import pages normally.
Definition: fs_pdfdoc.h:771
foxit::pdf::PDFDoc::StartEmbedAllFonts
common::Progressive StartEmbedAllFonts(common::PauseCallback *pause=0)
Start to convert all un-embeded fonts to embeded fonts.
foxit::pdf::PDFDoc::GetSignatureCount
int GetSignatureCount()
Get the count of signature.
foxit::pdf::PDFDoc::StartExtractPages
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.
foxit::pdf::objects::PDFObject
Definition: fs_pdfobject.h:55
foxit::pdf::PDFDoc::GetFont
common::Font GetFont(int index)
Get a font by index.
foxit::pdf::TableOfContentsConfig::operator!=
bool operator!=(const TableOfContentsConfig &other) const
Not equal operator.
Definition: fs_pdfdoc.h:509
foxit::pdf::WatermarkTextProperties
Definition: fs_watermark.h:333
foxit::pdf::PDFDoc::ClearRenderCache
void ClearRenderCache()
Clear the cache used during rendering, to reduce the memory usage.
foxit::pdf::PDFDoc::e_EncryptPassword
Encryption type: password, which is the standard encryption.
Definition: fs_pdfdoc.h:639
foxit::pdf::PDFDoc::IsPortfolio
bool IsPortfolio()
Check whether current PDF document is a portfolio file or not.
foxit::pdf::PDFDoc::RemovePage
bool RemovePage(int index)
Remove a PDF page by page index.
foxit::pdf::PDFDoc::GetReadingBookmark
ReadingBookmark GetReadingBookmark(int index)
Get a reading bookmark by index.
foxit::pdf::PDFDoc::e_PermAssemble
Assemble PDF document. (Bit 11 in permission value)
Definition: fs_pdfdoc.h:701
foxit::pdf::PDFDoc::GetDisplayMode
DisplayMode GetDisplayMode() const
Get the display mode.
foxit::pdf::PDFDoc::e_DisplayUseOC
When document is opened, optional content group panels are visible.
Definition: fs_pdfdoc.h:833
foxit::pdf::PDFDoc::HasLayer
bool HasLayer() const
Check whether current PDF document has layer (known as "Optional content group" in <PDF reference 1....
foxit::pdf::PDFDoc::GetPage
PDFPage GetPage(int index)
Get a PDF page by index.
foxit::pdf::PDFDoc::e_Links
(Reserved, not supported yet) If set, only link annotations are to imported from or exported to XFDF ...
Definition: fs_pdfdoc.h:850
foxit::pdf::PDFDoc::GetFileSize
uint64 GetFileSize()
Get file size.
foxit::pdf::PDFDoc::e_SaveFlagRemoveRedundantObjects
Save document with removing redundant PDF objects.
Definition: fs_pdfdoc.h:754
foxit::pdf::TiledWatermarkSettings::scale
int scale
The image or page scale in percents. Valid range: from 0 to 100. 0 means not displayed,...
Definition: fs_pdfdoc.h:160
foxit::pdf::PDFDoc::e_DisplayUseAttachment
When document is opened, attachment panels are visible.
Definition: fs_pdfdoc.h:835
foxit::pdf::PDFDoc::DataType
DataType
Enumeration for data type used to decide which object(s) will be imported from or exported to FDF/XFD...
Definition: fs_pdfdoc.h:844
foxit::pdf::PDFDoc::e_Forms
If set, form fields are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:846
foxit::pdf::CustomEncryptData
Definition: fs_security.h:824
foxit::pdf::EmbeddedFontData::nonstandard_font_name_array
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:437
foxit::pdf::PDFDoc::ExtractPagesOptions
ExtractPagesOptions
Enumeration for options used for extracting pages.
Definition: fs_pdfdoc.h:787
foxit::pdf::PDFDoc::InsertPage
PDFPage InsertPage(int index, float width, float height)
Insert a new blank PDF page to document, by index.
foxit::pdf::PDFDoc::GetRMSEncryptData
RMSEncryptData GetRMSEncryptData() const
Get encrypt data of RMS encryption.
foxit::pdf::PDFDoc::e_EncryptCDRM
(Reserved, currently, this value is not used.) Encryption type: Foxit connected PDF DRM encryption.
Definition: fs_pdfdoc.h:649
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
foxit::pdf::PDFDoc::GetOpenAction
actions::Action GetOpenAction()
Get the action to be performed when the document is opened.
foxit::pdf::PageBasicInfo::PageBasicInfo
PageBasicInfo(float width, float height, common::Rotation rotation)
Constructor, with parameters.
Definition: fs_pdfdoc.h:345
foxit::pdf::PDFDoc::e_DisplayUseNone
When document is opened, neither document outlines nor thumbnail images are visible.
Definition: fs_pdfdoc.h:822
foxit::pdf::PDFDoc::e_EncryptRMS
Encryption type: Microsoft RMS encryption.
Definition: fs_pdfdoc.h:647
foxit::pdf::PDFDoc::MovePagesTo
bool MovePagesTo(const common::Range &page_range, int dest_index)
Move one or more pages (specified by index) to a new index position.
foxit::pdf::PDFDoc::HasHeaderFooter
bool HasHeaderFooter()
Check whether current document has header-footer.
foxit::pdf::PageBasicInfo::PageBasicInfo
PageBasicInfo()
Constructor.
Definition: fs_pdfdoc.h:351
foxit::pdf::PDFDoc::GetPageText
WString GetPageText(int page_index) const
Get the specified PDF page text which the text is in display order.
foxit::pdf::PDFDoc::e_EncryptUnknown
Unknown encryption type.
Definition: fs_pdfdoc.h:635
fs_headerfooter.h
Header file for header-footer related definitions and classes.
foxit::pdf::WrapperData::type
WString type
Wrapper type to indicate a type of the current wrapper file.
Definition: fs_pdfdoc.h:235
foxit::pdf::Signature
Definition: fs_signature.h:99
foxit::pdf::PDFDoc::GetFirstAvailPageIndex
int GetFirstAvailPageIndex() const
Get the page index of the fist available page.
CFX_ArrayTemplate::GetAt
const TYPE GetAt(int nIndex) const
This method retrieves an element specified by an index number.
Definition: fx_basic.h:1396
foxit::pdf::StdEncryptData
Definition: fs_security.h:137
foxit::pdf::PDFDoc::HidePageTemplate
bool HidePageTemplate(const wchar_t *template_name)
Hide a named page.
foxit::pdf::WrapperData::uri
WString uri
The URI for consumers to get more information.
Definition: fs_pdfdoc.h:239
foxit::pdf::PDFDoc::GetBookmarkLevelDepth
int GetBookmarkLevelDepth()
Get bookmark level depth.
foxit::common::Rotation
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
foxit::pdf::PDFDoc::IsUserPassword
bool IsUserPassword(const String &password)
Check if input password is the user password of current PDF document.
foxit::common::e_RotationUnknown
Unknown rotation.
Definition: fs_common.h:67
foxit::pdf::PDFDoc::e_DisplayUseOutlines
When document is opened, document outlines (bookmarks) are visible.
Definition: fs_pdfdoc.h:824
foxit::pdf::PDFDoc::StartImportPages
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).
foxit::pdf::TiledWatermarkSettings::operator=
TiledWatermarkSettings & operator=(const TiledWatermarkSettings &settings)
Assign operator.
Definition: fs_pdfdoc.h:114
foxit::pdf::TableOfContentsConfig::Set
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:532
foxit::pdf::PDFDoc::StartSaveAs
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.
foxit::pdf::PDFDoc::StartLoad
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.
foxit::pdf::PDFDoc::operator=
PDFDoc & operator=(const PDFDoc &other)
Assign operator.
fs_pdfobject.h
Header file for PDF object related definitions and classes.
foxit::pdf::PageBasicInfo
Definition: fs_pdfdoc.h:335
foxit::pdf::PDFDoc::GetPageCount
int GetPageCount() const
Get the count of pages.
fs_pdfpage.h
Header file for PDF page related definitions and classes.
foxit::pdf::PayLoadData::operator=
PayLoadData & operator=(const PayLoadData &payload_data)
Assign operator.
Definition: fs_pdfdoc.h:291
foxit::pdf::PDFDoc::e_PermFillForm
Fill PDF form. (Bit 9 in permission value)
Definition: fs_pdfdoc.h:688
foxit::pdf::PDFDoc::SaveAs
bool SaveAs(const char *file_path, uint32 save_flags=PDFDoc::e_SaveFlagNormal)
Save current PDF document as another PDF file.
foxit::WString
CFX_WideString WString
Wide string.
Definition: fs_basictypes.h:223
foxit::pdf::PDFDoc::EncryptType
EncryptType
Enumeration for encryption type.
Definition: fs_pdfdoc.h:633
foxit::pdf::PageBasicInfo::operator=
PageBasicInfo & operator=(const PageBasicInfo &page_info)
Assign operator.
Definition: fs_pdfdoc.h:371
foxit::pdf::PDFDoc::StartRecognizeForm
common::Progressive StartRecognizeForm(common::PauseCallback *pause=0)
Start to recognize form in current PDF document.
foxit::pdf::WrapperData::WrapperData
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:178
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::pdf::SecurityHandler
Definition: fs_security.h:56
foxit::pdf::PayLoadData::PayLoadData
PayLoadData()
Constructor.
Definition: fs_pdfdoc.h:248
foxit::pdf::PDFDoc::AddIndirectObject
uint32 AddIndirectObject(objects::PDFObject *pdf_object)
Add a PDF object to current PDF document, to be an indirect object.
foxit::pdf::Bookmark
Definition: fs_bookmark.h:58
foxit::pdf::PDFDoc::InsertDocument
void InsertDocument(int dest_index, const PDFDoc &src_doc, uint32 options)
Insert another PDF document to the specified location of current PDF document.
foxit::pdf::PDFDoc::GetPageBasicInfo
PageBasicInfo GetPageBasicInfo(int index)
Get the basic information of a page specified by index.
foxit::pdf::PDFDoc::RemoveSignature
void RemoveSignature(const foxit::pdf::Signature &signature)
Remove a signature.
foxit::pdf::PDFDoc::e_SaveFlagIncremental
Save document incrementally.
Definition: fs_pdfdoc.h:727
foxit::pdf::ReadingBookmark
Definition: fs_readingbookmark.h:43
foxit::pdf::TiledWatermarkSettings::opacity
int opacity
Opacity in percents. Valid range: from 0 to 100. 0 for fully transparent and 100 for fully opaque.
Definition: fs_pdfdoc.h:155
foxit::pdf::PDFDoc::e_ExtractPagesOptionAttachFiles
If set, that means attachment files will be extracted as well.
Definition: fs_pdfdoc.h:802
foxit::pdf::PDFDoc::e_Annots
If set, annotations (except link annotations) are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:848
IFX_Pause
Definition: fx_basic.h:3761
foxit::pdf::TiledWatermarkSettings::col_space
float col_space
The column spacing for multiple lines of tiled watermark. Its unit is inch and it can't be a negative...
Definition: fs_pdfdoc.h:148
foxit::pdf::PDFDoc::LoadW
ErrorCode LoadW(const WString &password=WString())
Load current document content by using a specified password.
foxit::pdf::PDFDoc::e_EncryptCertificate
Encryption type: digital certificate encryption.
Definition: fs_pdfdoc.h:641
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:809
foxit::pdf::PDFDoc::GetFontCount
int GetFontCount()
Count all the PDF fonts used in current PDF document.
foxit::pdf::PDFDoc::AddHeaderFooter
void AddHeaderFooter(const HeaderFooter &headerfooter)
Add new header-footer.
foxit::pdf::PDFDoc::HasForm
bool HasForm() const
Check whether current PDF document has interactive form (also known as AcroForm).
foxit::pdf::PageBasicInfo::Set
void Set(float width, float height, common::Rotation rotation)
Set value.
Definition: fs_pdfdoc.h:387
foxit::pdf::PDFDoc::StartAddTiledWatermark
common::Progressive StartAddTiledWatermark(const wchar_t *text, const TiledWatermarkSettings &settings, const WatermarkTextProperties &properties, const common::Range &page_range, common::PauseCallback *pause=0)
Add text type tiled watermark to PDF pages.
foxit::pdf::PDFDoc::e_ImportFlagWithLayers
Import pages with layers.
Definition: fs_pdfdoc.h:773
foxit::pdf::PDFDoc::e_PermAnnotForm
Operate text annotations and fill in interactive form fields. (Bit 6 in permission value)
Definition: fs_pdfdoc.h:682
foxit::pdf::PDFDoc::StartImportPagesFromFilePath
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).
foxit::pdf::PayLoadData::Set
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:309
foxit::pdf::WrapperData::Set
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:224
foxit::pdf::PDFDoc::e_ExtractPagesOptionStructureTree
If set, that means structure tree will be extracted as well.
Definition: fs_pdfdoc.h:791
foxit::pdf::PDFDoc::InsertReadingBookmark
ReadingBookmark InsertReadingBookmark(int reading_bookmark_index, const WString &title, int dest_page_index)
Insert a reading bookmark to current PDF document.
foxit::pdf::PagingSealSignature
Definition: fs_signature.h:2091
foxit::pdf::PDFDoc::CheckPassword
PasswordType CheckPassword(const String &password)
Check the type of a specified password.
foxit::pdf::PDFDoc::InsertDocOptions
InsertDocOptions
Enumeration for options used for inserting a PDF document to another.
Definition: fs_pdfdoc.h:810
foxit::pdf::TiledWatermarkSettings::rotation
float rotation
Rotation angle in degrees.
Definition: fs_pdfdoc.h:150
foxit::pdf::TiledWatermarkSettings
Definition: fs_pdfdoc.h:59
foxit::pdf::PDFDoc::GetTrailer
objects::PDFDictionary * GetTrailer() const
Get the trailer dictionary.
foxit::pdf::PDFDoc::ImportPageFlags
ImportPageFlags
Enumeration for flags used for importing pages.
Definition: fs_pdfdoc.h:769
foxit::pdf::PDFDoc::SetOpenAction
bool SetOpenAction(actions::Action &action)
Set the action to be performed when the document is opened.
foxit::pdf::PDFDoc::e_ExtractPagesOptionAnnotation
If set, that means annotations related to extracted pages will be extracted as well.
Definition: fs_pdfdoc.h:789
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:780
foxit::pdf::PDFDoc::StartGetPayloadFile
common::Progressive StartGetPayloadFile(foxit::common::file::WriterCallback *payload_file, common::PauseCallback *pause=0)
Start to get payload file.
foxit::pdf::WrapperData::operator=
WrapperData & operator=(const WrapperData &wrapper_data)
Assign operator.
Definition: fs_pdfdoc.h:204
foxit::pdf::PDFDoc::e_SaveFlagNormal
Save document normally, without using any special flag.
Definition: fs_pdfdoc.h:719
foxit::pdf::PDFDoc::~PDFDoc
~PDFDoc()
Destructor.
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:610
foxit::pdf::PayLoadData::crypto_filter
WString crypto_filter
The name of the cryptographic filter used to encrypt the encrypted payload document.
Definition: fs_pdfdoc.h:322
foxit::pdf::WrapperData::app_id
WString app_id
Application identity to indicate applications to open this wrapper data.
Definition: fs_pdfdoc.h:237
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:412
foxit::pdf::PDFDoc::e_ExtractPagesOptionObjectStream
If set, that means to use PDFDoc::e_SaveFlagXRefStream saving flag for the result file in order to re...
Definition: fs_pdfdoc.h:800
foxit::pdf::PDFDoc::GetEncryptionType
EncryptType GetEncryptionType() const
Get the encryption type.
foxit::pdf::PDFDoc::IsOwnerPassword
bool IsOwnerPassword(const String &password)
Check if input password is the owner password of current PDF document.
foxit::fdf::FDFDoc
Definition: fs_fdfdoc.h:51
foxit::pdf::PageBasicInfo::height
float height
Page height (unit is 1/72 inch).
Definition: fs_pdfdoc.h:397
foxit::pdf::PDFDoc::CreateRootBookmark
Bookmark CreateRootBookmark()
Create new bookmark root node.
foxit::pdf::TableOfContentsConfig::operator=
TableOfContentsConfig & operator=(const TableOfContentsConfig &other)
Assign operator.
Definition: fs_pdfdoc.h:474
foxit::pdf::PDFDoc::AddPageFromTemplate
PDFPage AddPageFromTemplate(const wchar_t *template_name)
Adds a new PDF page to document, from a named template.
foxit::pdf::PDFDoc::e_ImportFlagShareStream
Import pages without cloning stream objects into memory.
Definition: fs_pdfdoc.h:779
foxit::pdf::PDFDoc::SetSecurityHandler
bool SetSecurityHandler(const SecurityHandler &handler)
Set a PDF security handler for encryption, such as standard encryption(password), certificate encrypt...
foxit::pdf::DRMEncryptData
Definition: fs_security.h:580
foxit::pdf::PDFDoc::IsEncrypted
bool IsEncrypted() const
Check whether current document is an encrypted file or not.
foxit::pdf::PayLoadData::version
float version
The version number of the cryptographic filter used to encrypt the encrypted payload referenced by th...
Definition: fs_pdfdoc.h:320
foxit::pdf::PDFDoc::GetEmbeddedFontData
EmbeddedFontData GetEmbeddedFontData()
Get embedded font data.
foxit::pdf::TableOfContentsConfig::TableOfContentsConfig
TableOfContentsConfig()
Constructor.
Definition: fs_pdfdoc.h:461
foxit::pdf::PDFDoc::e_PermPrintHigh
Print PDF document with higher qualities. (Bit 12 in permission value)
Definition: fs_pdfdoc.h:707
foxit::WStringArray
Definition: fs_basictypes.h:228
foxit::pdf::WrapperData::WrapperData
WrapperData(const WrapperData &wrapper_data)
Constructor, with another wrapper data object.
Definition: fs_pdfdoc.h:190
foxit::pdf::PayLoadData::file_size
int64 file_size
The payload file size.
Definition: fs_pdfdoc.h:326
foxit::pdf::PDFDoc::IsWrapper
bool IsWrapper() const
Check whether current document is a wrapper file or not.
foxit::common::Font
Definition: fs_common.h:1391
foxit::pdf::PDFDoc::e_EncryptCustom
Encryption type: customized encryption.
Definition: fs_pdfdoc.h:645
foxit::pdf::PDFDoc::e_PwdOwner
An owner password is used in PDF document.
Definition: fs_pdfdoc.h:625
foxit::pdf::PageBasicInfo::PageBasicInfo
PageBasicInfo(const PageBasicInfo &page_info)
Constructor, with another page basic information object.
Definition: fs_pdfdoc.h:360
foxit::pdf::PDFDoc::e_PermModify
Modify PDF contents. (Bit 4 in permission value)
Definition: fs_pdfdoc.h:670
foxit::pdf::PDFDoc::IsXFA
bool IsXFA() const
Check whether current PDF document is an XFA document.
foxit::pdf::PDFDoc::AddPagingSealSignature
PagingSealSignature AddPagingSealSignature(const common::Range &page_range, float width, float height)
Add a paging seal signature to document by page range.
foxit::pdf::PageBasicInfo::rotation
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:402
foxit::pdf::PDFDoc::GetWrapperType
WrapperType GetWrapperType() const
Get Wrapper type.
foxit::pdf::PDFDoc::GetCustomEncryptData
CustomEncryptData GetCustomEncryptData() const
Get encrypt data of custom encryption.
foxit::pdf::PDFDoc::GetCertificateEncryptData
CertificateEncryptData GetCertificateEncryptData() const
Get encrypt data of certificate encryption.
foxit::pdf::EmbeddedFontData
Definition: fs_pdfdoc.h:409
foxit::pdf::EmbeddedFontData::standard_font_name_array
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:439
foxit::pdf::PageBasicInfo::width
float width
Page width (unit is 1/72 inch).
Definition: fs_pdfdoc.h:394
foxit::pdf::PayLoadData::PayLoadData
PayLoadData(const PayLoadData &payload_data)
Constructor, with another payload data object.
Definition: fs_pdfdoc.h:276
foxit::pdf::objects::PDFStream
Definition: fs_pdfobject.h:422
foxit::pdf::PDFDoc::GetPagesDict
objects::PDFDictionary * GetPagesDict() const
Get the dictionary of "Pages".
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1452
fs_bookmark.h
Header file for bookmark related definitions and classes.
foxit::common::Range
Definition: fs_common.h:1236
foxit::pdf::PDFDoc::e_WrapperNone
Normal document.
Definition: fs_pdfdoc.h:860
foxit::pdf::PDFDoc::GetDRMEncryptData
DRMEncryptData GetDRMEncryptData() const
Get encrypt data of Foxit DRM encryption.
foxit::pdf::PDFDoc::e_InsertDocOptionAttachments
If set, that means attachments will be inserted to target document as well.
Definition: fs_pdfdoc.h:812
foxit::pdf::PDFDoc::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::PDFDoc::GetPayLoadData
PayLoadData GetPayLoadData()
Get payload data if current document's wrapper type is PDFDoc::e_WrapperPDFV2.
foxit::pdf::TiledWatermarkSettings::TiledWatermarkSettings
TiledWatermarkSettings(const TiledWatermarkSettings &settings)
Constructor, with another tiled watermark settings object.
Definition: fs_pdfdoc.h:100
foxit::pdf::PDFDoc::GetRootBookmark
Bookmark GetRootBookmark()
Get bookmark root node.
fs_readingbookmark.h
Header file for reading bookmark related definitions and classes.
foxit::pdf::TableOfContentsConfig::title
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:540
foxit::pdf::PDFDoc::DeleteIndirectObject
void DeleteIndirectObject(uint32 object_number)
Delete an indirect object by indirect object number.
foxit::pdf::PDFDoc::e_WrapperFoxit
Foxit wrapper document.
Definition: fs_pdfdoc.h:862
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
foxit::pdf::PDFDoc::GetEditableHeaderFooter
HeaderFooter GetEditableHeaderFooter()
Get the editable header footer object.
foxit::pdf::PDFDoc::e_SaveFlagXRefStream
Save document by using XRef stream.
Definition: fs_pdfdoc.h:740
foxit::pdf::PDFDoc::e_PermPrint
Print PDF document with normal mode. (Bit 3 in permission value)
Definition: fs_pdfdoc.h:663
foxit::pdf::PDFDoc::e_PwdInvalid
The password is invalid.
Definition: fs_pdfdoc.h:619
foxit::pdf::PDFDoc::e_PermExtract
Extract PDF contents. (Bit 5 in permission value)
Definition: fs_pdfdoc.h:676
foxit::pdf::PDFDoc::Load
ErrorCode Load(const String &password="")
Load current document content by using a specified password.
foxit::pdf::PDFDoc::e_PwdNoPassword
No password is used in PDF document.
Definition: fs_pdfdoc.h:621
foxit::uint64
FX_UINT64 uint64
Unsigned 64-bit integer.
Definition: fs_basictypes.h:192
foxit::Base
Definition: fs_basictypes.h:427
foxit::pdf::PDFPage::e_SizeLetter
Page size: letter.
Definition: fs_pdfpage.h:492
foxit::pdf::PDFDoc::e_PermExtractAccess
Disabilities support. (Bit 10 in permission value)
Definition: fs_pdfdoc.h:694
foxit::pdf::PDFDoc::e_SaveFlagLinearized
Save document as a linearized file.
Definition: fs_pdfdoc.h:747
foxit::pdf::PDFDoc::PasswordType
PasswordType
Enumeration for the type of current used password in a PDF document.
Definition: fs_pdfdoc.h:617
foxit::pdf::PDFDoc::StartSaveAsPayloadFile
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....