document.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CORE_DOCUMENT_H_INCLUDED_
#define PDFSDK_CORE_DOCUMENT_H_INCLUDED_

 
#include <pdfsdk/core/objects.h>
#include <pdfsdk/progress_monitor.h>
#include <pdfsdk/core/pdfa_flavor.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct
{
    uint16_t major;
    uint16_t minor;
} PDVersion;

typedef enum {
    kPDInsertPages, 
    kPDDeletePages, 
    kPDMovePages,   
    kPDRotatePages, 
    kPDResizePages, 
} PDPageOperation;
 
typedef struct PDPageRec_* PDPage;
 
#define kPDPageIndexNull ((size_t)(-1))

typedef struct
{
    const size_t* iPages; 
    size_t numPages;      
} PDPageRange;
 
typedef void(PDFSDK_CALLCONV* PDDocPagesChangedProc)(PDPageOperation operation, const PDPageRange* pageRange, void* clientData);

typedef PDErrCode (PDFSDK_CALLCONV* PDDocAuthProc)(void* authProcData, PDAtom securityHandlerName, void* pAuthData);
typedef PDErrCode (PDFSDK_CALLCONV* PDDocAuthFreeDataProc)(void* authProcData);
 
struct PDDocAuthProcs {
    PDDocAuthProc auth;
    PDDocAuthFreeDataProc free;
};
 
typedef PDErrCode (PDFSDK_CALLCONV* PDDocStreamReadAtProc)(void* streamData, uint64_t pos, void* buffer, size_t nbytes, size_t* pRead);
typedef PDErrCode (PDFSDK_CALLCONV* PDDocStreamGetSizeProc)(void* streamData, uint64_t* pSize);
typedef PDErrCode (PDFSDK_CALLCONV* PDDocStreamFreeDataProc)(void* streamData);
 
struct PDDocStreamProcs {
    PDDocStreamReadAtProc readAt;
    PDDocStreamGetSizeProc getSize;
    PDDocStreamFreeDataProc free;
};
 
typedef struct
{
    const wchar_t* filePath;
    const PDDocStreamProcs* streamProcs;
    void* streamData;
    const PDDocAuthProcs* authProcs;
    void* authProcData;
} PDDocOpenParams;

typedef enum {
    kPDDocSaveIncremental = 1 << 0,    
    kPDDocSaveFull = 1 << 1,           
    kPDDocSaveCopy = 1 << 2,           
    kPDDocSaveLinearized = 1 << 3,     
    kPDDocSaveCompressed = 1 << 4,     
    kPDDocSaveXRefCompressed = 1 << 5, 
} PDDocSaveFlagsBits;
 
typedef uint32_t PDDocSaveFlags;

enum {
    kPDOptSaveRemoveHiddenObjects = 1 << 0, 
    kPDOptSaveDownsampleImages = 1 << 1,    
    kPDOptSaveRemoveMetadata = 1 << 2,      
    kPDOptSaveRemoveStructTree = 1 << 3,    
    kPDOptSaveRemoveAttachments = 1 << 4,   
    kPDOptSaveRemoveBookmarks = 1 << 5,     
    kPDOptSaveRemoveAcroform = 1 << 6,      
    kPDOptSaveRemoveOCProperties = 1 << 7,  
    kPDOptSaveRemoveAnnotations = 1 << 8,   
    kPDOptSaveRemoveOpenActions = 1 << 9,   
    kPDOptSaveRemoveJavaScript = 1 << 10,   
    kPDOptSaveRemoveInfo = 1 << 11          
};
typedef uint32_t PDOptSaveFlags;

typedef enum {
    kPDOptSaveImageQualityMin,      
    kPDOptSaveImageQualityLow,      
    kPDOptSaveImageQualityMedium,   
    kPDOptSaveImageQualityHigh,     
    kPDOptSaveImageQualityMax       
} PDOptSaveImageQuality;
 
typedef struct
{
    PDOptSaveFlags flags;
    PDOptSaveImageQuality imageQuality;
    int imageDpi;
} PDOptSaveSettings;
 
typedef struct
{
    PDDocSaveFlags flags;

    const wchar_t* filePath;

    PDWriteStream outputStream;

    const PDProgressMonitor* progress;

    void* progressData;

    const PDOptSaveSettings* optSettings;

    const PDVersion* version;
 
} PDDocSaveParams;

