fpdf_document_r.h

Go to the documentation of this file.

#ifndef _FSPDF_DOCUMENT_R_H_
#define _FSPDF_DOCUMENT_R_H_

#ifdef __cplusplus
extern "C" {
#endif

/*******************************************************************************/
/* Document level macros                                                       */
/*******************************************************************************/
#ifndef _FSPDF_DEF_MACRO_PASSWORDTYPE_
#define _FSPDF_DEF_MACRO_PASSWORDTYPE_

#define         FSPDF_PASSWORDTYPE_INVALID                      -1

#define         FSPDF_PASSWORDTYPE_NOPASSWORD           0

#define         FSPDF_PASSWORDTYPE_USERPASSWORD         1

#define         FSPDF_PASSWORDTYPE_OWNERPASSWORD        2

#endif /* _FSPDF_DEF_MACRO_PASSWORDTYPE_ */

#ifndef _FSPDF_DEF_MACRO_ENCRYPTIONTYPE_
#define _FSPDF_DEF_MACRO_ENCRYPTIONTYPE_

#define         FSPDF_ENCRYPTTYPE_NOENCRYPT             0

#define         FSPDF_ENCRYPTTYPE_PASSWORD              1

#define         FSPDF_ENCRYPTTYPE_CERTIFICATE   2

#define         FSPDF_ENCRYPTTYPE_FOXITDRM              3

#define         FSPDF_ENCRYPTTYPE_CUSTOM                4

#define         FSPDF_ENCRYPTTYPE_RMS                   5

#endif /* _FSPDF_DEF_MACRO_ENCRYPTIONTYPE_ */

#ifndef _FSPDF_DEF_MACRO_DISPLAYMODE_
#define _FSPDF_DEF_MACRO_DISPLAYMODE_

#define         FSPDF_DISPLAYMODE_USENONE                       0

#define         FSPDF_DISPLAYMODE_USEOUTLINES           1

#define         FSPDF_DISPLAYMODE_USETHUMBS                     2

#define         FSPDF_DISPLAYMODE_FULLSCREEN            3

#define         FSPDF_DISPLAYMODE_USEOC                         4

#define         FSPDF_DISPLAYMODE_USEATTACHMENTS        5

#endif /* _FSPDF_DEF_MACRO_DISPLAYMODE_ */

#ifndef _FSPDF_DEF_MACRO_LOADFLAG_
#define _FSPDF_DEF_MACRO_LOADFLAG_

#define FSPDF_LOADFLAG_NOSTREAMCACHES           0x1

#define FSPDF_LOADFLAG_RELEASEFILEHANDLE        0x2

#endif /* _FSPDF_DEF_MACRO_LOADFLAG_ */

/*******************************************************************************/
/* Metadata key category macros                                                */
/*******************************************************************************/
#ifndef _FSPDF_DEF_MACRO_METADATAKEYTYPE_
#define _FSPDF_DEF_MACRO_METADATAKEYTYPE_

#define         FSPDF_METADATAKEYCATEGORY_ALL                                   0

#define         FSPDF_METADATAKEYCATEGORY_STANDARD                              1

#define         FSPDF_METADATAKEYCATEGORY_CUSTOM                                2

#endif /* _FSPDF_DEF_MACRO_METADATAKEYTYPE_ */

/*******************************************************************************/
/* PDF document load or reload                                                 */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_StartLoad(FSCRT_FILE file, const FSCRT_BSTR* password, FSCRT_DOCUMENT* document, FSCRT_PROGRESS* progress);

FS_RESULT       FSPDF_Doc_StartLoadWithFlag(FSCRT_FILE file, const FSCRT_BSTR* password, FS_DWORD flag, FSCRT_DOCUMENT* document, FSCRT_PROGRESS* progress);

FS_RESULT       FSPDF_Doc_StartReLoad(FSCRT_DOCUMENT document, FSCRT_FILE file, const FSCRT_BSTR* password, FSCRT_PROGRESS* progress);

FS_RESULT       FSPDF_Doc_Close(FSCRT_DOCUMENT document);

/*******************************************************************************/
/* Document objects                                                            */
/*                                                                             */
/* Catalog, trailer, encrypt and document info dictionary                      */
/*******************************************************************************/
FS_RESULT FSPDF_Doc_GetCatalog(FSCRT_DOCUMENT document, FSPDF_OBJECT* object);

FS_RESULT FSPDF_Doc_GetTrailer(FSCRT_DOCUMENT document, FSPDF_OBJECT* trailer);

FS_RESULT FSPDF_Doc_GetInfoDict(FSCRT_DOCUMENT document, FSPDF_OBJECT* object);

FS_RESULT FSPDF_Doc_GetEncryptDict(FSCRT_DOCUMENT document, FSPDF_OBJECT* object);

/*******************************************************************************/
/* Access PDF document properties                                              */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_GetPasswordType(FSCRT_DOCUMENT document, FS_INT32* type);

FS_RESULT       FSPDF_Doc_GetEncryptionType(FSCRT_DOCUMENT document, FS_INT32* type);

FS_RESULT       FSPDF_Doc_GetEncryptionFilter(FSCRT_DOCUMENT document, FSCRT_BSTR* filter);

FS_RESULT       FSPDF_Doc_GetEncryptionSubFilter(FSCRT_DOCUMENT document, FSCRT_BSTR* subFilter);

FS_RESULT       FSPDF_Doc_GetEncryptionParam(FSCRT_DOCUMENT document, const FSCRT_BSTR* key, FSCRT_BSTR* value);

FS_RESULT       FSPDF_Doc_GetUserPermissions(FSCRT_DOCUMENT document, FS_DWORD* permissions);

FS_RESULT       FSPDF_Doc_GetDisplayMode(FSCRT_DOCUMENT document, FS_INT32* displayMode);

FS_RESULT       FSPDF_Doc_GetFileVersion(FSCRT_DOCUMENT document, FS_INT32* version);

FS_RESULT       FSPDF_Doc_IsModified(FSCRT_DOCUMENT document, FS_BOOL* isModified);

FS_RESULT       FSPDF_Doc_IsPortfolio(FSCRT_DOCUMENT document, FS_BOOL* isPortfolio);

/*******************************************************************************/
/* Get PDF page object                                                         */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_CountPages(FSCRT_DOCUMENT document, FS_INT32* count);

FS_RESULT       FSPDF_Doc_GetPage(FSCRT_DOCUMENT document, FS_INT32 index, FSCRT_PAGE* page);

#ifndef _FSPDF_DEF_STRUCTURE_ENUMPAGEINFOHANDLER_
#define _FSPDF_DEF_STRUCTURE_ENUMPAGEINFOHANDLER_

typedef struct _FSPDF_ENUMPAGEINFOHANDLER
{
        FS_DWORD        pageInfoHandleSize;

        FS_LPVOID       clientData;

        /*
         * @brief       Enumerate page size for each PDF page.
         *
         * @details     Foxit SDK calls this function to enumerate page size for each page, and the application can get page size quickly 
         *                      from the parameter <i>pageWidth</i> and <i>pageHeight</i>, with <i>pageIndex</i> in this callback function.<br>
         *                      Application is not suggested to call any API of Foxit SDK inside this callback function since it may reduce the speed of enumerating all page size.
         *
         * @param[in]   clientData              Pointer to user-defined data.
         * @param[in]   pageIndex               Index of a PDF page, starting from 0.
         * @param[in]   pageWidth               Width of a PDF page.
         * @param[in]   pageHeight              Height of a PDF page.
         *
         * @return      ::FSCRT_ERRCODE_SUCCESS for success.<br>
         *                      ::FSCRT_ERRCODE_UNRECOVERABLE if function finds an unrecoverable error internally.<br>
         *                      For more error codes, please refer to macro definitions {@link FSCRT_ERRCODE_SUCCESS FSCRT_ERRCODE_XXX}.
         */
        FS_RESULT       (*EnumPageSize)(FS_LPVOID clientData, FS_INT32 pageIndex, FS_FLOAT pageWidth, FS_FLOAT pageHeight);

        /*
         * @brief       Enumerate page rotation for each PDF page.
         *
         * @details     Foxit SDK calls this function to enumerate page rotation for each page, and the application can get page rotation quickly 
         *                      from the parameter <i>pageRotation</i>, with <i>pageIndex</i> in this callback function.<br>
         *                      Application is not suggested to call any API of Foxit SDK inside this callback function since it may reduce the speed of enumerating all page rotations.
         *
         * @param[in]   clientData              Pointer to user-defined data.
         * @param[in]   pageIndex               Index of a PDF page, starting from 0.
         * @param[in]   pageRotation    Rotation of a PDF page.
         *                                                              Please refer to macro definitions {@link FSCRT_PAGEROTATION_0 FSCRT_PAGEROTATION_XXX} and this should be one of these macros.
         *
         * @return      ::FSCRT_ERRCODE_SUCCESS for success.<br>
         *                      ::FSCRT_ERRCODE_UNRECOVERABLE if function finds an unrecoverable error internally.<br>
         *                      For more error codes, please refer to macro definitions {@link FSCRT_ERRCODE_SUCCESS FSCRT_ERRCODE_XXX}.
         */
        FS_RESULT       (*EnumPageRotation)(FS_LPVOID clientData, FS_INT32 pageIndex, FS_INT32 pageRotation);
}FSPDF_ENUMPAGEINFOHANDLER;

#endif //_FSPDF_DEF_STRUCTURE_ENUMPAGEINFOHANDLER_

FS_RESULT FSPDF_Doc_EnumPagesInfo(FSCRT_DOCUMENT document, FSPDF_ENUMPAGEINFOHANDLER* enumHandler);

/*******************************************************************************/
/* Access PDF Wrapper                                                          */
/*******************************************************************************/
#ifndef _FSPDF_DEF_STRUCTURE_WRAPPERDATA_
#define _FSPDF_DEF_STRUCTURE_WRAPPERDATA_

typedef struct _FSPDF_WRAPPERDATA
{
        FS_INT32                version;
        FSCRT_BSTR              type;
        FSCRT_BSTR              appID;
        FSCRT_BSTR              uri;
        FSCRT_BSTR              description;

}FSPDF_WRAPPERDATA;

#endif /* _FSPDF_DEF_STRUCTURE_WRAPPERDATA_ */

FS_RESULT       FSPDF_WrapperData_Init(FSPDF_WRAPPERDATA* wrapperData);

FS_RESULT       FSPDF_WrapperData_Clear(FSPDF_WRAPPERDATA* wrapperData);

FS_RESULT       FSPDF_Doc_IsWrapper(FSCRT_DOCUMENT document, FS_BOOL* isWrapper);

FS_RESULT       FSPDF_Doc_GetWrapperOffset(FSCRT_DOCUMENT document, FSCRT_FILESIZE* offset);

FS_RESULT       FSPDF_Doc_GetWrapperData(FSCRT_DOCUMENT document, FSPDF_WRAPPERDATA* wrapperData);


/*******************************************************************************/
/* Document trigger actions                                                    */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_CountActions(FSCRT_DOCUMENT document, FS_INT32 trigger, FS_INT32* count);

FS_RESULT       FSPDF_Doc_GetAction(FSCRT_DOCUMENT document, FS_INT32 trigger, FS_INT32 index, FSPDF_ACTIONDATA* actionData);


/*******************************************************************************/
/* PDF action handler                                                          */
/*******************************************************************************/

#ifndef _FSPDF_DEF_STRUCTURE_IDENTITYPROPERTIES_
#define _FSPDF_DEF_STRUCTURE_IDENTITYPROPERTIES_

typedef struct _FSPDF_IDENTITYPROPERTIES
{
        FSCRT_BSTR corporation;
        FSCRT_BSTR email;
        FSCRT_BSTR loginName;
        FSCRT_BSTR name;
} FSPDF_IDENTITYPROPERTIES;

#endif /* _FSPDF_IDENTITYPROPERTIES */

#ifndef _FSPDF_DEF_STRUCTURE_MENULIST_
#define _FSPDF_DEF_STRUCTURE_MENULIST_

typedef struct _FSPDF_MENULIST
{
        FS_INT32 level;
        FSCRT_BSTR name;
}FSPDF_MENULIST;

#endif /* _FSPDF_MENULIST */

#ifndef _FSPDF_DEF_MACRO_APPINFO_
#define _FSPDF_DEF_MACRO_APPINFO_

#define FSPDF_APPINFOTYPE_FORMSVERSION          0x0

#define FSPDF_APPINFOTYPE_VIEWERTYPE            0x1

#define FSPDF_APPINFOTYPE_VIEWERVARIATION       0x2

#define FSPDF_APPINFOTYPE_VIEWERVERSION         0x3

#define FSPDF_APPINFOTYPE_APPVERSION            0x4

#endif /* _FSPDF_DEF_MACRO_APPINFO_ */

#ifndef _FSPDF_DEF_MACRO_MAILTYPE_
#define _FSPDF_DEF_MACRO_MAILTYPE_

#define FSPDF_MAILTYPE_DOC      0

#define FSPDF_MAILTYPE_FORM     1

#define FSPDF_MAILTYPE_MSG      2

#endif /* _FSPDF_DEF_MACRO_MAILTYPE_ */

#ifndef _FSPDF_DEF_HANDLER_JAVASCRIPT_ACTION_
#define _FSPDF_DEF_HANDLER_JAVASCRIPT_ACTION_

typedef struct _FSPDF_JAVASCRIPTACTION_HANDLER
{
        FS_DWORD        actionHandleSize;

        FS_LPVOID       clientData;

        FS_RESULT       (*Release)(FS_LPVOID clientData);

        FS_RESULT       (*InvalidateRect)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_INT32 pageIndex, FSCRT_RECTF* pdfRect);

        FS_RESULT       (*GetCurrentPageIndex)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_INT32* pageIndex);
 
        FS_RESULT       (*SetCurrentPageIndex)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_INT32 pageIndex);

        FS_RESULT       (*GetRotation)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_INT32 pageIndex, FS_INT32* rotation);
         
        FS_RESULT       (*ExecuteNamedAction)(FS_LPVOID clientData, FSCRT_DOCUMENT document, const FSCRT_BSTR* namedAction);

        FS_RESULT       (*SetChangeMark)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_BOOL changeMark);

        FS_RESULT       (*GetChangeMark)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_BOOL* changeMark);
        
        FS_RESULT       (*GetOpenedDocs)(FS_LPVOID clientData, FSCRT_DOCUMENT* docs, FS_INT32* count);
        
        FS_RESULT       (*Alert)(FS_LPVOID clientData, const FSCRT_BSTR* msg, const FSCRT_BSTR* title, FS_INT32 type, FS_INT32 icon, FS_INT32* retCode);
        
        FS_RESULT       (*Beep)(FS_LPVOID clientData, FS_INT32 type);
        
        FS_RESULT       (*Response)(FS_LPVOID clientData, const FSCRT_BSTR* question, const FSCRT_BSTR* title, const FSCRT_BSTR* defaultValue, 
                                                        const FSCRT_BSTR* label, FS_BOOL isPassword, FSCRT_BSTR* response);
        
        FS_RESULT       (*GetFilePath)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FSCRT_BSTR* filePath);
        
        FS_RESULT       (*Mail)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_BOOL bUI, const FSCRT_BSTR* To, 
                                            const FSCRT_BSTR* Subject, const FSCRT_BSTR* CC, const FSCRT_BSTR* BCC, const FSCRT_BSTR* Msg); 

        FS_RESULT       (*Print)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_BOOL isUI, FS_INT32 start, FS_INT32 end, FS_BOOL isSilent ,
                                             FS_BOOL isShrinkToFit, FS_BOOL isPrintAsImage, FS_BOOL isReverse, FS_BOOL isAnnotations);

        FS_RESULT       (*SubmitForm)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_LPVOID formData, FS_DWORD length, const FSCRT_BSTR* URL);
        
        FS_RESULT       (*LaunchURL)(FS_LPVOID clientData, const FSCRT_BSTR* URL); 

        FS_RESULT       (*BrowseFile)(FS_LPVOID clientData, FSCRT_BSTR* filePath);

        FS_RESULT       (*GetLanguage)(FS_LPVOID clientData, FS_INT32* language);

        /*
         * @brief       Optional callback function to get identity properties of the current user.
         *
         * @param[in]   clientData                      The user-supplied data.
         * @param[out]  identityProperties      Pointer to a ::FSPDF_IDENTITYPROPERTIES structure that receives the identity properties.
         *
         * @return      ::FSCRT_ERRCODE_SUCCESS for success.<br>
         *                      For more error codes, please refer to macro definitions {@link FSCRT_ERRCODE_SUCCESS FSCRT_ERRCODE_XXX}.
         */
        FS_RESULT       (*GetIdentityProperties)(FS_LPVOID clientData, FSPDF_IDENTITYPROPERTIES* identityProperties);

        FS_RESULT       (*PopupMenu)(FS_LPVOID clientData, const FSPDF_MENULIST* menus, FS_INT32 count, FSCRT_BSTR* seletedMenu);

        FS_RESULT       (*GetAppInfo)(FS_LPVOID clientData, FS_INT32 type, FSCRT_BSTR* info);

        FS_RESULT       (*MailData)(FS_LPVOID clientData, FS_LPVOID data, FS_DWORD dataType, FS_BOOL bUI, const FSCRT_BSTR* To, 
                const FSCRT_BSTR* Subject, const FSCRT_BSTR* CC, const FSCRT_BSTR* BCC, const FSCRT_BSTR* Msg); 

} FSPDF_JAVASCRIPTACTION_HANDLER;

