PDF Toolbox
Loading...
Searching...
No Matches
PdfTools_Toolbox_PtxPdfNav.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_Toolbox_PtxPdfNav.h
4 *
5 * Description: Sub Header file for Toolbox SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2024 - 2026 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 * Notice: By downloading and using this artifact, you accept PDF Tools AG's
13 * [license agreement](https://www.pdf-tools.com/license-agreement/),
14 * [privacy policy](https://www.pdf-tools.com/privacy-policy/),
15 * and allow PDF Tools AG to track your usage data.
16 *
17 *****************************************************************************/
18
19#ifndef PDFTOOLS_TOOLBOX_PTXPDFNAV_H__
20#define PDFTOOLS_TOOLBOX_PTXPDFNAV_H__
21
22#ifndef PDFTOOLS_TOOLBOX_CALL
23#if defined(WIN32)
24#define PDFTOOLS_TOOLBOX_CALL __stdcall
25#else
26#define PDFTOOLS_TOOLBOX_CALL
27#endif
28#endif
29
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#define PtxPdfNav_OutlineItem_Create PtxPdfNav_OutlineItem_CreateW
40
41#define PtxPdfNav_OutlineItem_GetTitle PtxPdfNav_OutlineItem_GetTitleW
42#define PtxPdfNav_OutlineItem_SetTitle PtxPdfNav_OutlineItem_SetTitleW
43
44#define PtxPdfNav_NamedDestination_Create PtxPdfNav_NamedDestination_CreateW
45
46#define PtxPdfNav_NamedDestination_GetName PtxPdfNav_NamedDestination_GetNameW
47
48#define PtxPdfNav_Link_GetContent PtxPdfNav_Link_GetContentW
49
50#define PtxPdfNav_Link_GetName PtxPdfNav_Link_GetNameW
51
52#define PtxPdfNav_WebLink_Create PtxPdfNav_WebLink_CreateW
53#define PtxPdfNav_WebLink_CreateFromQuadrilaterals PtxPdfNav_WebLink_CreateFromQuadrilateralsW
54
55#define PtxPdfNav_WebLink_GetUri PtxPdfNav_WebLink_GetUriW
56#define PtxPdfNav_WebLink_SetUri PtxPdfNav_WebLink_SetUriW
57
58#else
59#define PtxPdfNav_OutlineItem_Create PtxPdfNav_OutlineItem_CreateA
60
61#define PtxPdfNav_OutlineItem_GetTitle PtxPdfNav_OutlineItem_GetTitleA
62#define PtxPdfNav_OutlineItem_SetTitle PtxPdfNav_OutlineItem_SetTitleA
63
64#define PtxPdfNav_NamedDestination_Create PtxPdfNav_NamedDestination_CreateA
65
66#define PtxPdfNav_NamedDestination_GetName PtxPdfNav_NamedDestination_GetNameA
67
68#define PtxPdfNav_Link_GetContent PtxPdfNav_Link_GetContentA
69
70#define PtxPdfNav_Link_GetName PtxPdfNav_Link_GetNameA
71
72#define PtxPdfNav_WebLink_Create PtxPdfNav_WebLink_CreateA
73#define PtxPdfNav_WebLink_CreateFromQuadrilaterals PtxPdfNav_WebLink_CreateFromQuadrilateralsA
74
75#define PtxPdfNav_WebLink_GetUri PtxPdfNav_WebLink_GetUriA
76#define PtxPdfNav_WebLink_SetUri PtxPdfNav_WebLink_SetUriA
77
78#endif
79
80/******************************************************************************
81 * ViewerSettings
82 *****************************************************************************/
117
140 TPtxPdfNav_ViewerSettings* pViewerSettings, TPtxPdfNav_PageDisplay* pPageDisplay);
161 TPtxPdfNav_ViewerSettings* pViewerSettings, const TPtxPdfNav_PageDisplay* pPageDisplay);
184 TPtxPdfNav_ViewerSettings* pViewerSettings, TPtxPdfNav_ViewerNavigationPane* pActivePane);
205 TPtxPdfNav_ViewerSettings* pViewerSettings, const TPtxPdfNav_ViewerNavigationPane* pActivePane);
371 TPtxPdfNav_ViewerSettings* pViewerSettings, BOOL bDisplayDocumentTitle);
372
373/******************************************************************************
374 * OutlineItem
375 *****************************************************************************/
407 TPtxPdf_Document* pTargetDocument, const char* szTitle, TPtxPdfNav_Destination* pDestination);
439 TPtxPdf_Document* pTargetDocument, const WCHAR* szTitle, TPtxPdfNav_Destination* pDestination);
480 TPtxPdf_Document* pTargetDocument, TPtxPdfNav_OutlineItem* pOutlineItem, TPtxPdfNav_OutlineCopyOptions* pOptions);
481
508PtxPdfNav_OutlineItem_GetTitleA(TPtxPdfNav_OutlineItem* pOutlineItem, char* pBuffer, size_t nBufferSize);
535PtxPdfNav_OutlineItem_GetTitleW(TPtxPdfNav_OutlineItem* pOutlineItem, WCHAR* pBuffer, size_t nBufferSize);
557 const char* szTitle);
579 const WCHAR* szTitle);
623 BOOL bBold);
668 BOOL bItalic);
766 BOOL bIsOpen);
787
788/******************************************************************************
789 * OutlineItemList
790 *****************************************************************************/
889
890/******************************************************************************
891 * Destination
892 *****************************************************************************/
915
931/******************************************************************************
932 * NamedDestination
933 *****************************************************************************/
962 TPtxPdf_Document* pTargetDocument, const char* szName, TPtxPdfNav_DirectDestination* pTarget);
991 TPtxPdf_Document* pTargetDocument, const WCHAR* szName, TPtxPdfNav_DirectDestination* pTarget);
992
1017PtxPdfNav_NamedDestination_GetNameA(TPtxPdfNav_NamedDestination* pNamedDestination, char* pBuffer, size_t nBufferSize);
1042PtxPdfNav_NamedDestination_GetNameW(TPtxPdfNav_NamedDestination* pNamedDestination, WCHAR* pBuffer, size_t nBufferSize);
1043
1044/******************************************************************************
1045 * DirectDestination
1046 *****************************************************************************/
1069
1085/******************************************************************************
1086 * LocationZoomDestination
1087 *****************************************************************************/
1126PtxPdfNav_LocationZoomDestination_Create(TPtxPdf_Document* pTargetDocument, TPtxPdf_Page* pPage, const double* pLeft,
1127 const double* pTop, const double* pZoom);
1128
1226
1227/******************************************************************************
1228 * FitPageDestination
1229 *****************************************************************************/
1260PtxPdfNav_FitPageDestination_Create(TPtxPdf_Document* pTargetDocument, TPtxPdf_Page* pPage, BOOL bFitActualContent);
1261
1288
1289/******************************************************************************
1290 * FitWidthDestination
1291 *****************************************************************************/
1326 TPtxPdf_Document* pTargetDocument, TPtxPdf_Page* pPage, BOOL bFitActualContent, const double* pTop);
1327
1379
1380/******************************************************************************
1381 * FitHeightDestination
1382 *****************************************************************************/
1417 TPtxPdf_Document* pTargetDocument, TPtxPdf_Page* pPage, BOOL bFitActualContent, const double* pLeft);
1418
1479
1480/******************************************************************************
1481 * FitRectangleDestination
1482 *****************************************************************************/
1515 const TPtxGeomReal_Rectangle* pRectangle);
1516
1537 TPtxPdfNav_FitRectangleDestination* pFitRectangleDestination, TPtxGeomReal_Rectangle* pRectangle);
1538
1539/******************************************************************************
1540 * Link
1541 *****************************************************************************/
1571 TPtxPdfNav_Link* pLink);
1572
1613 TPtxGeomReal_Rectangle* pBoundingBox);
1694 TPtxPdfContent_Stroke* pBorderStyle);
1721 size_t nBufferSize);
1748 size_t nBufferSize);
1774 size_t nBufferSize);
1800 size_t nBufferSize);
1801
1816/******************************************************************************
1817 * LinkList
1818 *****************************************************************************/
1848 int iIndex);
1866 TPtxPdfNav_Link* pLink);
1867
1868/******************************************************************************
1869 * InternalLink
1870 *****************************************************************************/
1898 TPtxPdf_Document* pTargetDocument, const TPtxGeomReal_Rectangle* pBoundingBox, TPtxPdfNav_Destination* pTarget);
1929 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pActiveArea, TPtxPdfNav_Destination* pTarget);
1930
1950
1951/******************************************************************************
1952 * WebLink
1953 *****************************************************************************/
1981 TPtxPdf_Document* pTargetDocument, const TPtxGeomReal_Rectangle* pBoundingBox, const char* szUri);
2009 TPtxPdf_Document* pTargetDocument, const TPtxGeomReal_Rectangle* pBoundingBox, const WCHAR* szUri);
2042 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pActiveArea, const char* szUri);
2075 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pActiveArea, const WCHAR* szUri);
2076
2104 char* pBuffer, size_t nBufferSize);
2132 WCHAR* pBuffer, size_t nBufferSize);
2155 const char* szUri);
2178 const WCHAR* szUri);
2179
2180/******************************************************************************
2181 * EmbeddedPdfLink
2182 *****************************************************************************/
2220 TPtxPdf_FileReference* pFileReference);
2261 TPtxGeomReal_QuadrilateralList* pActiveArea,
2262 TPtxPdf_FileReference* pFileReference);
2263
2318
2319/******************************************************************************
2320 * OutlineCopyOptions
2321 *****************************************************************************/
2331
2376 TPtxPdfNav_OutlineCopyOptions* pOutlineCopyOptions, BOOL bCopyLogicalStructure);
2414 TPtxPdfNav_OutlineCopyOptions* pOutlineCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations);
2415
2416#ifdef __cplusplus
2417}
2418#endif
2419
2420#endif /* PDFTOOLS_TOOLBOX_PTXPDFNAV_H__ */
#define PDFTOOLS_TOOLBOX_EXPORT
Definition PdfTools_Toolbox_Platform.h:143
unsigned short WCHAR
Definition PdfTools_Toolbox_Platform.h:95
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LinkList_Add(TPtxPdfNav_LinkList *pLinkList, TPtxPdfNav_Link *pLink)
Add an element to the end of the list.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LinkList_GetCount(TPtxPdfNav_LinkList *pLinkList)
Get the number of elements in the list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetTop(TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pTop)
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleW(TPtxPdfNav_OutlineItem *pOutlineItem, WCHAR *pBuffer, size_t nBufferSize)
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetContentW(TPtxPdfNav_Link *pLink, WCHAR *pBuffer, size_t nBufferSize)
The content A text that shall be displayed for the link or, if this kind of link does not display tex...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitHeightDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitHeightDestination_Create(TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, BOOL bFitActualContent, const double *pLeft)
Create a new FitHeightDestination The returned object is not yet used on any page,...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetHideToolbar(TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_SetUriW(TPtxPdfNav_WebLink *pWebLink, const WCHAR *szUri)
The link target.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateA(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, const char *szUri)
Create an external link The link is associated with the pTargetDocument but not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitHeightDestination_GetLeft(TPtxPdfNav_FitHeightDestination *pFitHeightDestination, double *pLeft)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitRectangleDestination_GetRectangle(TPtxPdfNav_FitRectangleDestination *pFitRectangleDestination, TPtxGeomReal_Rectangle *pRectangle)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetItalic(TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bItalic)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_DirectDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Destination_GetTarget(TPtxPdfNav_Destination *pDestination)
The target destination For direct destinations, this is just the destination itself.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitPageDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitPageDestination_Create(TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, BOOL bFitActualContent)
Create a new FitPageDestination The returned object is not yet used on any page, but it is associated...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetBoundingBox(TPtxPdfNav_Link *pLink, TPtxGeomReal_Rectangle *pBoundingBox)
The location on the page.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Get(TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetIsOpen(TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bIsOpen)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_CreateW(TPtxPdf_Document *pTargetDocument, const WCHAR *szName, TPtxPdfNav_DirectDestination *pTarget)
Create a named destination The returned object is not yet used on any page, but it is associated with...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetDisplayDocumentTitle(TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bDisplayDocumentTitle)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_DestinationType PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Destination_GetType(TPtxPdfNav_Destination *pDestination)
Get actual derived type of base type TPtxPdfNav_Destination.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_LocationZoomDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_Create(TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, const double *pLeft, const double *pTop, const double *pZoom)
Create a new LocationZoomDestination The returned object is not yet used on any page,...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_InternalLink_GetDestination(TPtxPdfNav_InternalLink *pInternalLink)
The link target.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdfNav_OutlineItem *pOutlineItem, TPtxPdfNav_OutlineCopyOptions *pOptions)
Copy an outline item Copy an outline item object including all descendants from an input document to ...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetPageDisplay(TPtxPdfNav_ViewerSettings *pViewerSettings, const TPtxPdfNav_PageDisplay *pPageDisplay)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetLeft(TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pLeft)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_DirectDestination_GetPage(TPtxPdfNav_DirectDestination *pDirectDestination)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LinkList_Get(TPtxPdfNav_LinkList *pLinkList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleA(TPtxPdfNav_OutlineItem *pOutlineItem, char *pBuffer, size_t nBufferSize)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitPageDestination_GetFitActualContent(TPtxPdfNav_FitPageDestination *pFitPageDestination)
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetNameW(TPtxPdfNav_Link *pLink, WCHAR *pBuffer, size_t nBufferSize)
The link name A text string uniquely identifying it among all the annotations on its page.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetActivePane(TPtxPdfNav_ViewerSettings *pViewerSettings, const TPtxPdfNav_ViewerNavigationPane *pActivePane)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitRectangleDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitRectangleDestination_Create(TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, const TPtxGeomReal_Rectangle *pRectangle)
Create a new FitRectangleDestination The returned object is not yet used on any page,...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_CreateFromQuadrilaterals(TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pActiveArea, TPtxPdf_FileReference *pFileReference)
Create a link to an embedded PDF document with defined link area The link has an active area defined ...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Add(TPtxPdfNav_OutlineItemList *pOutlineItemList, TPtxPdfNav_OutlineItem *pOutlineItem)
Add an element to the end of the list.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_CreateA(TPtxPdf_Document *pTargetDocument, const char *szTitle, TPtxPdfNav_Destination *pDestination)
Create a new outline item (bookmark). The returned outline item is not yet part of the outline item t...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateFromQuadrilateralsW(TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pActiveArea, const WCHAR *szUri)
Create an external link with defined link area The link has an active area defined by the given pActi...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_ViewerSettings *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdfNav_ViewerSettings *pViewerSettings)
Copy viewer settings The newly created viewer settings are associated with the target document,...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdfNav_Link *pLink)
Copy a link from an input document to a output document.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Set(TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex, TPtxPdfNav_OutlineItem *pValue)
Update certain element in list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitWidthDestination_GetTop(TPtxPdfNav_FitWidthDestination *pFitWidthDestination, double *pTop)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_GetCopyLogicalStructure(TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions)
Copy the logical structure and tagging information.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_Create(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, TPtxPdf_FileReference *pFileReference)
Create a link to an embedded PDF document The link is associated with the pTargetDocument but not yet...
#define PDFTOOLS_TOOLBOX_CALL
Definition PdfTools_Toolbox_PtxPdfNav.h:26
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestinationCopyStrategy PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_GetNamedDestinations(TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions)
Copy strategy for named destinations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineCopyOptions *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_New(void)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_SetCopyLogicalStructure(TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions, BOOL bCopyLogicalStructure)
Copy the logical structure and tagging information.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_GetCount(TPtxPdfNav_OutlineItemList *pOutlineItemList)
Get the number of elements in the list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_GetNewWindow(TPtxPdfNav_EmbeddedPdfLink *pEmbeddedPdfLink, BOOL *pNewWindow)
The opening behavior This defines the viewer's behavior when opening the target PDF document.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetActivePane(TPtxPdfNav_ViewerSettings *pViewerSettings, TPtxPdfNav_ViewerNavigationPane *pActivePane)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_IsOpen(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_GetUriW(TPtxPdfNav_WebLink *pWebLink, WCHAR *pBuffer, size_t nBufferSize)
The link target.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetItalic(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateFromQuadrilateralsA(TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pActiveArea, const char *szUri)
Create an external link with defined link area The link has an active area defined by the given pActi...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitHeightDestination_GetFitActualContent(TPtxPdfNav_FitHeightDestination *pFitHeightDestination)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetDestination(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_DirectDestinationType PDFTOOLS_TOOLBOX_CALL PtxPdfNav_DirectDestination_GetType(TPtxPdfNav_DirectDestination *pDirectDestination)
Get actual derived type of base type TPtxPdfNav_DirectDestination.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetHidden(TPtxPdfNav_Link *pLink)
The link's visibility If TRUE then the link is present, but is invisible and not available for user i...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_FitWidthDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitWidthDestination_Create(TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, BOOL bFitActualContent, const double *pTop)
Create a new FitWidthDestination The returned object is not yet used on any page, but it is associate...
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameW(TPtxPdfNav_NamedDestination *pNamedDestination, WCHAR *pBuffer, size_t nBufferSize)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_CreateW(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, const WCHAR *szUri)
Create an external link The link is associated with the pTargetDocument but not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetFullScreen(TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_CreateA(TPtxPdf_Document *pTargetDocument, const char *szName, TPtxPdfNav_DirectDestination *pTarget)
Create a named destination The returned object is not yet used on any page, but it is associated with...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_LinkType PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetType(TPtxPdfNav_Link *pLink)
Get actual derived type of base type TPtxPdfNav_Link.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameA(TPtxPdfNav_NamedDestination *pNamedDestination, char *pBuffer, size_t nBufferSize)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_FitWidthDestination_GetFitActualContent(TPtxPdfNav_FitWidthDestination *pFitWidthDestination)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetHideMenubar(TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bHideMenubar)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItemList *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetChildren(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetContentA(TPtxPdfNav_Link *pLink, char *pBuffer, size_t nBufferSize)
The content A text that shall be displayed for the link or, if this kind of link does not display tex...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleA(TPtxPdfNav_OutlineItem *pOutlineItem, const char *szTitle)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetBold(TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bBold)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetZoom(TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pZoom)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetHideToolbar(TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bHideToolbar)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_GetBold(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleW(TPtxPdfNav_OutlineItem *pOutlineItem, const WCHAR *szTitle)
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetNameA(TPtxPdfNav_Link *pLink, char *pBuffer, size_t nBufferSize)
The link name A text string uniquely identifying it among all the annotations on its page.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_SetDestination(TPtxPdfNav_OutlineItem *pOutlineItem, TPtxPdfNav_Destination *pDestination)
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_SetBorderStyle(TPtxPdfNav_Link *pLink, TPtxPdfContent_Stroke *pBorderStyle)
The link's border This property defines if and how a rectangular border is drawn for the link.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_InternalLink_CreateFromQuadrilaterals(TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pActiveArea, TPtxPdfNav_Destination *pTarget)
Create a document-internal link with defined link area The link has an active area defined by the giv...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetPageDisplay(TPtxPdfNav_ViewerSettings *pViewerSettings, TPtxPdfNav_PageDisplay *pPageDisplay)
PDFTOOLS_TOOLBOX_EXPORT TPtxGeomReal_QuadrilateralList *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetActiveArea(TPtxPdfNav_Link *pLink)
The link area The link is activated when a mouse click falls within the area defined by this list of ...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetHideMenubar(TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_GetUriA(TPtxPdfNav_WebLink *pWebLink, char *pBuffer, size_t nBufferSize)
The link target.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Clear(TPtxPdfNav_OutlineItemList *pOutlineItemList)
Clear list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_GetDisplayDocumentTitle(TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItem_CreateW(TPtxPdf_Document *pTargetDocument, const WCHAR *szTitle, TPtxPdfNav_Destination *pDestination)
Create a new outline item (bookmark). The returned outline item is not yet part of the outline item t...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLS_TOOLBOX_CALL PtxPdfNav_InternalLink_Create(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, TPtxPdfNav_Destination *pTarget)
Create a document-internal link The link is associated with the pTargetDocument but not yet part of a...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineItemList_Remove(TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex)
Remove certain element from list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_WebLink_SetUriA(TPtxPdfNav_WebLink *pWebLink, const char *szUri)
The link target.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_SetNewWindow(TPtxPdfNav_EmbeddedPdfLink *pEmbeddedPdfLink, const BOOL *pNewWindow)
The opening behavior This defines the viewer's behavior when opening the target PDF document.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_Link_GetNoPrint(TPtxPdfNav_Link *pLink)
The link's visibility when printing If TRUE then the link is not present in a print output of the doc...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_SetNamedDestinations(TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations)
Copy strategy for named destinations.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfNav_ViewerSettings_SetFullScreen(TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bFullScreen)
TPtxPdfNav_DestinationType
Type and subtype enumeration of TPtxPdfNav_Destination.
Definition PdfTools_Toolbox_Types.h:1204
TPtxPdfNav_ViewerNavigationPane
Definition PdfTools_Toolbox_Types.h:774
TPtxPdfNav_DirectDestinationType
Type and subtype enumeration of TPtxPdfNav_DirectDestination.
Definition PdfTools_Toolbox_Types.h:1232
TPtxPdfNav_LinkType
Type and subtype enumeration of TPtxPdfNav_Link.
Definition PdfTools_Toolbox_Types.h:1257
TPtxPdfNav_NamedDestinationCopyStrategy
Definition PdfTools_Toolbox_Types.h:821
#define BOOL
Definition PdfTools_Toolbox_Types.h:23
Description of a file A file description is used for embedded files.
Definition PdfTools_Toolbox_Types.h:2189
Definition PdfTools_Toolbox_Types.h:2318