31 #ifndef _FSPDF_DOCUMENT_R_H_ 32 #define _FSPDF_DOCUMENT_R_H_ 128 #ifndef _FSPDF_DEF_MACRO_PASSWORDTYPE_ 129 #define _FSPDF_DEF_MACRO_PASSWORDTYPE_ 138 #define FSPDF_PASSWORDTYPE_INVALID -1 140 #define FSPDF_PASSWORDTYPE_NOPASSWORD 0 142 #define FSPDF_PASSWORDTYPE_USERPASSWORD 1 144 #define FSPDF_PASSWORDTYPE_OWNERPASSWORD 2 149 #ifndef _FSPDF_DEF_MACRO_ENCRYPTIONTYPE_ 150 #define _FSPDF_DEF_MACRO_ENCRYPTIONTYPE_ 157 #define FSPDF_ENCRYPTTYPE_NOENCRYPT 0 159 #define FSPDF_ENCRYPTTYPE_PASSWORD 1 161 #define FSPDF_ENCRYPTTYPE_CERTIFICATE 2 163 #define FSPDF_ENCRYPTTYPE_FOXITDRM 3 165 #define FSPDF_ENCRYPTTYPE_CUSTOM 4 167 #define FSPDF_ENCRYPTTYPE_RMS 5 172 #ifndef _FSPDF_DEF_MACRO_DISPLAYMODE_ 173 #define _FSPDF_DEF_MACRO_DISPLAYMODE_ 183 #define FSPDF_DISPLAYMODE_USENONE 0 185 #define FSPDF_DISPLAYMODE_USEOUTLINES 1 187 #define FSPDF_DISPLAYMODE_USETHUMBS 2 189 #define FSPDF_DISPLAYMODE_FULLSCREEN 3 191 #define FSPDF_DISPLAYMODE_USEOC 4 193 #define FSPDF_DISPLAYMODE_USEATTACHMENTS 5 198 #ifndef _FSPDF_DEF_MACRO_LOADFLAG_ 199 #define _FSPDF_DEF_MACRO_LOADFLAG_ 210 #define FSPDF_LOADFLAG_NOSTREAMCACHES 0x1 213 #define FSPDF_LOADFLAG_RELEASEFILEHANDLE 0x2 866 #ifndef _FSPDF_DEF_STRUCTURE_ENUMPAGEINFOHANDLER_ 867 #define _FSPDF_DEF_STRUCTURE_ENUMPAGEINFOHANDLER_ 875 typedef struct _FSPDF_ENUMPAGEINFOHANDLER
926 #endif //_FSPDF_DEF_STRUCTURE_ENUMPAGEINFOHANDLER_ 961 #ifndef _FSPDF_DEF_STRUCTURE_WRAPPERDATA_ 962 #define _FSPDF_DEF_STRUCTURE_WRAPPERDATA_ 969 typedef struct _FSPDF_WRAPPERDATA
1206 #ifndef _FSPDF_DEF_STRUCTURE_IDENTITYPROPERTIES_ 1207 #define _FSPDF_DEF_STRUCTURE_IDENTITYPROPERTIES_ 1210 typedef struct _FSPDF_IDENTITYPROPERTIES
1224 #ifndef _FSPDF_DEF_STRUCTURE_MENULIST_ 1225 #define _FSPDF_DEF_STRUCTURE_MENULIST_ 1228 typedef struct _FSPDF_MENULIST
1238 #ifndef _FSPDF_DEF_MACRO_APPINFO_ 1239 #define _FSPDF_DEF_MACRO_APPINFO_ 1246 #define FSPDF_APPINFOTYPE_FORMSVERSION 0x0 1249 #define FSPDF_APPINFOTYPE_VIEWERTYPE 0x1 1252 #define FSPDF_APPINFOTYPE_VIEWERVARIATION 0x2 1255 #define FSPDF_APPINFOTYPE_VIEWERVERSION 0x3 1258 #define FSPDF_APPINFOTYPE_APPVERSION 0x4 1263 #ifndef _FSPDF_DEF_MACRO_MAILTYPE_ 1264 #define _FSPDF_DEF_MACRO_MAILTYPE_ 1271 #define FSPDF_MAILTYPE_DOC 0 1274 #define FSPDF_MAILTYPE_FORM 1 1277 #define FSPDF_MAILTYPE_MSG 2 1282 #ifndef _FSPDF_DEF_HANDLER_JAVASCRIPT_ACTION_ 1283 #define _FSPDF_DEF_HANDLER_JAVASCRIPT_ACTION_ 1291 typedef struct _FSPDF_JAVASCRIPTACTION_HANDLER
1812 #ifndef _FSPDF_DEF_MACRO_PAGELABEL_STYLE_ 1813 #define _FSPDF_DEF_MACRO_PAGELABEL_STYLE_ 1821 #define FSPDF_PAGELABEL_STYLE_None 0 1823 #define FSPDF_PAGELABEL_STYLE_D 1 1825 #define FSPDF_PAGELABEL_STYLE_R 2 1827 #define FSPDF_PAGELABEL_STYLE_r 3 1829 #define FSPDF_PAGELABEL_STYLE_A 4 1831 #define FSPDF_PAGELABEL_STYLE_a 5 2123 #ifndef _FSPDF_DEF_HANDLE_BOOKMARK_ITERATOR_ 2124 #define _FSPDF_DEF_HANDLE_BOOKMARK_ITERATOR_ 2127 FSCRT_DEFINEHANDLE(FSPDF_BOOKMARK_ITERATOR);
2131 #ifndef _FSPDF_DEF_HANDLE_BOOKMARK_POS_ 2132 #define _FSPDF_DEF_HANDLE_BOOKMARK_POS_ 2135 FSCRT_DEFINEHANDLE(FSPDF_BOOKMARKPOS);
2139 #ifndef _FSPDF_DEF_MACRO_BOOKMARKSTATUS_ 2140 #define _FSPDF_DEF_MACRO_BOOKMARKSTATUS_ 2149 #define FSPDF_BOOKMARKSTATUS_NORMAL 0 2151 #define FSPDF_BOOKMARKSTATUS_BOLD 1 2153 #define FSPDF_BOOKMARKSTATUS_ITALIC 2 2159 #define FSPDF_BOOKMARKSTATUS_EXPANDED 4 2164 #ifndef _FSPDF_DEF_MACRO_BOOKMARKPOS_ 2165 #define _FSPDF_DEF_MACRO_BOOKMARKPOS_ 2174 #define FSPDF_BOOKMARKPOS_FIRSTCHILD 0 2176 #define FSPDF_BOOKMARKPOS_LASTCHILD 1 2178 #define FSPDF_BOOKMARKPOS_PREVIOUS 2 2180 #define FSPDF_BOOKMARKPOS_NEXT 3 2182 #define FSPDF_BOOKMARKPOS_FIRSTSIBLING 4 2184 #define FSPDF_BOOKMARKPOS_LASTSIBLING 5 2189 #ifndef _FSPDF_DEF_STRUCTURE_BOOKMARKDATA_ 2190 #define _FSPDF_DEF_STRUCTURE_BOOKMARKDATA_ 2197 typedef struct _FSPDF_BOOKMARKDATA_
2705 #ifndef _FSPDF_DEF_MACRO_READDIREC_ 2706 #define _FSPDF_DEF_MACRO_READDIREC_ 2711 #define FSPDF_READDIRECT_L2R 0 2713 #define FSPDF_READDIRECT_R2L 1 2978 #ifndef _FSPDF_DEF_HANDLE_ATTACHMENTS_ 2979 #define _FSPDF_DEF_HANDLE_ATTACHMENTS_ 2982 FSCRT_DEFINEHANDLE(FSPDF_ATTACHMENTS);
FS_RESULT FSPDF_Doc_IsWrapper(FSCRT_DOCUMENT document, FS_BOOL *isWrapper)
Determine whether the document is a wrapper document or not.
FS_RESULT FSPDF_Bookmark_MoveToRoot(FSPDF_BOOKMARK_ITERATOR iterator)
Move a bookmark iterator to root.
FS_RESULT FSPDF_Doc_SetJavaScriptActionHandler(FSCRT_DOCUMENT document, FSPDF_JAVASCRIPTACTION_HANDLER *actionHandler)
Set the action handler to the PDF document.
FS_RESULT FSPDF_Doc_CreateBookmarkIterator(FSCRT_DOCUMENT document, FSPDF_BOOKMARK_ITERATOR *iterator)
Create an iterator to access bookmark in a document.
FS_RESULT FSPDF_Attachments_CountAttachment(FSPDF_ATTACHMENTS attachments, FS_INT32 *count)
Get the count of attachments.
FS_RESULT FSPDF_ViewerPref_GetAreaType(FSCRT_DOCUMENT document, const FSCRT_BSTR *boxItem, FS_INT32 *boxType)
Get the type of area item from viewer preferences.
FS_RESULT FSPDF_Attachments_Release(FSPDF_ATTACHMENTS attachments)
Release a attachments object.
Structure for identity properties of the current user of the application.
Definition: fpdf_document_r.h:1210
Structure for rectangle, in float.
Definition: fs_base_r.h:2078
FS_RESULT FSPDF_Doc_GetInfoDict(FSCRT_DOCUMENT document, FSPDF_OBJECT *object)
Get the PDF document info object.
float FS_FLOAT
32-bit floating-point number, single precision.
Definition: fs_base_r.h:148
FS_RESULT FSPDF_ViewerPref_GetReadingDirection(FSCRT_DOCUMENT document, FS_INT32 *direction)
Get reading direction from viewer preferences.
FS_RESULT FSPDF_Metadata_GetString(FSCRT_DOCUMENT document, const FSCRT_BSTR *key, FSCRT_BSTR *string)
Get a UTF-8 string value from metadata.
FS_RESULT FSPDF_Bookmark_GetAction(FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32 index, FSPDF_ACTIONDATA *actionData)
Get bookmark action.
FS_RESULT FSPDF_PageLabels_GetRangeInfo(FSCRT_DOCUMENT document, FS_INT32 rangeIndex, FS_INT32 *start, FS_INT32 *style, FSCRT_BSTR *prefix, FS_INT32 *st)
Get information of page labels by a specified range.
FS_RESULT FSPDF_Bookmark_GetPos(FSPDF_BOOKMARK_ITERATOR iterator, FSPDF_BOOKMARKPOS *pos)
Get the bookmark position handle from a bookmark iterator.
Structure for large file size.
Definition: fs_base_r.h:898
FS_RESULT FSPDF_Doc_GetCatalog(FSCRT_DOCUMENT document, FSPDF_OBJECT *object)
Get the PDF document catalog object.
FS_RESULT FSPDF_Doc_GetDisplayMode(FSCRT_DOCUMENT document, FS_INT32 *displayMode)
Get display mode specified in PDF document.
FS_RESULT FSPDF_ViewerPref_GetNonFullScreenPageMode(FSCRT_DOCUMENT document, FS_INT32 *displayMode)
Get display mode for non full-screen mode from viewer preferences.
FS_RESULT FSPDF_Doc_GetWrapperOffset(FSCRT_DOCUMENT document, FSCRT_FILESIZE *offset)
Get wrapper offset.
FS_RESULT FSPDF_PageLabels_CountRanges(FSCRT_DOCUMENT document, FS_INT32 *count)
Get count of ranges of page labels which use different numbering systems.
FS_RESULT FSPDF_WrapperData_Init(FSPDF_WRAPPERDATA *wrapperData)
Helper function to initialize a wrapper data object.
FS_RESULT FSPDF_Doc_GetAction(FSCRT_DOCUMENT document, FS_INT32 trigger, FS_INT32 index, FSPDF_ACTIONDATA *actionData)
Get document trigger action.
FS_RESULT FSPDF_Doc_GetFileVersion(FSCRT_DOCUMENT document, FS_INT32 *version)
Get PDF file version stored in PDF header section.
FS_RESULT FSPDF_Doc_IsModified(FSCRT_DOCUMENT document, FS_BOOL *isModified)
Get PDF document modify mark.
FS_RESULT FSPDF_Bookmark_IsRoot(FSPDF_BOOKMARK_ITERATOR iterator, FS_BOOL *isRoot)
Determine whether a bookmark iterator is root or not.
unsigned int FS_DWORD
32-bit unsigned integer.
Definition: fs_base_r.h:142
FS_RESULT FSPDF_Doc_EnumPagesInfo(FSCRT_DOCUMENT document, FSPDF_ENUMPAGEINFOHANDLER *enumHandler)
Enumerate the information of all PDF pages.
FS_RESULT FSPDF_Doc_StartLoadWithFlag(FSCRT_FILE file, const FSCRT_BSTR *password, FS_DWORD flag, FSCRT_DOCUMENT *document, FSCRT_PROGRESS *progress)
Load a PDF file with the extra flags.
Structure for bookmark data.
Definition: fpdf_document_r.h:2197
FS_RESULT FSPDF_Bookmark_CloneIterator(FSPDF_BOOKMARK_ITERATOR srcIterator, FSPDF_BOOKMARK_ITERATOR *clonedIterator)
Clone an iterator to access bookmark in a document.
FSCRT_BSTR title
Bookmark title, a UTF-8 string object.
Definition: fpdf_document_r.h:2200
FS_RESULT FSPDF_Doc_CountFonts(FSCRT_DOCUMENT document, FS_INT32 *count)
Count all the PDF fonts in the document, this function would enumerate all the font resources for pag...
FS_RESULT FSPDF_Doc_InitiateJavaScript(FSCRT_DOCUMENT document)
Perform the document javascript when document is opened, defining JavaScript functions for use by oth...
FS_RESULT FSPDF_Bookmark_MoveToNextSibling(FSPDF_BOOKMARK_ITERATOR iterator)
Move a bookmark iterator to its next sibling if existing.
FS_LPVOID clientData
User-defined data.
Definition: fpdf_document_r.h:1305
FSCRT_BSTR corporation
The corporation name that the user has entered in the Identity preferences panel. ...
Definition: fpdf_document_r.h:1213
FS_RESULT FSPDF_Doc_PageLabelToPageIndex(FSCRT_DOCUMENT document, FS_BOOL noCase, const FSCRT_BSTR *pageLabel, FS_INT32 *pageIndex)
Convert a page label to page index.
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
FS_RESULT FSPDF_Bookmark_CountActions(FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32 *count)
Get counts of bookmark action.
FS_RESULT FSPDF_Bookmark_MoveToParent(FSPDF_BOOKMARK_ITERATOR iterator)
Move a bookmark iterator to its parent if existing.
FS_RESULT FSPDF_Doc_GetEncryptionParam(FSCRT_DOCUMENT document, const FSCRT_BSTR *key, FSCRT_BSTR *value)
Get encryption parameter value.
Structure for date and time.
Definition: fs_base_r.h:2018
FS_RESULT FSPDF_Doc_StartLoad(FSCRT_FILE file, const FSCRT_BSTR *password, FSCRT_DOCUMENT *document, FSCRT_PROGRESS *progress)
Load a PDF file.
FS_RESULT FSPDF_Doc_GetEncryptionFilter(FSCRT_DOCUMENT document, FSCRT_BSTR *filter)
Get encryption filter value.
FS_RESULT FSPDF_Doc_GetUserPermissions(FSCRT_DOCUMENT document, FS_DWORD *permissions)
Get user permissions specified in PDF document.
Structure for menu list.
Definition: fpdf_document_r.h:1228
FS_RESULT FSPDF_ViewerPref_GetPrintScale(FSCRT_DOCUMENT document, FSCRT_BSTR *printScale)
Get page scaling option from viewer preferences.
FS_LPVOID clientData
User-defined data.
Definition: fpdf_document_r.h:887
FSCRT_BSTR email
The email address that the user has entered in the Identity preferences panel.
Definition: fpdf_document_r.h:1215
FSCRT_BSTR name
The title of menu.
Definition: fpdf_document_r.h:1233
FS_RESULT FSPDF_Doc_ClearCache(FSCRT_DOCUMENT document)
Clear the cache of PDF document(temporarily only for rendering), to reduce the memory usage...
Structure for page information enumeration.
Definition: fpdf_document_r.h:875
FS_RESULT FSPDF_Bookmark_GetData(FSPDF_BOOKMARK_ITERATOR iterator, FSPDF_BOOKMARKDATA *bmData)
Get current bookmark iterator's data which is indicated by parameter iterator.
FS_RESULT FSPDF_BookmarkData_Init(FSPDF_BOOKMARKDATA *bmData)
Helper function to initialize a bookmark data object.
Structure for an action data.
Definition: fpdf_base_r.h:841
FS_RESULT FSPDF_Doc_IsPortfolio(FSCRT_DOCUMENT document, FS_BOOL *isPortfolio)
Whether a document is a portfolio file or not.
FSCRT_BSTR type
Wrapper type to indicate a type of the current wrapper file.
Definition: fpdf_document_r.h:974
FSCRT_BSTR loginName
The login name as registered by the operating system.
Definition: fpdf_document_r.h:1217
FS_RESULT FSPDF_Attachments_GetAttachment(FSPDF_ATTACHMENTS attachments, FS_INT32 index, FSPDF_ATTACHMENT *attachment)
Get a specific attachment.
FS_RESULT FSPDF_Doc_GetJSActionByName(FSCRT_DOCUMENT document, const FSCRT_BSTR *name, FSPDF_ACTIONDATA *actionData)
Get a document JavaScript action by its action name.
FS_RESULT FSPDF_Doc_LoadAttachments(FSCRT_DOCUMENT document, FSPDF_ATTACHMENTS *attachments)
Load all attachments of PDF document.
int FS_BOOL
Boolean type (This should be TRUE or FALSE).
Definition: fs_base_r.h:133
FS_RESULT FSPDF_Doc_GetEncryptDict(FSCRT_DOCUMENT document, FSPDF_OBJECT *object)
Get the PDF document encrypt dictionary.
FS_RESULT FSPDF_Bookmark_IsLastChild(FSPDF_BOOKMARK_ITERATOR iterator, FS_BOOL *isLastChild)
Determine whether a bookmark iterator is the last child of its parent or not.
FSCRT_BSTR description
Description for wrapper file to show applications or confront users prompt information.
Definition: fpdf_document_r.h:980
Structure for action handler information.
Definition: fpdf_document_r.h:1291
FS_RESULT FSPDF_WrapperData_Clear(FSPDF_WRAPPERDATA *wrapperData)
Helper function to clear a wrapper data object.
FS_RESULT FSPDF_Bookmark_ReleaseIterator(FSPDF_BOOKMARK_ITERATOR iterator)
Release a bookmark iterator.
FS_DWORD pageInfoHandleSize
The size of this structure.
Definition: fpdf_document_r.h:880
FS_RESULT FSPDF_ViewerPref_GetPrintCopies(FSCRT_DOCUMENT document, FS_INT32 *copies)
Get the number of copies to be printed.
FS_RESULT FSPDF_Bookmark_HasChild(FSPDF_BOOKMARK_ITERATOR iterator, FS_BOOL *hasChild)
Detect whether a bookmark iterator has a child or not.
void * FS_LPVOID
A pointer to any types.
Definition: fs_base_r.h:127
FSCRT_BSTR name
The user name that the user entered in the Identity preferences panel.
Definition: fpdf_document_r.h:1219
FS_RESULT FSPDF_Doc_PageIndexToPageLabel(FSCRT_DOCUMENT document, FS_INT32 pageIndex, FSCRT_BSTR *pageLabel)
Convert a page index to page label.
FS_RESULT FSPDF_BookmarkData_Clear(FSPDF_BOOKMARKDATA *bmData)
Helper function to clear a bookmark data.
FS_INT32 level
The level of menu.
Definition: fpdf_document_r.h:1231
FSCRT_BSTR uri
URI for consumers to access for more information.
Definition: fpdf_document_r.h:978
FS_DWORD status
Current status of bookmark.
Definition: fpdf_document_r.h:2208
unsigned int FS_ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_base_r.h:145
FS_RESULT FSPDF_Doc_GetTrailer(FSCRT_DOCUMENT document, FSPDF_OBJECT *trailer)
Get the PDF document trailer dictionary.
FSCRT_BSTR appID
Application identity to indicate applications to open this wrapper data.
Definition: fpdf_document_r.h:976
Structure for byte string.
Definition: fs_base_r.h:611
FS_RESULT FSPDF_Doc_CountPages(FSCRT_DOCUMENT document, FS_INT32 *count)
Get page count in document.
FS_RESULT FSPDF_Doc_DoJavaScriptAction(FSCRT_DOCUMENT document, FS_INT32 trigger)
Perform the document javascript which is specified by the trigger.
Structure for wrapper data.
Definition: fpdf_document_r.h:969
FS_RESULT FSPDF_Bookmark_IsFirstChild(FSPDF_BOOKMARK_ITERATOR iterator, FS_BOOL *isFirstChild)
Determine whether a bookmark iterator is the first child of its parent or not.
FS_RESULT FSPDF_Bookmark_MoveToFirstChild(FSPDF_BOOKMARK_ITERATOR iterator)
Move a bookmark iterator to its first child if existing.
FS_DWORD actionHandleSize
The size of this structure.
Definition: fpdf_document_r.h:1298
FS_RESULT FSPDF_Doc_GetPasswordType(FSCRT_DOCUMENT document, FS_INT32 *type)
Get current password type.
Structure for array.
Definition: fs_base_r.h:813
FS_RESULT FSPDF_Bookmark_ReleasePos(FSPDF_BOOKMARKPOS pos)
Release a bookmark position handle.
FS_ARGB color
Color used for displaying title. Format:0xAARRGGBB and alpha component is omitted.
Definition: fpdf_document_r.h:2202
FS_RESULT FSPDF_Doc_GetEncryptionType(FSCRT_DOCUMENT document, FS_INT32 *type)
Get current encryption type.
FS_RESULT FSPDF_Bookmark_MoveToPrevSibling(FSPDF_BOOKMARK_ITERATOR iterator)
Move a bookmark iterator to its previous sibling if existing.
FS_RESULT FSPDF_Doc_StartReLoad(FSCRT_DOCUMENT document, FSCRT_FILE file, const FSCRT_BSTR *password, FSCRT_PROGRESS *progress)
Reload PDF file.
FS_RESULT FSPDF_Doc_GetEncryptionSubFilter(FSCRT_DOCUMENT document, FSCRT_BSTR *subFilter)
Get encryption sub-filter value.
FS_INT32 version
Wrapper version.
Definition: fpdf_document_r.h:972
FS_RESULT FSPDF_Metadata_GetStringArray(FSCRT_DOCUMENT document, const FSCRT_BSTR *key, FSCRT_ARRAY *stringArray)
Get an UTF-8 string array value from metadata.
FS_RESULT FSPDF_ViewerPref_GetUIVisibility(FSCRT_DOCUMENT document, const FSCRT_BSTR *uiItem, FS_BOOL *uiVisible)
Get UI visibility status from viewer preferences.
FS_RESULT FSPDF_Metadata_GetDateTime(FSCRT_DOCUMENT document, const FSCRT_BSTR *key, FSCRT_DATETIMEZONE *dt)
Get a date and time value from metadata.
FS_RESULT FSPDF_Doc_Close(FSCRT_DOCUMENT document)
Close a PDF document.
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160
FS_RESULT FSPDF_Doc_GetFontByIndex(FSCRT_DOCUMENT document, FS_INT32 index, FSCRT_FONT *font)
Get the specific PDF font in the document.
FS_RESULT FSPDF_ViewerPref_GetPrintRanges(FSCRT_DOCUMENT document, FS_INT32 *pageRanges, FS_INT32 *count)
Get page ranges which allowed to print.
FS_RESULT FSPDF_Bookmark_MoveToPos(FSPDF_BOOKMARK_ITERATOR iterator, FSPDF_BOOKMARKPOS newPos)
Move a bookmark iterator to a specific position.
FS_RESULT FSPDF_Doc_CountActions(FSCRT_DOCUMENT document, FS_INT32 trigger, FS_INT32 *count)
Get the count of document trigger actions.
FS_RESULT FSPDF_Doc_GetPage(FSCRT_DOCUMENT document, FS_INT32 index, FSCRT_PAGE *page)
Get a page object.
FS_RESULT FSPDF_Doc_GetWrapperData(FSCRT_DOCUMENT document, FSPDF_WRAPPERDATA *wrapperData)
Get wrapper data.