#endif /* _FSPDF_DEF_HANDLER_JAVASCRIPT_ACTION_ */

FS_RESULT       FSPDF_Doc_SetJavaScriptActionHandler(FSCRT_DOCUMENT document, FSPDF_JAVASCRIPTACTION_HANDLER* actionHandler);

FS_RESULT       FSPDF_Doc_InitiateJavaScript(FSCRT_DOCUMENT document);

FS_RESULT       FSPDF_Doc_DoJavaScriptAction(FSCRT_DOCUMENT document, FS_INT32 trigger);

FS_RESULT       FSPDF_Doc_GetJSActionByName(FSCRT_DOCUMENT document, const FSCRT_BSTR* name, FSPDF_ACTIONDATA* actionData);

/*******************************************************************************/
/* PDF page label                                                              */
/*******************************************************************************/

#ifndef _FSPDF_DEF_MACRO_PAGELABEL_STYLE_
#define _FSPDF_DEF_MACRO_PAGELABEL_STYLE_

#define         FSPDF_PAGELABEL_STYLE_None              0

#define         FSPDF_PAGELABEL_STYLE_D                 1

#define         FSPDF_PAGELABEL_STYLE_R                 2

#define         FSPDF_PAGELABEL_STYLE_r                 3

#define         FSPDF_PAGELABEL_STYLE_A                 4

