optional_content.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CORE_OPTIONAL_CONTENT_H_INCLUDED_
#define PDFSDK_CORE_OPTIONAL_CONTENT_H_INCLUDED_
 
#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/errors.h>
#include <pdfsdk/math_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct PDOCGRec_* PDOCG;
 
typedef struct PDOCMDRec_* PDOCMD;
 
typedef struct PDOCConfigRec_* PDOCConfig;
 
typedef enum {
    kPDOCGStateOperationOff,    
    kPDOCGStateOperationOn,     
    kPDOCGStateOperationToggle  
} PDOCGStateOperation;
 
typedef void(PDFSDK_CALLCONV* PDOCConfigChangedProc)(void* clientData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAttachOCConfigChangedCallback(PDDoc doc, PDOCConfigChangedProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocDetachOCConfigChangedCallback(PDDoc doc, PDOCConfigChangedProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocNotifyOCConfigChanged(PDDoc doc);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetOCConfig(PDDoc doc, PDOCConfig config);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetOCConfig(PDDoc doc, PDOCConfig* pConfig);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateOCG(PDDoc doc, const wchar_t* name, size_t nameSize, PDOCG* pOCG);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetNumOCGs(PDDoc doc, size_t* pNumOCGs);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetOCG(PDDoc doc, size_t index, PDOCG* pOCG);
 
//----------------------------------------------------------
// OCG
//----------------------------------------------------------
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCGFromPDObject(PDObject object, PDOCG* pOCG);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCGGetPDObject(PDOCG ocg, PDObject* pObject);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCGSetName(PDOCG ocg, const wchar_t* name, size_t nameSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCGGetName(PDOCG ocg, wchar_t* buffer, size_t bufSize, size_t* pSize);
//----------------------------------------------------------
 
//----------------------------------------------------------
// OCMD
//----------------------------------------------------------
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCMDFromPDObject(PDObject object, PDOCMD* pOCMD);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCMDGetPDObject(PDOCMD ocmd, PDObject* pObject);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCMDCreateFromOCG(PDOCG ocg, PDOCMD* pOCMD);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCMDIsVisible(PDOCMD ocmd, PDOCConfig config, bool* pVisible);
//----------------------------------------------------------
 
//----------------------------------------------------------
// OCConfig
//----------------------------------------------------------
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCConfigFromPDObject(PDObject object, PDOCConfig* pOCG);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCConfigGetPDObject(PDOCConfig ocg, PDObject* pObject);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCConfigGetOrder(PDOCConfig config, PDObject* pOrder);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCConfigSetOCGState(PDOCConfig config, PDOCG ocg, bool state, bool preserveRB);  // preserveRB = true as default value
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCConfigGetOCGState(PDOCConfig config, PDOCG ocg, bool* pState);
//----------------------------------------------------------
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_CORE_OPTIONAL_CONTENT_H_INCLUDED_