fpdf_document_w.h

Go to the documentation of this file.

#ifndef _FSPDF_DOCUMENT_W_H_
#define _FSPDF_DOCUMENT_W_H_

#ifdef __cplusplus
extern "C" {
#endif

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

#define         FSPDF_SAVEFLAG_INCREMENTAL                      0x1

#define         FSPDF_SAVEFLAG_NOORIGINAL                       0x2

#define         FSPDF_SAVEFLAG_REMOVESECURITY           0x4

#define         FSPDF_SAVEFLAG_OBJECTSTREAM                     0x8

#define         FSPDF_SAVEFLAG_OPTIMIZE                         0x10

#define         FSPDF_SAVEFLAG_INCREMENTONLY            0x20

#define         FSPDF_SAVEFLAG_LINEARIZED                       0x40

#endif /* _FSPDF_DEF_MACRO_SAVEAS_ */

#ifndef _FSPDF_DEF_MACRO_IMPORTFLAG_
#define _FSPDF_DEF_MACRO_IMPORTFLAG_

#define       FSPDF_IMPORTFLAG_NORMAL                   0x00

#define       FSPDF_IMPORTFLAG_WITHLAYERS               0x01

#define       FSPDF_IMPORTFLAG_SHARESTREAM              0x02

#endif /* _FSPDF_DEF_MACRO_IMPORTFLAG_ */



/*******************************************************************************/
/* Create PDF document or import pages from another one                        */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_Create(FSCRT_DOCUMENT* document);

FS_RESULT       FSPDF_Doc_StartImportPages(FSCRT_DOCUMENT dstDoc, FS_INT32 startIndex,
                                                                           FSCRT_DOCUMENT srcDoc, const FS_INT32* pageRanges, FS_INT32 count,
                                                                           FSCRT_PROGRESS* importProgress);

FS_RESULT       FSPDF_Doc_StartImportPagesWithLayers(FSCRT_DOCUMENT dstDoc, FS_INT32 startIndex,
                                                                                                 FSCRT_DOCUMENT srcDoc, const FSCRT_BSTR* layerName, const FS_INT32* pageRanges, FS_INT32 count, 
                                                                                                 FSCRT_PROGRESS* importProgress);

FS_RESULT       FSPDF_Doc_StartImportPagesFromFileName(FSCRT_DOCUMENT dstDoc, FS_INT32 startIndex,
                                                                                                                const FSCRT_BSTR* srcFileName, const FSCRT_BSTR* password,
                                                                                                                const FSCRT_BSTR* layerName, const FS_INT32* pageRanges, FS_INT32 count, 
                                                                                                                FS_INT32 flags, FSCRT_PROGRESS* importProgress);

/*******************************************************************************/
/* Save PDF document                                                           */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_StartSaveToFile(FSCRT_DOCUMENT document, FSCRT_FILE file, FS_INT32 flag, FSCRT_PROGRESS* saveProgress);

FS_RESULT       FSPDF_Doc_SaveAsWrapperFile(FSCRT_DOCUMENT wrapperDoc, FSCRT_FILE file, const FSPDF_WRAPPERDATA* wrapperData, 
                                                                                FS_DWORD userPermissions, const FSCRT_BSTR* ownerPassword);

/*******************************************************************************/
/* Document trigger actions                                                    */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_SetAction(FSCRT_DOCUMENT document, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA* actionData);

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

FS_RESULT       FSPDF_Doc_RemoveAction(FSCRT_DOCUMENT document, FS_INT32 trigger, FS_INT32 index);

FS_RESULT       FSPDF_Doc_RemoveAllActions(FSCRT_DOCUMENT document, FS_INT32 trigger);

FS_RESULT       FSPDF_Doc_RemoveJSActionByName(FSCRT_DOCUMENT document, const FSCRT_BSTR *name);

FS_RESULT       FSPDF_Doc_SetFileVersion(FSCRT_DOCUMENT document, FS_INT32 version);

FS_RESULT       FSPDF_Doc_SetDisplayMode(FSCRT_DOCUMENT document, FS_INT32 displayMode);

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

FS_RESULT       FSPDF_PageLabels_SetRangeInfo(FSCRT_DOCUMENT document, FS_INT32 start, FS_INT32 style, const FSCRT_BSTR* prefix, FS_INT32 st);

FS_RESULT       FSPDF_PageLabels_RemoveAll(FSCRT_DOCUMENT document);

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

FS_RESULT       FSPDF_Metadata_SetStringArray(FSCRT_DOCUMENT document, const FSCRT_BSTR* key, const FSCRT_BSTR* stringArray, const FS_INT32 count);

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

FS_RESULT   FSPDF_Metadata_DeleteKey(FSCRT_DOCUMENT document, const FSCRT_BSTR* key);

/*******************************************************************************/
/* Access PDF bookmarks                                                        */
/*******************************************************************************/
FS_RESULT       FSPDF_Bookmark_SetData(FSPDF_BOOKMARK_ITERATOR iterator, const FSPDF_BOOKMARKDATA* bmData);

FS_RESULT       FSPDF_Bookmark_Insert(FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32 pos, const FSPDF_BOOKMARKDATA* bmData);

FS_RESULT       FSPDF_Bookmark_InsertAtPos(FSPDF_BOOKMARK_ITERATOR iterator, FSPDF_BOOKMARKPOS newParentPos, FS_INT32 childIndex);

FS_RESULT       FSPDF_Bookmark_Remove(FSPDF_BOOKMARK_ITERATOR iterator);

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

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

FS_RESULT       FSPDF_Bookmark_RemoveAction(FSPDF_BOOKMARK_ITERATOR iterator, FS_INT32 index);

FS_RESULT       FSPDF_Bookmark_RemoveAllActions(FSPDF_BOOKMARK_ITERATOR iterator);

FS_RESULT       FSPDF_Bookmark_Update(FSPDF_BOOKMARK_ITERATOR iterator);

/*******************************************************************************/
/* Access PDF viewer preferences                                               */
/*******************************************************************************/

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

FS_RESULT       FSPDF_ViewerPref_SetNonFullScreenPageMode(FSCRT_DOCUMENT document, FS_INT32 displayMode);

FS_RESULT       FSPDF_ViewerPref_SetReadingDirection(FSCRT_DOCUMENT document, FS_INT32 direction);

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

FS_RESULT       FSPDF_ViewerPref_SetPrintScale(FSCRT_DOCUMENT document, const FSCRT_BSTR* printScale);

FS_RESULT       FSPDF_ViewerPref_SetPrintCopies(FSCRT_DOCUMENT document, FS_INT32 copies);

FS_RESULT       FSPDF_ViewerPref_SetPrintRanges(FSCRT_DOCUMENT document, const FS_INT32* pageRanges, FS_INT32 count);

/*******************************************************************************/
/* PDF attachments                                                             */
/*******************************************************************************/
FS_RESULT       FSPDF_Attachments_InsertAttachment(FSPDF_ATTACHMENTS attachments, FS_INT32 index, FSPDF_ATTACHMENT attachment);

FS_RESULT       FSPDF_Attachments_RemoveAttachment(FSPDF_ATTACHMENTS attachments, FSPDF_ATTACHMENT attachment);

/*******************************************************************************/
/* PDF Fonts                                                                   */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_EmbedFont(FSCRT_DOCUMENT document, FSCRT_FONT font);

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

#endif /* _FSPDF_DOCUMENT_W_H_ */