#define         FSPDF_PAGELABEL_STYLE_a                 5

#endif /* _FSPDF_DEF_MACRO_PAGELABEL_STYLE_ */

FS_RESULT       FSPDF_Doc_PageLabelToPageIndex(FSCRT_DOCUMENT document, FS_BOOL noCase, const FSCRT_BSTR* pageLabel, FS_INT32* pageIndex);

FS_RESULT       FSPDF_Doc_PageIndexToPageLabel(FSCRT_DOCUMENT document, FS_INT32 pageIndex, FSCRT_BSTR* pageLabel);

FS_RESULT       FSPDF_PageLabels_CountRanges(FSCRT_DOCUMENT document, FS_INT32* count);

FS_RESULT       FSPDF_PageLabels_GetRangeInfo(FSCRT_DOCUMENT document, FS_INT32 rangeIndex, FS_INT32* start, FS_INT32* style, FSCRT_BSTR* prefix, FS_INT32* st);

/*******************************************************************************/
/* Access PDF metadata                                                         */
/*******************************************************************************/
FS_RESULT       FSPDF_Metadata_GetString(FSCRT_DOCUMENT document, const FSCRT_BSTR* key, FSCRT_BSTR* string);

FS_RESULT       FSPDF_Metadata_GetStringArray(FSCRT_DOCUMENT document, const FSCRT_BSTR* key, FSCRT_ARRAY* stringArray);