typedef enum {
    kPDPageDirectionL2R,    
    kPDPageDirectionR2L     
} PDPageDirection;
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreate(PDDoc* pDoc);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocOpen(const PDDocOpenParams* params, PDDoc* pDoc);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocIsCompressed(PDDoc doc, bool* pValue);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocIsModified(PDDoc doc, bool* pValue);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetModified(PDDoc doc, bool value);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocIsRepaired(PDDoc doc, bool* pRepaired);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSave(PDDoc doc, const PDDocSaveParams* params);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocPurgeCaches(PDDoc doc);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetFilePath(PDDoc doc, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetPage(PDDoc doc, size_t index, PDPage* pPage);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetNumPages(PDDoc doc, size_t* pNumPages);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAttachPagesChangedCallback(PDDoc doc, PDDocPagesChangedProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocDetachPagesChangedCallback(PDDoc doc, PDDocPagesChangedProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocNotifyPagesChanged(PDDoc doc, PDPageOperation operation, const PDPageRange* range);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreatePage(PDDoc doc, size_t insertAt, const PDRectF* mediaBox, PDPage* pPage);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreatePages(PDDoc doc, size_t insertAt, size_t count, const PDRectF* mediaBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocDeletePages(PDDoc doc, const PDPageRange* range, const PDProgressMonitor* progress, void* progressData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocInsertPages(PDDoc doc, size_t insertAt, PDDoc sourceDoc, const PDPageRange* sourceRange, const PDProgressMonitor* progress, void* progressData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocInsertPage(PDDoc doc, PDPage page, size_t insertAt);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocMovePages(PDDoc doc, size_t insertAt, const PDPageRange* range, const PDProgressMonitor* progress, void* progressData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocFindPageIndexForLabel(PDDoc doc, const wchar_t* label, size_t labelSize, size_t* pIndex);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetLabelForPageIndex(PDDoc doc, size_t index, wchar_t* buffer, size_t bufferSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetID(PDDoc doc, const char** pPermaID, size_t* pPermaLen, const char** pInstanceID, size_t* pInstanceLen);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetVersion(PDDoc doc, PDVersion* pVersion);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetFileSize(PDDoc doc, uint64_t* pFileSize);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetInfoString(PDDoc doc, PDAtom infoStringAtom, wchar_t* buffer, size_t bufferSize, size_t* pSize);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetInfoString(PDDoc doc, PDAtom infoStringAtom, const wchar_t* buffer, size_t bufferSize);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetXmpMetadata(PDDoc doc, char* buffer, size_t bufSize, size_t* pSize);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetXmpMetadata(PDDoc doc, const char* buffer, size_t bufSize);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetPDFAFlavor(PDDoc doc, PDFAFlavor* pFlavor);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetCreationDate(PDDoc doc, PDDateTime* creationDate);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetCreationDate(PDDoc doc, const PDDateTime* creationDate);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetModDate(PDDoc doc, PDDateTime* modDate);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetModDate(PDDoc doc, const PDDateTime* modDate);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetPageLayout(PDDoc doc, PDAtom layout);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetPageLayout(PDDoc doc, PDAtom* pLayout);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetPageMode(PDDoc doc, PDAtom mode);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetPageMode(PDDoc doc, PDAtom* pMode);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetPageDirection(PDDoc doc, PDPageDirection direction);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetPageDirection(PDDoc doc, PDPageDirection* pDirection);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetDoc(PDPage page, PDDoc* pDoc);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetIndex(PDPage page, size_t* pIndex);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageIsContentModified(PDPage page, bool* pValue);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetContentModified(PDPage page, bool value);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageFlushModifiedContent(PDPage page);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetMediaBox(PDPage page, const PDRectF* mediaBox);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetMediaBox(PDPage page, PDRectF* pMediaBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetCropBox(PDPage page, const PDRectF* cropBox);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetCropBox(PDPage page, PDRectF* pCropBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetTrimBox(PDPage page, const PDRectF* trimBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetTrimBox(PDPage page, PDRectF* pTrimBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetArtBox(PDPage page, const PDRectF* artBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetArtBox(PDPage page, PDRectF* pArtBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetBleedBox(PDPage page, const PDRectF* bleedBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetBleedBox(PDPage page, PDRectF* pBleedBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetRotate(PDPage page, PDRotate rotate);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetRotate(PDPage page, PDRotate* pRotate);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetUserUnitSize(PDPage page, float unitSize);

PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetUserUnitSize(PDPage page, float* pUnitSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetPDObject(PDPage page, PDObject* pObj);
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_CORE_DOCUMENT_H_INCLUDED_