actions.h

Go to the documentation of this file.

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

 
#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/core/attachments.h>
#include <pdfsdk/core/optional_content.h>
#include <pdfsdk/core/types.h>
#include <pdfsdk/errors.h>
#include <pdfsdk/math_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    kPDDestUnknown, 
    kPDDestXYZ,     
    kPDDestFit,     
    kPDDestFitH,    
    kPDDestFitV,    
    kPDDestFitR,    
    kPDDestFitB,    
    kPDDestFitBH,   
    kPDDestFitBV    
} PDDestType;

typedef enum {
    kPDActionHideItemAnnot,    
    kPDActionHideItemFieldName 
} PDActionHideItemType;
 
typedef PDErrCode(PDFSDK_CALLCONV* PDDocLevelJSEnumProc)(const char* name, size_t nameLen, PDAction action, void* clientData);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetOpenAction(PDDoc doc, PDAction action);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetOpenAction(PDDoc doc, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocSetOpenDestination(PDDoc doc, PDDest destination);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetOpenDestination(PDDoc doc, PDDest* destination);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocEnumDocLevelJSActions(PDDoc doc, PDDocLevelJSEnumProc proc, void* clientData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetDocLevelJSAction(PDDoc doc, const char* name, size_t nameLen, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocRemoveDocLevelJS(PDDoc doc);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetOpenAction(PDPage page, PDAction action);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetOpenAction(PDPage page, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageSetCloseAction(PDPage page, PDAction action);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetCloseAction(PDPage page, PDAction* pAction);
 
//----------------------------------------------------------
// Action
//----------------------------------------------------------
/*
    Action atom-name list:
        GoTo
        GoToR
        GoToE
        Launch
        Thread
        URI
        Sound
        Movie
        Hide
        Named
        SubmitForm
        ResetForm
        ImportData
        JavaScript
        SetOCGState
        Rendition
        Trans
        GoTo3DView
*/
 
// common
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionCreateURI(PDDoc doc, const char* uri, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionCreateGoTo(PDDoc doc, PDDest destination, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionCreateGoToR(PDDoc doc, PDFileSpec fileSpec, size_t pageIndex, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionCreateJavaScript(PDDoc doc, const wchar_t* jscode, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionCreateSubmitForm(PDDoc doc, const char* serverUri, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionCreateResetForm(PDDoc doc, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionCreateHide(PDDoc doc, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionCreateNamed(PDDoc doc, PDAtom name, PDAction* pAction);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateActionFromPDObject(PDObject object, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGetPDObject(PDAction action, PDObject* pObj);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionCopy(PDDoc doc, PDAction from, PDAction* pAction);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionSetNext(PDAction action, PDAction next);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionSetNextArray(PDAction action, const PDAction* pNext, size_t size);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGetType(PDAction action, PDAtom* actionType);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGetNext(PDAction action, size_t index, PDAction* pNext);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGetNextLength(PDAction action, size_t* length);
 
// GoTo
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToGetDest(PDAction action, PDDest* destination);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToSetDest(PDAction action, PDDest destination);
 
// GoToR
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToRGetFileSpec(PDAction action, PDFileSpec* fileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToRSetFileSpec(PDAction action, PDFileSpec fileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToRGetDest(PDAction action, PDDest* destination);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToRSetDest(PDAction action, PDDest destination);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToRGetNewWindow(PDAction action, bool* pNewWindow);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToRSetNewWindow(PDAction action, bool newWindow);
 
// GoToE
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToEGetFileName(PDAction action, wchar_t* buffer, size_t size, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToESetFileName(PDAction action, const wchar_t* fileName, size_t size);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToEGetTarget(PDAction action, PDObject* pDictionary);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToESetTarget(PDAction action, PDObject pDictionary);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToEGetFileSpec(PDAction action, PDFileSpec* fileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToESetFileSpec(PDAction action, PDFileSpec fileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToEGetDest(PDAction action, PDDest* destination);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToESetDest(PDAction action, PDDest destination);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToEGetNewWindow(PDAction action, bool* pNewWindow);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionGoToESetNewWindow(PDAction action, bool newWindow);
 
// Launch
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionLaunchGetFileSpec(PDAction action, PDFileSpec* fileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionLaunchSetFileSpec(PDAction action, PDFileSpec fileSpec);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionLaunchGetNewWindow(PDAction action, bool* pNewWindow);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionLaunchSetNewWindow(PDAction action, bool newWindow);
 
// Thread
// ??????
 
// URI
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionURIGetURI(PDAction action, char* buffer, size_t size, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionURISetURI(PDAction action, const char* uri, size_t size);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionURIGetIsMap(PDAction action, bool* isMap);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionURISetIsMap(PDAction action, bool isMap);
 
// Sound
// ??????
 
// Movie
// ??????
 
// Hide
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionHideGetNumItems(PDAction action, size_t* pNumItems);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionHideRemoveItem(PDAction action, size_t index);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionHideGetItemType(PDAction action, size_t index, PDActionHideItemType* ptype);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionHideGetItemAnnot(PDAction action, size_t index, PDAnnot* pAnnot);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionHideGetItemFieldName(PDAction action, size_t index, wchar_t* buffer, size_t size, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionHideAddItemAnnot(PDAction action, PDAnnot annot);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionHideAddItemFieldName(PDAction action, const wchar_t* name, size_t size);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionHideIsHiding(PDAction action, bool* pHiding);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionHideSetHiding(PDAction action, bool hiding);
 
// Named
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionNamedGetName(PDAction action, PDAtom* pName);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionNamedSetName(PDAction action, PDAtom name);
 
// JavaScript
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionJavaScriptGetScript(PDAction action, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionJavaScriptSetScript(PDAction action, const wchar_t* buffer, size_t bufSize);
 
// SetOCGState
// ??????
 
// Rendition
// ??????
 
// Trans
// ??????
 
// GoTo3DView
// ??????
 
//----------------------------------------------------------
 
//----------------------------------------------------------
// Destination
//----------------------------------------------------------
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDestCreate(PDDoc doc,
                                                    PDDestType type,
                                                    bool remote,
                                                    size_t pageIndex,
                                                    const float* params,
                                                    PDDest* pDest);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDestCreateFromPDObject(PDObject obj, PDDest* pDest);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDestGetPDObject(PDDest dest, PDObject* pObj);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDestCopy(PDDest srcDest, PDDest* dest);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDestGetType(PDDest dest, PDDestType* type);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDestGetPageIndex(PDDest dest, size_t* pageIndex);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDestGetParams(PDDest dest, float* params);
//----------------------------------------------------------
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_CORE_ACTIONS_H_INCLUDED_