FS_RESULT       FSPDF_Metadata_GetDateTime(FSCRT_DOCUMENT document, const FSCRT_BSTR* key, FSCRT_DATETIMEZONE* dt);

FS_RESULT   FSPDF_Metadata_GetKeys(FSCRT_DOCUMENT document, FS_INT32 filter, FSCRT_ARRAY* keyArray);

/*******************************************************************************/
/* Access PDF bookmarks                                                        */
/*******************************************************************************/
#ifndef _FSPDF_DEF_HANDLE_BOOKMARK_ITERATOR_
#define _FSPDF_DEF_HANDLE_BOOKMARK_ITERATOR_

FSCRT_DEFINEHANDLE(FSPDF_BOOKMARK_ITERATOR);

#endif /* _FSPDF_DEF_HANDLE_BOOKMARK_ITERATOR_ */

#ifndef _FSPDF_DEF_HANDLE_BOOKMARK_POS_
#define _FSPDF_DEF_HANDLE_BOOKMARK_POS_

FSCRT_DEFINEHANDLE(FSPDF_BOOKMARKPOS);

#endif /* _FSPDF_DEF_HANDLE_BOOKMARK_POS_ */

#ifndef _FSPDF_DEF_MACRO_BOOKMARKSTATUS_
#define _FSPDF_DEF_MACRO_BOOKMARKSTATUS_

