PDF Toolbox
Loading...
Searching...
No Matches
PdfToolbox_PtxPdfNav.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfToolbox_PtxPdfNav.h
4 *
5 * Description: Sub Header file for PDF Toolbox API
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2015 - 2024 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 *****************************************************************************/
13
14#ifndef PDFTOOLBOX_PTXPDFNAV_H__
15#define PDFTOOLBOX_PTXPDFNAV_H__
16
17#ifndef PDFTOOLBOX_CALL
18#if defined(WIN32)
19#define PDFTOOLBOX_CALL __stdcall
20#else
21#define PDFTOOLBOX_CALL
22#endif
23#endif
24
25#include "PdfToolbox_Types.h"
26#include "PdfToolbox_PtxSys.h"
27
28#ifdef __cplusplus
29extern "C"
30{
31#endif
32
33#ifdef _UNICODE
34#define PtxPdfNav_OutlineItem_Create PtxPdfNav_OutlineItem_CreateW
35
36#define PtxPdfNav_OutlineItem_GetTitle PtxPdfNav_OutlineItem_GetTitleW
37#define PtxPdfNav_OutlineItem_SetTitle PtxPdfNav_OutlineItem_SetTitleW
38
39#define PtxPdfNav_NamedDestination_Create PtxPdfNav_NamedDestination_CreateW
40
41#define PtxPdfNav_NamedDestination_GetName PtxPdfNav_NamedDestination_GetNameW
42
43#define PtxPdfNav_WebLink_Create PtxPdfNav_WebLink_CreateW
44#define PtxPdfNav_WebLink_CreateFromQuadrilaterals PtxPdfNav_WebLink_CreateFromQuadrilateralsW
45
46#define PtxPdfNav_WebLink_GetUri PtxPdfNav_WebLink_GetUriW
47#define PtxPdfNav_WebLink_SetUri PtxPdfNav_WebLink_SetUriW
48
49#else
50#define PtxPdfNav_OutlineItem_Create PtxPdfNav_OutlineItem_CreateA
51
52#define PtxPdfNav_OutlineItem_GetTitle PtxPdfNav_OutlineItem_GetTitleA
53#define PtxPdfNav_OutlineItem_SetTitle PtxPdfNav_OutlineItem_SetTitleA
54
55#define PtxPdfNav_NamedDestination_Create PtxPdfNav_NamedDestination_CreateA
56
57#define PtxPdfNav_NamedDestination_GetName PtxPdfNav_NamedDestination_GetNameA
58
59#define PtxPdfNav_WebLink_Create PtxPdfNav_WebLink_CreateA
60#define PtxPdfNav_WebLink_CreateFromQuadrilaterals PtxPdfNav_WebLink_CreateFromQuadrilateralsA
61
62#define PtxPdfNav_WebLink_GetUri PtxPdfNav_WebLink_GetUriA
63#define PtxPdfNav_WebLink_SetUri PtxPdfNav_WebLink_SetUriA
64
65#endif
66
67/******************************************************************************
68 * ViewerSettings
69 *****************************************************************************/
104
127 TPtxPdfNav_ViewerSettings* pViewerSettings, TPtxPdfNav_PageDisplay* pPageDisplay);
148 TPtxPdfNav_ViewerSettings* pViewerSettings, const TPtxPdfNav_PageDisplay* pPageDisplay);
171 TPtxPdfNav_ViewerSettings* pViewerSettings, TPtxPdfNav_ViewerNavigationPane* pActivePane);
192 TPtxPdfNav_ViewerSettings* pViewerSettings, const TPtxPdfNav_ViewerNavigationPane* pActivePane);
358 TPtxPdfNav_ViewerSettings* pViewerSettings, BOOL bDisplayDocumentTitle);
359
360/******************************************************************************
361 * OutlineItem
362 *****************************************************************************/
394 TPtxPdf_Document* pTargetDocument, const char* szTitle, TPtxPdfNav_Destination* pDestination);
426 TPtxPdf_Document* pTargetDocument, const WCHAR* szTitle, TPtxPdfNav_Destination* pDestination);
467 TPtxPdf_Document* pTargetDocument, TPtxPdfNav_OutlineItem* pOutlineItem, TPtxPdfNav_OutlineCopyOptions* pOptions);
468
495 char* pBuffer, size_t nBufferSize);
522 WCHAR* pBuffer, size_t nBufferSize);
544 const char* szTitle);
566 const WCHAR* szTitle);
653 BOOL bItalic);
703 TPtxPdfNav_Destination* pDestination);
751 BOOL bIsOpen);
772
773/******************************************************************************
774 * OutlineItemList
775 *****************************************************************************/
823 TPtxPdfNav_OutlineItem* pOutlineItem);
853 int iIndex);
871 int iIndex, TPtxPdfNav_OutlineItem* pValue);
872
873/******************************************************************************
874 * Destination
875 *****************************************************************************/
898
914/******************************************************************************
915 * NamedDestination
916 *****************************************************************************/
945 TPtxPdf_Document* pTargetDocument, const char* szName, TPtxPdfNav_DirectDestination* pTarget);
974 TPtxPdf_Document* pTargetDocument, const WCHAR* szName, TPtxPdfNav_DirectDestination* pTarget);
975
1000PtxPdfNav_NamedDestination_GetNameA(TPtxPdfNav_NamedDestination* pNamedDestination, char* pBuffer, size_t nBufferSize);
1025PtxPdfNav_NamedDestination_GetNameW(TPtxPdfNav_NamedDestination* pNamedDestination, WCHAR* pBuffer, size_t nBufferSize);
1026
1027/******************************************************************************
1028 * DirectDestination
1029 *****************************************************************************/
1052
1068/******************************************************************************
1069 * LocationZoomDestination
1070 *****************************************************************************/
1109PtxPdfNav_LocationZoomDestination_Create(TPtxPdf_Document* pTargetDocument, TPtxPdf_Page* pPage, const double* pLeft,
1110 const double* pTop, const double* pZoom);
1111
1209
1210/******************************************************************************
1211 * FitPageDestination
1212 *****************************************************************************/
1243PtxPdfNav_FitPageDestination_Create(TPtxPdf_Document* pTargetDocument, TPtxPdf_Page* pPage, BOOL bFitActualContent);
1244
1271
1272/******************************************************************************
1273 * FitWidthDestination
1274 *****************************************************************************/
1305PtxPdfNav_FitWidthDestination_Create(TPtxPdf_Document* pTargetDocument, TPtxPdf_Page* pPage, BOOL bFitActualContent);
1306
1333
1334/******************************************************************************
1335 * FitHeightDestination
1336 *****************************************************************************/
1368
1396
1397/******************************************************************************
1398 * FitRectangleDestination
1399 *****************************************************************************/
1431 TPtxPdf_Document* pTargetDocument, TPtxPdf_Page* pPage, const TPtxGeomReal_Rectangle* pRectangle);
1432
1453 TPtxPdfNav_FitRectangleDestination* pFitRectangleDestination, TPtxGeomReal_Rectangle* pRectangle);
1454
1455/******************************************************************************
1456 * Link
1457 *****************************************************************************/
1487 TPtxPdfNav_Link* pLink);
1488
1528 TPtxGeomReal_Rectangle* pBoundingBox);
1609 TPtxPdfContent_Stroke* pBorderStyle);
1610
1625/******************************************************************************
1626 * LinkList
1627 *****************************************************************************/
1674
1675/******************************************************************************
1676 * InternalLink
1677 *****************************************************************************/
1705 TPtxPdf_Document* pTargetDocument, const TPtxGeomReal_Rectangle* pBoundingBox, TPtxPdfNav_Destination* pTarget);
1736 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pActiveArea, TPtxPdfNav_Destination* pTarget);
1737
1757
1758/******************************************************************************
1759 * WebLink
1760 *****************************************************************************/
1788 TPtxPdf_Document* pTargetDocument, const TPtxGeomReal_Rectangle* pBoundingBox, const char* szUri);
1816 TPtxPdf_Document* pTargetDocument, const TPtxGeomReal_Rectangle* pBoundingBox, const WCHAR* szUri);
1849 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pActiveArea, const char* szUri);
1882 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pActiveArea, const WCHAR* szUri);
1883
1911 size_t nBufferSize);
1939 size_t nBufferSize);
1984
1985/******************************************************************************
1986 * EmbeddedPdfLink
1987 *****************************************************************************/
2025 TPtxPdf_FileReference* pFileReference);
2065 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pActiveArea,
2066 TPtxPdf_FileReference* pFileReference);
2067
2122
2123/******************************************************************************
2124 * OutlineCopyOptions
2125 *****************************************************************************/
2135
2180 TPtxPdfNav_OutlineCopyOptions* pOutlineCopyOptions, BOOL bCopyLogicalStructure);
2218 TPtxPdfNav_OutlineCopyOptions* pOutlineCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations);
2219
2220#ifdef __cplusplus
2221}
2222#endif
2223
2224#endif /* PDFTOOLBOX_PTXPDFNAV_H__ */
unsigned short WCHAR
Definition PdfToolbox_Platform.h:90
#define PDFTOOLBOX_EXPORT
Definition PdfToolbox_Platform.h:138
PDFTOOLBOX_EXPORT TPtxPdfNav_DirectDestinationType PDFTOOLBOX_CALL PtxPdfNav_DirectDestination_GetType(TPtxPdfNav_DirectDestination *pDirectDestination)
Get actual derived type of base type TPtxPdfNav_DirectDestination.
PDFTOOLBOX_EXPORT TPtxPdfNav_FitWidthDestination *PDFTOOLBOX_CALL PtxPdfNav_FitWidthDestination_Create(TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, BOOL bFitActualContent)
Create a new FitWidthDestination The returned object is not yet used on any page, but it is associate...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetItalic(TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bItalic)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_WebLink_SetUriW(TPtxPdfNav_WebLink *pWebLink, const WCHAR *szUri)
The link target.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_GetCount(TPtxPdfNav_OutlineItemList *pOutlineItemList)
Get the number of elements in the list.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameA(TPtxPdfNav_NamedDestination *pNamedDestination, char *pBuffer, size_t nBufferSize)
#define PDFTOOLBOX_CALL
Definition PdfToolbox_PtxPdfNav.h:21
PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItemList *PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetChildren(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Add(TPtxPdfNav_OutlineItemList *pOutlineItemList, TPtxPdfNav_OutlineItem *pOutlineItem)
Add an element to the end of the list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetDestination(TPtxPdfNav_OutlineItem *pOutlineItem, TPtxPdfNav_Destination *pDestination)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_GetHideMenubar(TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_FitRectangleDestination_GetRectangle(TPtxPdfNav_FitRectangleDestination *pFitRectangleDestination, TPtxGeomReal_Rectangle *pRectangle)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_SetActivePane(TPtxPdfNav_ViewerSettings *pViewerSettings, const TPtxPdfNav_ViewerNavigationPane *pActivePane)
PDFTOOLBOX_EXPORT TPtxPdfNav_FitHeightDestination *PDFTOOLBOX_CALL PtxPdfNav_FitHeightDestination_Create(TPtxPdf_Document *pTargetDocument, TPtxPdf_Page *pPage, BOOL bFitActualContent)
Create a new FitHeightDestination The returned object is not yet used on any page,...
PDFTOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLBOX_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 ...
PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestinationCopyStrategy PDFTOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_GetNamedDestinations(TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions)
Copy strategy for named destinations.
PDFTOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLBOX_CALL PtxPdfNav_InternalLink_GetDestination(TPtxPdfNav_InternalLink *pInternalLink)
The link target.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Set(TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex, TPtxPdfNav_OutlineItem *pValue)
Update certain element in list.
PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_SetFullScreen(TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bFullScreen)
PDFTOOLBOX_EXPORT TPtxPdfNav_NamedDestination *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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....
PDFTOOLBOX_EXPORT TPtxPdfNav_DirectDestination *PDFTOOLBOX_CALL PtxPdfNav_Destination_GetTarget(TPtxPdfNav_Destination *pDestination)
The target destination For direct destinations, this is just the destination itself.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetTop(TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pTop)
PDFTOOLBOX_EXPORT TPtxGeomReal_QuadrilateralList *PDFTOOLBOX_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 ...
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfNav_EmbeddedPdfLink *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_GetPageDisplay(TPtxPdfNav_ViewerSettings *pViewerSettings, TPtxPdfNav_PageDisplay *pPageDisplay)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetBold(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_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 ...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_SetHideToolbar(TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bHideToolbar)
PDFTOOLBOX_EXPORT TPtxPdfNav_Destination *PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetDestination(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleA(TPtxPdfNav_OutlineItem *pOutlineItem, const char *szTitle)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_SetHideMenubar(TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bHideMenubar)
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_WebLink_GetUriA(TPtxPdfNav_WebLink *pWebLink, char *pBuffer, size_t nBufferSize)
The link target.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_IsOpen(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_WebLink_GetUriW(TPtxPdfNav_WebLink *pWebLink, WCHAR *pBuffer, size_t nBufferSize)
The link target.
PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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....
PDFTOOLBOX_EXPORT TPtxPdf_Page *PDFTOOLBOX_CALL PtxPdfNav_DirectDestination_GetPage(TPtxPdfNav_DirectDestination *pDirectDestination)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_Link_GetBoundingBox(TPtxPdfNav_Link *pLink, TPtxGeomReal_Rectangle *pBoundingBox)
The location on the page.
PDFTOOLBOX_EXPORT TPtxPdfNav_FitRectangleDestination *PDFTOOLBOX_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,...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_WebLink_SetUriA(TPtxPdfNav_WebLink *pWebLink, const char *szUri)
The link target.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_SetDisplayDocumentTitle(TPtxPdfNav_ViewerSettings *pViewerSettings, BOOL bDisplayDocumentTitle)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_FitPageDestination_GetFitActualContent(TPtxPdfNav_FitPageDestination *pFitPageDestination)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Clear(TPtxPdfNav_OutlineItemList *pOutlineItemList)
Clear list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_GetActivePane(TPtxPdfNav_ViewerSettings *pViewerSettings, TPtxPdfNav_ViewerNavigationPane *pActivePane)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetZoom(TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pZoom)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_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.
PDFTOOLBOX_EXPORT TPtxPdfNav_LocationZoomDestination *PDFTOOLBOX_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,...
PDFTOOLBOX_EXPORT TPtxPdfNav_DestinationType PDFTOOLBOX_CALL PtxPdfNav_Destination_GetType(TPtxPdfNav_Destination *pDestination)
Get actual derived type of base type TPtxPdfNav_Destination.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_SetNamedDestinations(TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions, TPtxPdfNav_NamedDestinationCopyStrategy iNamedDestinations)
Copy strategy for named destinations.
PDFTOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLBOX_CALL PtxPdfNav_Link_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdfNav_Link *pLink)
Copy a link from an input document to a output document.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_GetCopyLogicalStructure(TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions)
Copy the logical structure and tagging information.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_SetCopyLogicalStructure(TPtxPdfNav_OutlineCopyOptions *pOutlineCopyOptions, BOOL bCopyLogicalStructure)
Copy the logical structure and tagging information.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_EmbeddedPdfLink_GetNewWindow(TPtxPdfNav_EmbeddedPdfLink *pEmbeddedPdfLink, BOOL *pNewWindow)
The opening behavior This defines the viewer's behavior when opening the target PDF document.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_GetDisplayDocumentTitle(TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetItalic(TPtxPdfNav_OutlineItem *pOutlineItem)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Remove(TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex)
Remove certain element from list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetBold(TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bBold)
PDFTOOLBOX_EXPORT TPtxPdfNav_LinkType PDFTOOLBOX_CALL PtxPdfNav_Link_GetType(TPtxPdfNav_Link *pLink)
Get actual derived type of base type TPtxPdfNav_Link.
PDFTOOLBOX_EXPORT TPtxPdfNav_FitPageDestination *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_SetPageDisplay(TPtxPdfNav_ViewerSettings *pViewerSettings, const TPtxPdfNav_PageDisplay *pPageDisplay)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_FitHeightDestination_GetFitActualContent(TPtxPdfNav_FitHeightDestination *pFitHeightDestination)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_LinkList_Add(TPtxPdfNav_LinkList *pLinkList, TPtxPdfNav_Link *pLink)
Add an element to the end of the list.
PDFTOOLBOX_EXPORT TPtxPdfNav_ViewerSettings *PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdfNav_ViewerSettings *pViewerSettings)
Copy viewer settings The newly created viewer settings are associated with the target document,...
PDFTOOLBOX_EXPORT TPtxPdfNav_Link *PDFTOOLBOX_CALL PtxPdfNav_LinkList_Get(TPtxPdfNav_LinkList *pLinkList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleW(TPtxPdfNav_OutlineItem *pOutlineItem, WCHAR *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_NamedDestination_GetNameW(TPtxPdfNav_NamedDestination *pNamedDestination, WCHAR *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_GetTitleA(TPtxPdfNav_OutlineItem *pOutlineItem, char *pBuffer, size_t nBufferSize)
PDFTOOLBOX_EXPORT TPtxPdfNav_WebLink *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineCopyOptions *PDFTOOLBOX_CALL PtxPdfNav_OutlineCopyOptions_New(void)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetTitleW(TPtxPdfNav_OutlineItem *pOutlineItem, const WCHAR *szTitle)
PDFTOOLBOX_EXPORT TPtxPdfNav_InternalLink *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_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...
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_GetHideToolbar(TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_FitWidthDestination_GetFitActualContent(TPtxPdfNav_FitWidthDestination *pFitWidthDestination)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_LocationZoomDestination_GetLeft(TPtxPdfNav_LocationZoomDestination *pLocationZoomDestination, double *pLeft)
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_ViewerSettings_GetFullScreen(TPtxPdfNav_ViewerSettings *pViewerSettings)
PDFTOOLBOX_EXPORT TPtxPdfNav_OutlineItem *PDFTOOLBOX_CALL PtxPdfNav_OutlineItemList_Get(TPtxPdfNav_OutlineItemList *pOutlineItemList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfNav_LinkList_GetCount(TPtxPdfNav_LinkList *pLinkList)
Get the number of elements in the list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfNav_OutlineItem_SetIsOpen(TPtxPdfNav_OutlineItem *pOutlineItem, BOOL bIsOpen)
TPtxPdfNav_DestinationType
Type and subtype enumeration of TPtxPdfNav_Destination.
Definition PdfToolbox_Types.h:1100
TPtxPdfNav_ViewerNavigationPane
Definition PdfToolbox_Types.h:676
TPtxPdfNav_DirectDestinationType
Type and subtype enumeration of TPtxPdfNav_DirectDestination.
Definition PdfToolbox_Types.h:1128
TPtxPdfNav_LinkType
Type and subtype enumeration of TPtxPdfNav_Link.
Definition PdfToolbox_Types.h:1153
TPtxPdfNav_NamedDestinationCopyStrategy
Definition PdfToolbox_Types.h:721
#define BOOL
Definition PdfToolbox_Types.h:18
Description of a file A file description is used for embedded files.
Definition PdfToolbox_Types.h:1998
Definition PdfToolbox_Types.h:2127