struct_tree.h File Reference

StructTree API. More...

#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/core/content.h>
#include <pdfsdk/core/document.h>
#include <pdfsdk/core/objects.h>
#include <pdfsdk/core/types.h>
#include <pdfsdk/errors.h>

Go to the source code of this file.

Typedefs
typedef PDObject	PDStructTreeRoot
typedef PDObject	PDStructTreeElement

Enumerations
enum	PDStructTreeKidType { kPDStructTreeKidUnknown = 0 , kPDStructTreeKidElement , kPDStructTreeKidMarkedContent , kPDStructTreeKidObjectRef }

Functions
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocGetStructTree (PDDoc doc, PDStructTreeRoot *pStructTree)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocCreateStructTree (PDDoc doc, PDStructTreeRoot *pStructTree)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDDocRemoveStructTree (PDDoc doc)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeClassMapGetNumAttrObjs (PDStructTreeRoot structTree, PDAtom name, size_t *pNumAttrObjs)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeClassMapGetAttrObj (PDStructTreeRoot structTree, PDAtom name, size_t index, PDObject *pAttrObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeClassMapInsertAttrObj (PDStructTreeRoot structTree, PDAtom name, size_t index, PDObject attrObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeClassMapRemoveAttrObj (PDStructTreeRoot structTree, PDAtom name, PDObject attrObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeClassMapRemoveClass (PDStructTreeRoot structTree, PDAtom name)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeClassMapRemoveAll (PDStructTreeRoot structTree)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeRoleMapPut (PDStructTreeRoot structTree, PDAtom from, PDAtom to)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeRoleMapGet (PDStructTreeRoot structTree, PDAtom from, PDAtom *pTo)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeRoleMapRemove (PDStructTreeRoot structTree, PDAtom from)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeGetNumKids (PDStructTreeRoot structTree, size_t *pNumKids)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeGetKid (PDStructTreeRoot structTree, size_t index, PDStructTreeElement *pElement)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeInsertKid (PDStructTreeRoot structTree, size_t index, PDStructTreeElement element)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeRemoveKid (PDStructTreeRoot structTree, size_t index)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeCreateElement (PDStructTreeRoot structTree, PDAtom type, PDStructTreeElement *pElement)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementSetType (PDStructTreeElement element, PDAtom type)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetType (PDStructTreeElement element, PDAtom *pType)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetID (PDStructTreeElement element, char *buffer, size_t bufferSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementSetID (PDStructTreeElement element, const char *id, size_t idSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementSetTitle (PDStructTreeElement element, const wchar_t *title, size_t titleSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetTitle (PDStructTreeElement element, wchar_t *buffer, size_t bufferSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementSetAltText (PDStructTreeElement element, const wchar_t *altText, size_t altTextSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetAltText (PDStructTreeElement element, wchar_t *buffer, size_t bufferSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementSetActualText (PDStructTreeElement element, const wchar_t *actualText, size_t actualTextSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetActualText (PDStructTreeElement element, wchar_t *buffer, size_t bufferSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementSetLanguage (PDStructTreeElement element, const wchar_t *lang, size_t langSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetLanguage (PDStructTreeElement element, wchar_t *buffer, size_t bufferSize, size_t *pSize)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetNumAttrObjs (PDStructTreeElement element, size_t *pNumAttrObjs)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetAttrObj (PDStructTreeElement element, size_t index, PDObject *pAttrObj, int *pRevision)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementInsertAttrObj (PDStructTreeElement element, size_t index, PDObject attrObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementRemoveAttrObj (PDStructTreeElement element, PDObject attrObj)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetNumClasses (PDStructTreeElement element, size_t *pNumClasses)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetClass (PDStructTreeElement element, size_t index, PDAtom *pName, int *pRevision)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementAddClass (PDStructTreeElement element, PDAtom name)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementRemoveClass (PDStructTreeElement element, PDAtom name)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetRevision (PDStructTreeElement element, int *pRevision)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementIncrementRevision (PDStructTreeElement element)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetParent (PDStructTreeElement element, PDStructTreeElement *pParent)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetNumKids (PDStructTreeElement element, size_t *pNumKids)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetKidType (PDStructTreeElement element, size_t index, PDStructTreeKidType *pKidType)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetKidElement (PDStructTreeElement element, size_t index, PDStructTreeElement *pKid)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementInsertKidElement (PDStructTreeElement element, size_t index, PDStructTreeElement kid)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetKidMCPage (PDStructTreeElement element, size_t index, PDPage *pPage)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetKidMCID (PDStructTreeElement element, size_t index, int *pMCID)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetKidMCStm (PDStructTreeElement element, size_t index, PDObject *pStm)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetKidMCStmOwn (PDStructTreeElement element, size_t index, PDObject *pStmOwn)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementInsertKidMC (PDStructTreeElement element, size_t index, PDPage page, PDEElement mc, PDObject stm, PDObject stmOwn)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementInsertKidMCID (PDStructTreeElement element, size_t index, PDPage page, int mcid, PDObject stm, PDObject stmOwn)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetKidOBJRPage (PDStructTreeElement element, size_t index, PDPage *pPage)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementGetKidOBJRObject (PDStructTreeElement element, size_t index, PDObject *pObject)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementInsertKidOBJR (PDStructTreeElement element, size_t index, PDPage page, PDObject object)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeElementRemoveKid (PDStructTreeElement element, size_t index)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeFindElementByID (PDStructTreeRoot structTree, const char *id, size_t idSize, PDStructTreeElement *pElement)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeGetMCParent (PDStructTreeRoot structTree, PDPage page, PDEElement mc, PDStructTreeElement *pParent)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeGetMCIDParent (PDStructTreeRoot structTree, PDPage page, int mcid, PDStructTreeElement *pParent)
PDF_CORE_API PDErrCode PDFSDK_CALLCONV	PDStructTreeGetObjectParent (PDStructTreeRoot structTree, PDObject object, PDStructTreeElement *pParent)

Detailed Description

StructTree API.