#define FSPDF_BOOKMARKSTATUS_NORMAL                     0

#define FSPDF_BOOKMARKSTATUS_BOLD                       1

#define FSPDF_BOOKMARKSTATUS_ITALIC                     2

#define FSPDF_BOOKMARKSTATUS_EXPANDED           4

#endif /* _FSPDF_DEF_MACRO_BOOKMARKSTATUS_ */

#ifndef _FSPDF_DEF_MACRO_BOOKMARKPOS_
#define _FSPDF_DEF_MACRO_BOOKMARKPOS_

#define FSPDF_BOOKMARKPOS_FIRSTCHILD            0

#define FSPDF_BOOKMARKPOS_LASTCHILD                     1

#define FSPDF_BOOKMARKPOS_PREVIOUS                      2

#define FSPDF_BOOKMARKPOS_NEXT                          3

#define FSPDF_BOOKMARKPOS_FIRSTSIBLING          4

#define FSPDF_BOOKMARKPOS_LASTSIBLING           5

#endif /* _FSPDF_DEF_MACRO_BOOKMARKPOS_ */

#ifndef _FSPDF_DEF_STRUCTURE_BOOKMARKDATA_
#define _FSPDF_DEF_STRUCTURE_BOOKMARKDATA_

typedef struct _FSPDF_BOOKMARKDATA_
{
        FSCRT_BSTR              title;
        FS_ARGB                 color;
        FS_DWORD                status;
} FSPDF_BOOKMARKDATA;

