1.10/cdoc/_pdf_tools___toolbox___ptx_pdf_structure_8h_source.html

/******************************************************************************

 *

 * File:            PdfTools_Toolbox_PtxPdfStructure.h

 *

 * Description:     Sub Header file for Toolbox SDK

 *

 * Author:          PDF Tools AG

 *

 * Copyright:       Copyright (C) 2024 - 2025 PDF Tools AG, Switzerland

 *                  All rights reserved.

 *

 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's

 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),

 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),

 *                  and allow PDF Tools AG to track your usage data.

 *

 *****************************************************************************/


#ifndef PDFTOOLS_TOOLBOX_PTXPDFSTRUCTURE_H__

#define PDFTOOLS_TOOLBOX_PTXPDFSTRUCTURE_H__


#ifndef PDFTOOLS_TOOLBOX_CALL

#if defined(WIN32)

#define PDFTOOLS_TOOLBOX_CALL __stdcall

#else

#define PDFTOOLS_TOOLBOX_CALL

#endif

#endif


#include "PdfTools_Toolbox_Types.h"

#include "PdfTools_Toolbox_PtxSys.h"


#ifdef __cplusplus

extern "C"

{

#endif


#ifdef _UNICODE

#define PtxPdfStructure_RoleMap_Get      PtxPdfStructure_RoleMap_GetW

#define PtxPdfStructure_RoleMap_GetKey   PtxPdfStructure_RoleMap_GetKeyW

#define PtxPdfStructure_RoleMap_GetValue PtxPdfStructure_RoleMap_GetValueW

#define PtxPdfStructure_RoleMap_Set      PtxPdfStructure_RoleMap_SetW

#define PtxPdfStructure_RoleMap_SetValue PtxPdfStructure_RoleMap_SetValueW


#define PtxPdfStructure_Node_New                PtxPdfStructure_Node_NewW

#define PtxPdfStructure_Node_GetStringAttribute PtxPdfStructure_Node_GetStringAttributeW

#define PtxPdfStructure_Node_SetStringAttribute PtxPdfStructure_Node_SetStringAttributeW


#define PtxPdfStructure_Node_GetTag           PtxPdfStructure_Node_GetTagW

#define PtxPdfStructure_Node_SetTag           PtxPdfStructure_Node_SetTagW

#define PtxPdfStructure_Node_GetAlternateText PtxPdfStructure_Node_GetAlternateTextW

#define PtxPdfStructure_Node_SetAlternateText PtxPdfStructure_Node_SetAlternateTextW

#define PtxPdfStructure_Node_GetActualText    PtxPdfStructure_Node_GetActualTextW

#define PtxPdfStructure_Node_SetActualText    PtxPdfStructure_Node_SetActualTextW

#define PtxPdfStructure_Node_GetLanguage      PtxPdfStructure_Node_GetLanguageW

#define PtxPdfStructure_Node_SetLanguage      PtxPdfStructure_Node_SetLanguageW

#define PtxPdfStructure_Node_GetAbbreviation  PtxPdfStructure_Node_GetAbbreviationW

#define PtxPdfStructure_Node_SetAbbreviation  PtxPdfStructure_Node_SetAbbreviationW


#else

#define PtxPdfStructure_RoleMap_Get      PtxPdfStructure_RoleMap_GetA

#define PtxPdfStructure_RoleMap_GetKey   PtxPdfStructure_RoleMap_GetKeyA

#define PtxPdfStructure_RoleMap_GetValue PtxPdfStructure_RoleMap_GetValueA

#define PtxPdfStructure_RoleMap_Set      PtxPdfStructure_RoleMap_SetA

#define PtxPdfStructure_RoleMap_SetValue PtxPdfStructure_RoleMap_SetValueA


#define PtxPdfStructure_Node_New                PtxPdfStructure_Node_NewA

#define PtxPdfStructure_Node_GetStringAttribute PtxPdfStructure_Node_GetStringAttributeA

#define PtxPdfStructure_Node_SetStringAttribute PtxPdfStructure_Node_SetStringAttributeA


#define PtxPdfStructure_Node_GetTag           PtxPdfStructure_Node_GetTagA

#define PtxPdfStructure_Node_SetTag           PtxPdfStructure_Node_SetTagA

#define PtxPdfStructure_Node_GetAlternateText PtxPdfStructure_Node_GetAlternateTextA

#define PtxPdfStructure_Node_SetAlternateText PtxPdfStructure_Node_SetAlternateTextA

#define PtxPdfStructure_Node_GetActualText    PtxPdfStructure_Node_GetActualTextA

#define PtxPdfStructure_Node_SetActualText    PtxPdfStructure_Node_SetActualTextA

#define PtxPdfStructure_Node_GetLanguage      PtxPdfStructure_Node_GetLanguageA

#define PtxPdfStructure_Node_SetLanguage      PtxPdfStructure_Node_SetLanguageA

#define PtxPdfStructure_Node_GetAbbreviation  PtxPdfStructure_Node_GetAbbreviationA

#define PtxPdfStructure_Node_SetAbbreviation  PtxPdfStructure_Node_SetAbbreviationA


#endif


/******************************************************************************

 * RoleMap

 *****************************************************************************/

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetCount(TPtxPdfStructure_RoleMap* pRoleMap);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetSize(TPtxPdfStructure_RoleMap* pRoleMap);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetBegin(TPtxPdfStructure_RoleMap* pRoleMap);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetEnd(TPtxPdfStructure_RoleMap* pRoleMap);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetNext(TPtxPdfStructure_RoleMap* pRoleMap,

                                                                                  int                       it);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetA(TPtxPdfStructure_RoleMap* pRoleMap,

                                                                               const char*               szKey);

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetW(TPtxPdfStructure_RoleMap* pRoleMap,

                                                                               const WCHAR*              szKey);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetKeyA(TPtxPdfStructure_RoleMap* pRoleMap,

                                                                                     int it, char* pBuffer,

                                                                                     size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetKeyW(TPtxPdfStructure_RoleMap* pRoleMap,

                                                                                     int it, WCHAR* pBuffer,

                                                                                     size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_RoleMap_GetValueA(TPtxPdfStructure_RoleMap* pRoleMap, int it, char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_RoleMap_GetValueW(TPtxPdfStructure_RoleMap* pRoleMap, int it, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_SetA(TPtxPdfStructure_RoleMap* pRoleMap,

                                                                                const char* szKey, const char* szValue);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_SetW(TPtxPdfStructure_RoleMap* pRoleMap,

                                                                                const WCHAR*              szKey,

                                                                                const WCHAR*              szValue);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_SetValueA(TPtxPdfStructure_RoleMap* pRoleMap,

                                                                                     int it, const char* szValue);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_SetValueW(TPtxPdfStructure_RoleMap* pRoleMap,

                                                                                     int it, const WCHAR* szValue);


/******************************************************************************

 * Node

 *****************************************************************************/

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node* PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_NewA(const char* szTag, TPtxPdf_Document* pDocument, TPtxPdf_Page* pPage);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node* PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_NewW(const WCHAR* szTag, TPtxPdf_Document* pDocument, TPtxPdf_Page* pPage);


PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetStringAttributeA(

    TPtxPdfStructure_Node* pNode, const char* szKey, char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetStringAttributeW(

    TPtxPdfStructure_Node* pNode, const WCHAR* szKey, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_SetStringAttributeA(TPtxPdfStructure_Node* pNode, const char* szKey, const char* szValue);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_SetStringAttributeW(TPtxPdfStructure_Node* pNode, const WCHAR* szKey, const WCHAR* szValue);


PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node* PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_GetParent(TPtxPdfStructure_Node* pNode);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_NodeList* PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_GetChildren(TPtxPdfStructure_Node* pNode);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetTagA(TPtxPdfStructure_Node* pNode,

                                                                                  char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetTagW(TPtxPdfStructure_Node* pNode,

                                                                                  WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetTagA(TPtxPdfStructure_Node* pNode,

                                                                                const char*            szTag);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetTagW(TPtxPdfStructure_Node* pNode,

                                                                                const WCHAR*           szTag);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page* PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetPage(TPtxPdfStructure_Node* pNode);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetPage(TPtxPdfStructure_Node* pNode,

                                                                                TPtxPdf_Page*          pPage);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_GetAlternateTextA(TPtxPdfStructure_Node* pNode, char* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_GetAlternateTextW(TPtxPdfStructure_Node* pNode, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetAlternateTextA(TPtxPdfStructure_Node* pNode,

                                                                                          const char* szAlternateText);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetAlternateTextW(TPtxPdfStructure_Node* pNode,

                                                                                          const WCHAR* szAlternateText);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetActualTextA(TPtxPdfStructure_Node* pNode,

                                                                                         char*                  pBuffer,

                                                                                         size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetActualTextW(TPtxPdfStructure_Node* pNode,

                                                                                         WCHAR*                 pBuffer,

                                                                                         size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetActualTextA(TPtxPdfStructure_Node* pNode,

                                                                                       const char* szActualText);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetActualTextW(TPtxPdfStructure_Node* pNode,

                                                                                       const WCHAR* szActualText);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetLanguageA(TPtxPdfStructure_Node* pNode,

                                                                                       char*                  pBuffer,

                                                                                       size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetLanguageW(TPtxPdfStructure_Node* pNode,

                                                                                       WCHAR*                 pBuffer,

                                                                                       size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetLanguageA(TPtxPdfStructure_Node* pNode,

                                                                                     const char*            szLanguage);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetLanguageW(TPtxPdfStructure_Node* pNode,

                                                                                     const WCHAR*           szLanguage);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetAbbreviationA(TPtxPdfStructure_Node* pNode,

                                                                                           char*  pBuffer,

                                                                                           size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetAbbreviationW(TPtxPdfStructure_Node* pNode,

                                                                                           WCHAR* pBuffer,

                                                                                           size_t nBufferSize);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetAbbreviationA(TPtxPdfStructure_Node* pNode,

                                                                                         const char* szAbbreviation);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetAbbreviationW(TPtxPdfStructure_Node* pNode,

                                                                                         const WCHAR* szAbbreviation);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_GetBoundingBox(TPtxPdfStructure_Node* pNode, TPtxGeomReal_Rectangle* pBoundingBox);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Node_SetBoundingBox(TPtxPdfStructure_Node* pNode, const TPtxGeomReal_Rectangle* pBoundingBox);


/******************************************************************************

 * NodeList

 *****************************************************************************/

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_NodeList_GetCount(TPtxPdfStructure_NodeList* pNodeList);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node* PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_NodeList_Get(TPtxPdfStructure_NodeList* pNodeList, int iIndex);

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_NodeList_Add(TPtxPdfStructure_NodeList* pNodeList,

                                                                                TPtxPdfStructure_Node*     pNode);


/******************************************************************************

 * Tree

 *****************************************************************************/

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Tree* PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Tree_New(TPtxPdf_Document* pDocument);


PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node* PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Tree_GetDocumentNode(TPtxPdfStructure_Tree* pTree);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_NodeList* PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Tree_GetChildren(TPtxPdfStructure_Tree* pTree);

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_RoleMap* PDFTOOLS_TOOLBOX_CALL

PtxPdfStructure_Tree_GetRoleMap(TPtxPdfStructure_Tree* pTree);


#ifdef __cplusplus

}

#endif


#endif /* PDFTOOLS_TOOLBOX_PTXPDFSTRUCTURE_H__ */

PDFTOOLS_TOOLBOX_EXPORT
#define PDFTOOLS_TOOLBOX_EXPORT
Definition PdfTools_Toolbox_Platform.h:143

WCHAR
unsigned short WCHAR
Definition PdfTools_Toolbox_Platform.h:95

PtxPdfStructure_Node_GetAlternateTextW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetAlternateTextW(TPtxPdfStructure_Node *pNode, WCHAR *pBuffer, size_t nBufferSize)

PtxPdfStructure_Node_SetTagA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetTagA(TPtxPdfStructure_Node *pNode, const char *szTag)

PtxPdfStructure_Node_SetLanguageA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetLanguageA(TPtxPdfStructure_Node *pNode, const char *szLanguage)

PtxPdfStructure_Node_NewW
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_NewW(const WCHAR *szTag, TPtxPdf_Document *pDocument, TPtxPdf_Page *pPage)

PtxPdfStructure_RoleMap_GetKeyW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetKeyW(TPtxPdfStructure_RoleMap *pRoleMap, int it, WCHAR *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.

PtxPdfStructure_Node_SetActualTextA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetActualTextA(TPtxPdfStructure_Node *pNode, const char *szActualText)

PtxPdfStructure_Node_GetAbbreviationW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetAbbreviationW(TPtxPdfStructure_Node *pNode, WCHAR *pBuffer, size_t nBufferSize)

PtxPdfStructure_RoleMap_GetValueA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetValueA(TPtxPdfStructure_RoleMap *pRoleMap, int it, char *pBuffer, size_t nBufferSize)
Get the value of the entry given a position.

PtxPdfStructure_Node_GetTagA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetTagA(TPtxPdfStructure_Node *pNode, char *pBuffer, size_t nBufferSize)

PtxPdfStructure_RoleMap_SetValueW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_SetValueW(TPtxPdfStructure_RoleMap *pRoleMap, int it, const WCHAR *szValue)
Set the value of the entry at a position in the map.

PtxPdfStructure_Tree_GetDocumentNode
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Tree_GetDocumentNode(TPtxPdfStructure_Tree *pTree)

PtxPdfStructure_Node_GetParent
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetParent(TPtxPdfStructure_Node *pNode)

PtxPdfStructure_RoleMap_SetW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_SetW(TPtxPdfStructure_RoleMap *pRoleMap, const WCHAR *szKey, const WCHAR *szValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...

PtxPdfStructure_Node_SetBoundingBox
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetBoundingBox(TPtxPdfStructure_Node *pNode, const TPtxGeomReal_Rectangle *pBoundingBox)
Bounding box for contents - should only be set for Figure, Formula and Table.

PtxPdfStructure_RoleMap_GetBegin
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetBegin(TPtxPdfStructure_RoleMap *pRoleMap)
Get the position of the first entry in the map.

PtxPdfStructure_Node_GetActualTextW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetActualTextW(TPtxPdfStructure_Node *pNode, WCHAR *pBuffer, size_t nBufferSize)

PtxPdfStructure_Node_SetPage
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetPage(TPtxPdfStructure_Node *pNode, TPtxPdf_Page *pPage)

PtxPdfStructure_Node_SetActualTextW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetActualTextW(TPtxPdfStructure_Node *pNode, const WCHAR *szActualText)

PtxPdfStructure_Node_SetLanguageW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetLanguageW(TPtxPdfStructure_Node *pNode, const WCHAR *szLanguage)

PtxPdfStructure_Node_GetPage
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetPage(TPtxPdfStructure_Node *pNode)

PtxPdfStructure_NodeList_Get
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_NodeList_Get(TPtxPdfStructure_NodeList *pNodeList, int iIndex)
Returns the element at the specified position in the given list.

PDFTOOLS_TOOLBOX_CALL
#define PDFTOOLS_TOOLBOX_CALL
Definition PdfTools_Toolbox_PtxPdfStructure.h:26

PtxPdfStructure_Node_SetAbbreviationW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetAbbreviationW(TPtxPdfStructure_Node *pNode, const WCHAR *szAbbreviation)

PtxPdfStructure_Tree_GetChildren
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_NodeList *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Tree_GetChildren(TPtxPdfStructure_Tree *pTree)

PtxPdfStructure_RoleMap_SetValueA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_SetValueA(TPtxPdfStructure_RoleMap *pRoleMap, int it, const char *szValue)
Set the value of the entry at a position in the map.

PtxPdfStructure_Node_GetAlternateTextA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetAlternateTextA(TPtxPdfStructure_Node *pNode, char *pBuffer, size_t nBufferSize)

PtxPdfStructure_RoleMap_SetA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_SetA(TPtxPdfStructure_RoleMap *pRoleMap, const char *szKey, const char *szValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...

PtxPdfStructure_RoleMap_GetCount
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetCount(TPtxPdfStructure_RoleMap *pRoleMap)
The number of key-value pairs in the map.

PtxPdfStructure_Node_SetStringAttributeA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetStringAttributeA(TPtxPdfStructure_Node *pNode, const char *szKey, const char *szValue)
Set a string attribute.

PtxPdfStructure_RoleMap_GetValueW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetValueW(TPtxPdfStructure_RoleMap *pRoleMap, int it, WCHAR *pBuffer, size_t nBufferSize)
Get the value of the entry given a position.

PtxPdfStructure_RoleMap_GetNext
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetNext(TPtxPdfStructure_RoleMap *pRoleMap, int it)
Get the position of the next entry in the map.

PtxPdfStructure_RoleMap_GetKeyA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetKeyA(TPtxPdfStructure_RoleMap *pRoleMap, int it, char *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.

PtxPdfStructure_Node_SetStringAttributeW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetStringAttributeW(TPtxPdfStructure_Node *pNode, const WCHAR *szKey, const WCHAR *szValue)
Set a string attribute.

PtxPdfStructure_Node_SetAbbreviationA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetAbbreviationA(TPtxPdfStructure_Node *pNode, const char *szAbbreviation)

PtxPdfStructure_Node_GetStringAttributeW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetStringAttributeW(TPtxPdfStructure_Node *pNode, const WCHAR *szKey, WCHAR *pBuffer, size_t nBufferSize)
Query a string attribute.

PtxPdfStructure_Node_NewA
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Node *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_NewA(const char *szTag, TPtxPdf_Document *pDocument, TPtxPdf_Page *pPage)

PtxPdfStructure_Node_SetAlternateTextA
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetAlternateTextA(TPtxPdfStructure_Node *pNode, const char *szAlternateText)

PtxPdfStructure_Node_GetAbbreviationA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetAbbreviationA(TPtxPdfStructure_Node *pNode, char *pBuffer, size_t nBufferSize)

PtxPdfStructure_Node_GetBoundingBox
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetBoundingBox(TPtxPdfStructure_Node *pNode, TPtxGeomReal_Rectangle *pBoundingBox)
Bounding box for contents - should only be set for Figure, Formula and Table.

PtxPdfStructure_Tree_GetRoleMap
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_RoleMap *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Tree_GetRoleMap(TPtxPdfStructure_Tree *pTree)

PtxPdfStructure_Node_GetTagW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetTagW(TPtxPdfStructure_Node *pNode, WCHAR *pBuffer, size_t nBufferSize)

PtxPdfStructure_RoleMap_GetEnd
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetEnd(TPtxPdfStructure_RoleMap *pRoleMap)
Get the end position of the map.

PtxPdfStructure_Tree_New
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_Tree *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Tree_New(TPtxPdf_Document *pDocument)

PtxPdfStructure_Node_GetLanguageA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetLanguageA(TPtxPdfStructure_Node *pNode, char *pBuffer, size_t nBufferSize)

PtxPdfStructure_Node_GetLanguageW
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetLanguageW(TPtxPdfStructure_Node *pNode, WCHAR *pBuffer, size_t nBufferSize)

PtxPdfStructure_RoleMap_GetW
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetW(TPtxPdfStructure_RoleMap *pRoleMap, const WCHAR *szKey)
Get the position of a key in the map. If no error occurred, then the position can be used to get the ...

PtxPdfStructure_NodeList_Add
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_NodeList_Add(TPtxPdfStructure_NodeList *pNodeList, TPtxPdfStructure_Node *pNode)
Add an element to the end of the list.

PtxPdfStructure_RoleMap_GetA
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetA(TPtxPdfStructure_RoleMap *pRoleMap, const char *szKey)
Get the position of a key in the map. If no error occurred, then the position can be used to get the ...

PtxPdfStructure_Node_SetAlternateTextW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetAlternateTextW(TPtxPdfStructure_Node *pNode, const WCHAR *szAlternateText)

PtxPdfStructure_Node_GetActualTextA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetActualTextA(TPtxPdfStructure_Node *pNode, char *pBuffer, size_t nBufferSize)

PtxPdfStructure_Node_SetTagW
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_SetTagW(TPtxPdfStructure_Node *pNode, const WCHAR *szTag)

PtxPdfStructure_RoleMap_GetSize
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_RoleMap_GetSize(TPtxPdfStructure_RoleMap *pRoleMap)
The number of key-value pairs in the map.

PtxPdfStructure_NodeList_GetCount
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_NodeList_GetCount(TPtxPdfStructure_NodeList *pNodeList)
Get the number of elements in the list.

PtxPdfStructure_Node_GetStringAttributeA
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetStringAttributeA(TPtxPdfStructure_Node *pNode, const char *szKey, char *pBuffer, size_t nBufferSize)
Query a string attribute.

PtxPdfStructure_Node_GetChildren
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfStructure_NodeList *PDFTOOLS_TOOLBOX_CALL PtxPdfStructure_Node_GetChildren(TPtxPdfStructure_Node *pNode)

PdfTools_Toolbox_PtxSys.h

PdfTools_Toolbox_Types.h

BOOL
#define BOOL
Definition PdfTools_Toolbox_Types.h:23

TPtxPdf_Document

TPtxPdf_Page

TPtxPdfStructure_Node

TPtxPdfStructure_NodeList

TPtxPdfStructure_RoleMap

TPtxPdfStructure_Tree

TPtxGeomReal_Rectangle
Definition PdfTools_Toolbox_Types.h:2139