20 #ifndef __EMSCRIPTEN_RENDER__ 25 #ifndef __EMSCRIPTEN_RENDER__ 37 #ifndef __EMSCRIPTEN_RENDER__ 49 class ReadingBookmark;
50 class SecurityHandler;
52 class CertificateEncryptData;
54 class CustomEncryptData;
396 typedef enum _PasswordType {
412 typedef enum _EncryptType {
436 typedef enum _UserPermissions {
493 typedef enum _SaveFlags {
534 typedef enum _ImportPageFlags {
552 typedef enum _ExtractPagesOptions {
575 typedef enum _InsertDocOptions {
585 typedef enum _DisplayMode {
609 typedef enum _DataType {
623 typedef enum _WrapperType {
649 explicit PDFDoc(
const char* path);
659 explicit PDFDoc(
const wchar_t* path);
671 explicit PDFDoc(
const void* buffer,
size_t size);
1028 #ifndef __EMSCRIPTEN_RENDER__ 1244 #ifndef __EMSCRIPTEN_RENDER__ 1539 uint32 user_permissions = 0xFFFFFFFC,
const char* owner_password =
"");
1569 const wchar_t* crypto_filter,
const wchar_t* description,
float version,
1591 #ifndef __EMSCRIPTEN_RENDER__ 1792 const wchar_t* src_file_path,
const String& password,
1849 const wchar_t* src_file_path,
const WString& password,
2002 #ifndef __EMSCRIPTEN_RENDER__ 2205 #ifdef _SUPPORTWEBSDK_ 2220 #endif // FS_PDFDOC_H_ FX_INT64 int64
Signed 64-bit integer.
Definition: fs_basictypes.h:192
When document is opened, full-screen mode, with no menu bar, window controls, or any other windows ar...
Definition: fs_pdfdoc.h:596
int GetFileVersion()
Get PDF file version stored in PDF header section.
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.
int GetReadingBookmarkCount()
Get the count of reading bookmarks.
PasswordType GetPasswordType() const
Get the type of current used password.
File writing interface.
Definition: fx_stream.h:451
void SetDisplayMode(DisplayMode display_mode)
Set the display mode.
bool RemoveReadingBookmark(const ReadingBookmark &reading_bookmark)
Remove a reading bookmark from current PDF document.
bool IsTaggedPDF() const
Check if current PDF document is a Tagged PDF file.
objects::PDFDictionary * GetEncryptDict() const
Get the encrypt dictionary.
SaveFlags
Enumeration for PDF document saving flags.
Definition: fs_pdfdoc.h:493
bool RemoveOpenAction()
Remove the action to be performed when the document is opened.
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
If set, that means OCProperties will be extracted as well.
Definition: fs_pdfdoc.h:560
objects::PDFDictionary * GetCatalog() const
Get the catalog dictionary.
bool operator==(const PDFDoc &other) const
Equal operator.
WrapperData()
Constructor.
Definition: fs_pdfdoc.h:61
WString description
Description for wrapper file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:136
int64 GetWrapperOffset() const
Get wrapper offset if current document's wrapper type is PDFDoc::e_WrapperFoxit.
A user password is used in PDF document.
Definition: fs_pdfdoc.h:402
UserPermissions
Enumeration for user access permissions in a PDF document.
Definition: fs_pdfdoc.h:436
Definition: fs_action.h:418
void UpdateHeaderFooter(const HeaderFooter &headerfooter)
Update header-footer.
PDF 2.0 wrapper document.
Definition: fs_pdfdoc.h:629
Definition: fs_annot.h:754
bool DoJSOpenAction()
Perform JavaScript actions when the document is opened.
uint32 GetUserPermissions() const
Get user access permissions.
bool MovePageTo(const PDFPage &page, int dest_index)
Move a specified page to a new index position.
foxit::pdf::Signature GetSignature(int index)
Get a signature by index.
String GetHeader() const
Get PDF header identifying the version of the PDF specification to which the file conforms.
Definition: fs_pdfdoc.h:140
Definition: fs_pdfdoc.h:58
Size
Enumeration for page size type.
Definition: fs_pdfpage.h:420
CFX_Object Object
Object type.
Definition: fs_basictypes.h:219
WString file_name
The payload file name.
Definition: fs_pdfdoc.h:219
SecurityHandler GetSecurityHandler()
Get current PDF security handler of current document.
Definition: fs_common.h:568
Definition: fs_security.h:368
int version
Wrapper version.
Definition: fs_pdfdoc.h:128
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:156
EmbeddedFontData(const EmbeddedFontData &other)
Constructor, with another embedded font data object.
Definition: fs_pdfdoc.h:313
bool ExportAnnotToFDF(const annots::Annot &pdf_annot, const fdf::FDFDoc &fdf_doc)
Export specified annotation to a FDF/XFDF document.
bool IsLinearized() const
Check if current PDF document is a linearized file.
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.
EmbeddedFontData()
Constructor.
Definition: fs_pdfdoc.h:306
WrapperType
Enumeration for wrapper type.
Definition: fs_pdfdoc.h:623
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.
bool RemoveSecurity()
Remove the security handler from current document, so that the later saved document will be unencrypt...
Header file for common definitions and classes.
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.
bool RemoveAllHeaderFooters()
Remove all header-footers.
DisplayMode
Enumeration for display mode which specifies how the document should be displayed when opened.
Definition: fs_pdfdoc.h:585
If set, that means Javascript will be extracted as well.
Definition: fs_pdfdoc.h:558
When document is opened, thumbnail images are visible.
Definition: fs_pdfdoc.h:591
No encryption pattern.
Definition: fs_pdfdoc.h:416
Save document without original data or unchanged objects.
Definition: fs_pdfdoc.h:509
bool RemoveBookmark(const Bookmark &bookmark)
Remove a specified bookmark.
File reading interface.
Definition: fx_stream.h:566
objects::PDFObject * GetIndirectObject(uint32 object_number)
Get an indirect object by indirect object number.
void CreateDSS()
Create DSS information in current PDF document.
Header file for file operation related definitions and functions.
StdEncryptData GetStdEncryptData() const
Get encrypt data of standard encryption (known as password encryption).
Definition: fs_security.h:973
objects::PDFDictionary * GetInfo() const
Get the information dictionary.
void SetFileVersion(int version)
Set the PDF file version which will be stored in PDF header section of the saved PDF file.
bool operator !=(const PDFDoc &other) const
Not equal operator.
WString description
Description for payload file to show applications or confront users prompt information.
Definition: fs_pdfdoc.h:223
String GetUserPassword(const String &owner_password)
Get the user password based on owner password.
EmbeddedFontData & operator=(const EmbeddedFontData &other)
Assign operator.
Definition: fs_pdfdoc.h:324
WrapperData GetWrapperData() const
Get wrapper data if current document's wrapper type is PDFDoc::e_WrapperFoxit.
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:236
Encryption type: Foxit DRM encryption.
Definition: fs_pdfdoc.h:422
Import pages normally.
Definition: fs_pdfdoc.h:536
int GetSignatureCount()
Get the count of signature.
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.
Definition: fs_pdfobject.h:55
common::Font GetFont(int index)
Get a font by index.
void ClearRenderCache()
Clear the cache used during rendering, to reduce the memory usage.
Encryption type: password, which is the standard encryption.
Definition: fs_pdfdoc.h:418
bool IsPortfolio()
Check whether current PDF document is a portfolio file or not.
bool RemovePage(int index)
Remove a PDF page by page index.
ReadingBookmark GetReadingBookmark(int index)
Get a reading bookmark by index.
Assemble PDF document. (Bit 11 in permission value)
Definition: fs_pdfdoc.h:480
DisplayMode GetDisplayMode() const
Get the display mode.
When document is opened, optional content group panels are visible.
Definition: fs_pdfdoc.h:598
bool HasLayer() const
Check whether current PDF document has layer (known as "Optional content group" in <PDF reference 1....
PDFPage GetPage(int index)
Get a PDF page by index.
(Reserved, not supported yet) If set, only link annotations are to imported from or exported to XFDF ...
Definition: fs_pdfdoc.h:615
uint64 GetFileSize()
Get file size.
Save document with removing redundant PDF objects.
Definition: fs_pdfdoc.h:526
When document is opened, attachment panels are visible.
Definition: fs_pdfdoc.h:600
DataType
Enumeration for data type used to decide which object(s) will be imported from or exported to FDF/XFD...
Definition: fs_pdfdoc.h:609
If set, form fields are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:611
Definition: fs_security.h:833
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:331
ExtractPagesOptions
Enumeration for options used for extracting pages.
Definition: fs_pdfdoc.h:552
PDFPage InsertPage(int index, float width, float height)
Insert a new blank PDF page to document, by index.
RMSEncryptData GetRMSEncryptData() const
Get encrypt data of RMS encryption.
(Reserved, currently, this value is not used.) Encryption type: Foxit connected PDF DRM encryption.
Definition: fs_pdfdoc.h:428
BYTE STRING CLASS.
Definition: fx_string.h:317
actions::Action GetOpenAction()
Get the action to be performed when the document is opened.
PageBasicInfo(float width, float height, common::Rotation rotation)
Constructor, with parameters.
Definition: fs_pdfdoc.h:240
When document is opened, neither document outlines nor thumbnail images are visible.
Definition: fs_pdfdoc.h:587
Encryption type: Microsoft RMS encryption.
Definition: fs_pdfdoc.h:426
bool MovePagesTo(const common::Range &page_range, int dest_index)
Move one or more pages (specified by index) to a new index position.
bool HasHeaderFooter()
Check whether current document has header-footer.
PageBasicInfo()
Constructor.
Definition: fs_pdfdoc.h:246
Unknown encryption type.
Definition: fs_pdfdoc.h:414
WString type
Wrapper type to indicate a type of the current wrapper file.
Definition: fs_pdfdoc.h:130
Definition: fs_signature.h:93
int GetFirstAvailPageIndex() const
Get the page index of the fist available page.
Definition: fs_security.h:137
WString uri
The URI for consumers to get more information.
Definition: fs_pdfdoc.h:134
Rotation
Enumeration for rotation.
Definition: fs_common.h:344
bool IsUserPassword(const String &password)
Check if input password is the user password of current PDF document.
Unknown rotation.
Definition: fs_common.h:354
When document is opened, document outlines (bookmarks) are visible.
Definition: fs_pdfdoc.h:589
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).
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.
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.
PDFDoc & operator=(const PDFDoc &other)
Assign operator.
Header file for PDF object related definitions and classes.
Definition: fs_pdfdoc.h:230
int GetPageCount() const
Get the count of pages.
Header file for PDF page related definitions and classes.
PayLoadData & operator=(const PayLoadData &payload_data)
Assign operator.
Definition: fs_pdfdoc.h:186
Fill PDF form. (Bit 9 in permission value)
Definition: fs_pdfdoc.h:467
bool SaveAs(const char *file_path, uint32 save_flags=PDFDoc::e_SaveFlagNormal)
Save current PDF document as another PDF file.
CFX_WideString WString
Wide string.
Definition: fs_basictypes.h:221
EncryptType
Enumeration for encryption type.
Definition: fs_pdfdoc.h:412
PageBasicInfo & operator=(const PageBasicInfo &page_info)
Assign operator.
Definition: fs_pdfdoc.h:266
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:73
Foxit namespace.
Definition: fs_compare.h:27
Definition: fs_security.h:56
PayLoadData()
Constructor.
Definition: fs_pdfdoc.h:143
uint32 AddIndirectObject(objects::PDFObject *pdf_object)
Add a PDF object to current PDF document, to be an indirect object.
Definition: fs_bookmark.h:58
void InsertDocument(int dest_index, const PDFDoc &src_doc, uint32 options)
Insert another PDF document to the specified location of current PDF document.
PageBasicInfo GetPageBasicInfo(int index)
Get the basic information of a page specified by index.
void RemoveSignature(const foxit::pdf::Signature &signature)
Remove a signature.
Save document incrementally.
Definition: fs_pdfdoc.h:502
Definition: fs_readingbookmark.h:43
If set, that means attachment files will be extracted as well.
Definition: fs_pdfdoc.h:567
If set, annotations (except link annotations) are to imported from or exported to FDF/XFDF document.
Definition: fs_pdfdoc.h:613
Definition: fx_basic.h:3752
ErrorCode LoadW(const WString &password=WString())
Load current document content by using a specified password.
Encryption type: digital certificate encryption.
Definition: fs_pdfdoc.h:420
Definition: fs_pdfobject.h:763
int GetFontCount()
Count all the PDF fonts used in current PDF document.
void AddHeaderFooter(const HeaderFooter &headerfooter)
Add new header-footer.
bool HasForm() const
Check whether current PDF document has interactive form (also known as AcroForm).
void Set(float width, float height, common::Rotation rotation)
Set value.
Definition: fs_pdfdoc.h:282
Import pages with layers.
Definition: fs_pdfdoc.h:538
Operate text annotations and fill in interactive form fields. (Bit 6 in permission value)
Definition: fs_pdfdoc.h:461
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).
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:204
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:119
If set, that means structure tree will be extracted as well.
Definition: fs_pdfdoc.h:556
ReadingBookmark InsertReadingBookmark(int reading_bookmark_index, const WString &title, int dest_page_index)
Insert a reading bookmark to current PDF document.
PasswordType CheckPassword(const String &password)
Check the type of a specified password.
InsertDocOptions
Enumeration for options used for inserting a PDF document to another.
Definition: fs_pdfdoc.h:575
objects::PDFDictionary * GetTrailer() const
Get the trailer dictionary.
ImportPageFlags
Enumeration for flags used for importing pages.
Definition: fs_pdfdoc.h:534
bool SetOpenAction(actions::Action &action)
Set the action to be performed when the document is opened.
If set, that means annotations related to extracted pages will be extracted as well.
Definition: fs_pdfdoc.h:554
#define NULL
The null-pointer value.
Definition: fx_system.h:767
common::Progressive StartGetPayloadFile(foxit::common::file::WriterCallback *payload_file, common::PauseCallback *pause=0)
Start to get payload file.
WrapperData & operator=(const WrapperData &wrapper_data)
Assign operator.
Definition: fs_pdfdoc.h:99
Save document normally, without using any special flag. This can only be used alone.
Definition: fs_pdfdoc.h:495
Definition: fs_pdfdoc.h:389
WString crypto_filter
The name of the cryptographic filter used to encrypt the encrypted payload document.
Definition: fs_pdfdoc.h:217
WString app_id
Application identity to indicate applications to open this wrapper data.
Definition: fs_pdfdoc.h:132
Definition: fs_pdfpage.h:342
If set, that means to use PDFDoc::e_SaveFlagXRefStream saving flag for the result file in order to re...
Definition: fs_pdfdoc.h:565
EncryptType GetEncryptionType() const
Get the encryption type.
bool IsOwnerPassword(const String &password)
Check if input password is the owner password of current PDF document.
Definition: fs_fdfdoc.h:51
float height
Page height.
Definition: fs_pdfdoc.h:291
Bookmark CreateRootBookmark()
Create new bookmark root node.
Import pages without cloning stream objects into memory.
Definition: fs_pdfdoc.h:544
bool SetSecurityHandler(const SecurityHandler &handler)
Set a PDF security handler for encryption, such as standard encryption(password), certificate encrypt...
Definition: fs_security.h:586
bool IsEncrypted() const
Check whether current document is an encrypted file or not.
float version
The version number of the cryptographic filter used to encrypt the encrypted payload referenced by th...
Definition: fs_pdfdoc.h:215
EmbeddedFontData GetEmbeddedFontData()
Get embedded font data.
Print PDF document with higher qualities. (Bit 12 in permission value)
Definition: fs_pdfdoc.h:486
Definition: fs_basictypes.h:226
WrapperData(const WrapperData &wrapper_data)
Constructor, with another wrapper data object.
Definition: fs_pdfdoc.h:85
int64 file_size
The payload file size.
Definition: fs_pdfdoc.h:221
bool IsWrapper() const
Check whether current document is a wrapper file or not.
Definition: fs_common.h:1418
Encryption type: customized encryption.
Definition: fs_pdfdoc.h:424
An owner password is used in PDF document.
Definition: fs_pdfdoc.h:404
PageBasicInfo(const PageBasicInfo &page_info)
Constructor, with another page basic information object.
Definition: fs_pdfdoc.h:255
Modify PDF contents. (Bit 4 in permission value)
Definition: fs_pdfdoc.h:449
bool IsXFA() const
Check whether current PDF document is an XFA document.
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:296
WrapperType GetWrapperType() const
Get Wrapper type.
CustomEncryptData GetCustomEncryptData() const
Get encrypt data of custom encryption.
CertificateEncryptData GetCertificateEncryptData() const
Get encrypt data of certificate encryption.
Definition: fs_pdfdoc.h:303
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:333
float width
Page width.
Definition: fs_pdfdoc.h:289
PayLoadData(const PayLoadData &payload_data)
Constructor, with another payload data object.
Definition: fs_pdfdoc.h:171
Definition: fs_pdfobject.h:385
objects::PDFDictionary * GetPagesDict() const
Get the dictionary of "Pages".
WIDE STRING CLASS.
Definition: fx_string.h:1452
Header file for bookmark related definitions and classes.
Definition: fs_common.h:1263
Normal document.
Definition: fs_pdfdoc.h:625
DRMEncryptData GetDRMEncryptData() const
Get encrypt data of Foxit DRM encryption.
If set, that means attachments will be inserted to target document as well.
Definition: fs_pdfdoc.h:577
bool IsEmpty() const
Check whether current object is empty or not.
PayLoadData GetPayLoadData()
Get payload data if current document's wrapper type is PDFDoc::e_WrapperPDFV2.
Bookmark GetRootBookmark()
Get bookmark root node.
Header file for reading bookmark related definitions and classes.
void DeleteIndirectObject(uint32 object_number)
Delete an indirect object by indirect object number.
Foxit wrapper document.
Definition: fs_pdfdoc.h:627
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
HeaderFooter GetEditableHeaderFooter()
Get the editable header footer object.
Save document by using XRef stream.
Definition: fs_pdfdoc.h:514
Print PDF document with normal mode. (Bit 3 in permission value)
Definition: fs_pdfdoc.h:442
The password is invalid.
Definition: fs_pdfdoc.h:398
Extract PDF contents. (Bit 5 in permission value)
Definition: fs_pdfdoc.h:455
ErrorCode Load(const String &password="")
Load current document content by using a specified password.
No password is used in PDF document.
Definition: fs_pdfdoc.h:400
FX_UINT64 uint64
Unsigned 64-bit integer.
Definition: fs_basictypes.h:194
Definition: fs_basictypes.h:399
Page size: letter.
Definition: fs_pdfpage.h:422
Disabilities support. (Bit 10 in permission value)
Definition: fs_pdfdoc.h:473
Save document as a linearized file.
Definition: fs_pdfdoc.h:520
PasswordType
Enumeration for the type of current used password in a PDF document.
Definition: fs_pdfdoc.h:396
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....