#endif /* _FSPDF_DEF_STRUCTURE_BOOKMARKDATA_ */

FS_RESULT       FSPDF_BookmarkData_Init(FSPDF_BOOKMARKDATA* bmData);

FS_RESULT       FSPDF_BookmarkData_Clear(FSPDF_BOOKMARKDATA* bmData);

FS_RESULT       FSPDF_Doc_CreateBookmarkIterator(FSCRT_DOCUMENT document, FSPDF_BOOKMARK_ITERATOR* iterator);

FS_RESULT       FSPDF_Bookmark_GetPos(FSPDF_BOOKMARK_ITERATOR iterator, FSPDF_BOOKMARKPOS* pos);

FS_RESULT       FSPDF_Bookmark_CloneIterator(FSPDF_BOOKMARK_ITERATOR srcIterator, FSPDF_BOOKMARK_ITERATOR* clonedIterator);

FS_RESULT       FSPDF_Bookmark_ReleaseIterator(FSPDF_BOOKMARK_ITERATOR iterator);

FS_RESULT       FSPDF_Bookmark_ReleasePos(FSPDF_BOOKMARKPOS pos);

FS_RESULT       FSPDF_Bookmark_MoveToRoot(FSPDF_BOOKMARK_ITERATOR iterator);

FS_RESULT       FSPDF_Bookmark_IsRoot(FSPDF_BOOKMARK_ITERATOR iterator, FS_BOOL* isRoot);

FS_RESULT       FSPDF_Bookmark_MoveToParent(FSPDF_BOOKMARK_ITERATOR iterator);

FS_RESULT       FSPDF_Bookmark_MoveToFirstChild(FSPDF_BOOKMARK_ITERATOR iterator);

FS_RESULT       FSPDF_Bookmark_MoveToNextSibling(FSPDF_BOOKMARK_ITERATOR iterator);

FS_RESULT       FSPDF_Bookmark_MoveToPrevSibling(FSPDF_BOOKMARK_ITERATOR iterator);

