PdfTools_Toolbox_PtxPdfStructure.h

Go to the documentation of this file.

/******************************************************************************
 *
 * File:            PdfTools_Toolbox_PtxPdfStructure.h
 *
 * Description:     Sub Header file for Toolbox SDK
 *
 * Author:          PDF Tools AG
 *
 * Copyright:       Copyright (C) 2024 - 2024 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_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
 
#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_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
 
#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 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 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_RoleMap* PDFTOOLS_TOOLBOX_CALL
PtxPdfStructure_Tree_GetRoleMap(TPtxPdfStructure_Tree* pTree);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PDFTOOLS_TOOLBOX_PTXPDFSTRUCTURE_H__ */