FS_RESULT       FSPDF_Bookmark_MoveToPos(FSPDF_BOOKMARK_ITERATOR iterator, FSPDF_BOOKMARKPOS newPos);

FS_RESULT       FSPDF_Bookmark_HasChild(FSPDF_BOOKMARK_ITERATOR iterator, FS_BOOL* hasChild);

FS_RESULT       FSPDF_Bookmark_IsFirstChild(FSPDF_BOOKMARK_ITERATOR iterator, FS_BOOL* isFirstChild);

FS_RESULT       FSPDF_Bookmark_IsLastChild(FSPDF_BOOKMARK_ITERATOR iterator, FS_BOOL* isLastChild);

FS_RESULT       FSPDF_Bookmark_GetData(FSPDF_BOOKMARK_ITERATOR iterator, FSPDF_BOOKMARKDATA* bmData);

FS_RESULT       FSPDF_Bookmark_CountActions(FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32* count);

FS_RESULT       FSPDF_Bookmark_GetAction(FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32 index, FSPDF_ACTIONDATA* actionData);

/*******************************************************************************/
/* Access PDF viewer preferences                                               */
/*******************************************************************************/
#ifndef _FSPDF_DEF_MACRO_READDIREC_
#define _FSPDF_DEF_MACRO_READDIREC_

#define         FSPDF_READDIRECT_L2R                    0

#define         FSPDF_READDIRECT_R2L                    1

#endif /* _FSPDF_DEF_MACRO_READDIREC_ */

FS_RESULT       FSPDF_ViewerPref_GetUIVisibility(FSCRT_DOCUMENT document, const FSCRT_BSTR* uiItem, FS_BOOL* uiVisible);

FS_RESULT       FSPDF_ViewerPref_GetNonFullScreenPageMode(FSCRT_DOCUMENT document, FS_INT32* displayMode);

FS_RESULT       FSPDF_ViewerPref_GetReadingDirection(FSCRT_DOCUMENT document, FS_INT32* direction);

FS_RESULT       FSPDF_ViewerPref_GetAreaType(FSCRT_DOCUMENT document, const FSCRT_BSTR* boxItem, FS_INT32* boxType);

FS_RESULT       FSPDF_ViewerPref_GetPrintScale(FSCRT_DOCUMENT document, FSCRT_BSTR* printScale);

FS_RESULT       FSPDF_ViewerPref_GetPrintCopies(FSCRT_DOCUMENT document, FS_INT32* copies);

FS_RESULT       FSPDF_ViewerPref_GetPrintRanges(FSCRT_DOCUMENT document, FS_INT32* pageRanges, FS_INT32* count);

/*******************************************************************************/
/* PDF attachments                                                             */
/*******************************************************************************/
#ifndef _FSPDF_DEF_HANDLE_ATTACHMENTS_
#define _FSPDF_DEF_HANDLE_ATTACHMENTS_

FSCRT_DEFINEHANDLE(FSPDF_ATTACHMENTS);

#endif /* _FSPDF_DEF_HANDLE_ATTACHMENTS_ */

FS_RESULT       FSPDF_Doc_LoadAttachments(FSCRT_DOCUMENT document, FSPDF_ATTACHMENTS* attachments);

FS_RESULT       FSPDF_Attachments_Release(FSPDF_ATTACHMENTS attachments);

FS_RESULT       FSPDF_Attachments_CountAttachment(FSPDF_ATTACHMENTS attachments, FS_INT32* count);

FS_RESULT       FSPDF_Attachments_GetAttachment(FSPDF_ATTACHMENTS attachments, FS_INT32 index, FSPDF_ATTACHMENT* attachment);

/*******************************************************************************/
/* PDF Fonts                                                                   */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_CountFonts(FSCRT_DOCUMENT document, FS_INT32* count);

FS_RESULT FSPDF_Doc_GetFontByIndex(FSCRT_DOCUMENT document, FS_INT32 index, FSCRT_FONT* font);

/*******************************************************************************/
/* Memory optimition                                                           */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_ClearCache(FSCRT_DOCUMENT document);


#ifdef __cplusplus
};
#endif
 /* group FPDFDOCUMENT */

#endif /* _FSPDF_DOCUMENT_R_H_ */