PDF Toolbox
Loading...
Searching...
No Matches
PdfTools_Toolbox_PtxPdfAnnots.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_Toolbox_PtxPdfAnnots.h
4 *
5 * Description: Sub Header file for Toolbox SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2024 - 2024 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_PTXPDFANNOTS_H__
20#define PDFTOOLS_TOOLBOX_PTXPDFANNOTS_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 PtxPdfAnnots_Annotation_GetId PtxPdfAnnots_Annotation_GetIdW
40
41#define PtxPdfAnnots_MarkupInfo_GetAuthor PtxPdfAnnots_MarkupInfo_GetAuthorW
42#define PtxPdfAnnots_MarkupInfo_SetAuthor PtxPdfAnnots_MarkupInfo_SetAuthorW
43#define PtxPdfAnnots_MarkupInfo_GetSubject PtxPdfAnnots_MarkupInfo_GetSubjectW
44#define PtxPdfAnnots_MarkupInfo_SetSubject PtxPdfAnnots_MarkupInfo_SetSubjectW
45#define PtxPdfAnnots_MarkupInfo_GetContent PtxPdfAnnots_MarkupInfo_GetContentW
46#define PtxPdfAnnots_MarkupInfo_SetContent PtxPdfAnnots_MarkupInfo_SetContentW
47
48#define PtxPdfAnnots_StickyNote_Create PtxPdfAnnots_StickyNote_CreateW
49
50#define PtxPdfAnnots_TextStamp_CreateRaw PtxPdfAnnots_TextStamp_CreateRawW
51
52#define PtxPdfAnnots_FreeText_Create PtxPdfAnnots_FreeText_CreateW
53
54#else
55#define PtxPdfAnnots_Annotation_GetId PtxPdfAnnots_Annotation_GetIdA
56
57#define PtxPdfAnnots_MarkupInfo_GetAuthor PtxPdfAnnots_MarkupInfo_GetAuthorA
58#define PtxPdfAnnots_MarkupInfo_SetAuthor PtxPdfAnnots_MarkupInfo_SetAuthorA
59#define PtxPdfAnnots_MarkupInfo_GetSubject PtxPdfAnnots_MarkupInfo_GetSubjectA
60#define PtxPdfAnnots_MarkupInfo_SetSubject PtxPdfAnnots_MarkupInfo_SetSubjectA
61#define PtxPdfAnnots_MarkupInfo_GetContent PtxPdfAnnots_MarkupInfo_GetContentA
62#define PtxPdfAnnots_MarkupInfo_SetContent PtxPdfAnnots_MarkupInfo_SetContentA
63
64#define PtxPdfAnnots_StickyNote_Create PtxPdfAnnots_StickyNote_CreateA
65
66#define PtxPdfAnnots_TextStamp_CreateRaw PtxPdfAnnots_TextStamp_CreateRawA
67
68#define PtxPdfAnnots_FreeText_Create PtxPdfAnnots_FreeText_CreateA
69
70#endif
71
72/******************************************************************************
73 * Annotation
74 *****************************************************************************/
109
236PtxPdfAnnots_Annotation_GetIdA(TPtxPdfAnnots_Annotation* pAnnotation, char* pBuffer, size_t nBufferSize);
263PtxPdfAnnots_Annotation_GetIdW(TPtxPdfAnnots_Annotation* pAnnotation, WCHAR* pBuffer, size_t nBufferSize);
264
280/******************************************************************************
281 * AnnotationList
282 *****************************************************************************/
332
333/******************************************************************************
334 * MarkupInfo
335 *****************************************************************************/
423 TPtxPdfAnnots_MarkupInfo* pMarkupInfo, const TPtxSys_Date* pModificationDate);
498PtxPdfAnnots_MarkupInfo_GetAuthorA(TPtxPdfAnnots_MarkupInfo* pMarkupInfo, char* pBuffer, size_t nBufferSize);
526PtxPdfAnnots_MarkupInfo_GetAuthorW(TPtxPdfAnnots_MarkupInfo* pMarkupInfo, WCHAR* pBuffer, size_t nBufferSize);
596PtxPdfAnnots_MarkupInfo_GetSubjectA(TPtxPdfAnnots_MarkupInfo* pMarkupInfo, char* pBuffer, size_t nBufferSize);
624PtxPdfAnnots_MarkupInfo_GetSubjectW(TPtxPdfAnnots_MarkupInfo* pMarkupInfo, WCHAR* pBuffer, size_t nBufferSize);
694PtxPdfAnnots_MarkupInfo_GetContentA(TPtxPdfAnnots_MarkupInfo* pMarkupInfo, char* pBuffer, size_t nBufferSize);
722PtxPdfAnnots_MarkupInfo_GetContentW(TPtxPdfAnnots_MarkupInfo* pMarkupInfo, WCHAR* pBuffer, size_t nBufferSize);
765
766/******************************************************************************
767 * MarkupInfoList
768 *****************************************************************************/
800
801/******************************************************************************
802 * Popup
803 *****************************************************************************/
838
839/******************************************************************************
840 * MarkupAnnotation
841 *****************************************************************************/
896
912/******************************************************************************
913 * StickyNote
914 *****************************************************************************/
950 const char* szContent, TPtxPdfContent_Paint* pPaint);
986 const WCHAR* szContent, TPtxPdfContent_Paint* pPaint);
987
1026
1027/******************************************************************************
1028 * FileAttachment
1029 *****************************************************************************/
1071 TPtxPdf_FileReference* pAttachedFile, TPtxPdfContent_Paint* pPaint);
1072
1147
1148/******************************************************************************
1149 * Stamp
1150 *****************************************************************************/
1189
1205/******************************************************************************
1206 * TextStamp
1207 *****************************************************************************/
1245 const double* pHeight, TPtxPdfAnnots_TextStampType iTextType, const char* szText);
1283 const double* pHeight, TPtxPdfAnnots_TextStampType iTextType, const WCHAR* szText);
1316 const double* pHeight, TPtxPdfAnnots_TextStampType iTextType);
1317
1337
1338/******************************************************************************
1339 * CustomStamp
1340 *****************************************************************************/
1367
1385
1386/******************************************************************************
1387 * FreeText
1388 *****************************************************************************/
1446 const char* szContent, TPtxPdfContent_Paint* pPaint, TPtxPdfContent_Stroke* pStroke);
1504 const WCHAR* szContent, TPtxPdfContent_Paint* pPaint, TPtxPdfContent_Stroke* pStroke);
1505
1557 double dFontSize);
1594
1595/******************************************************************************
1596 * DrawingAnnotation
1597 *****************************************************************************/
1636
1652/******************************************************************************
1653 * LineAnnotation
1654 *****************************************************************************/
1707 const TPtxGeomReal_Point* pEnd, TPtxPdfContent_Stroke* pStroke);
1708
1796
1797/******************************************************************************
1798 * InkAnnotation
1799 *****************************************************************************/
1860 TPtxPdf_Document* pTargetDocument, TPtxPdfContent_Path* pPath, TPtxPdfContent_Stroke* pStroke);
1861
1862/******************************************************************************
1863 * PolyLineAnnotation
1864 *****************************************************************************/
1925 TPtxPdf_Document* pTargetDocument, TPtxPdfContent_Path* pPath, TPtxPdfContent_Stroke* pStroke);
1926
1981
1982/******************************************************************************
1983 * PolygonAnnotation
1984 *****************************************************************************/
2061
2079
2080/******************************************************************************
2081 * RectangleAnnotation
2082 *****************************************************************************/
2146
2165
2166/******************************************************************************
2167 * EllipseAnnotation
2168 *****************************************************************************/
2232
2250
2251/******************************************************************************
2252 * TextMarkup
2253 *****************************************************************************/
2313
2329/******************************************************************************
2330 * Highlight
2331 *****************************************************************************/
2369 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pMarkupArea, TPtxPdfContent_Paint* pPaint);
2370
2371/******************************************************************************
2372 * Underline
2373 *****************************************************************************/
2411 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pMarkupArea, TPtxPdfContent_Paint* pPaint);
2412
2413/******************************************************************************
2414 * StrikeThrough
2415 *****************************************************************************/
2454 TPtxGeomReal_QuadrilateralList* pMarkupArea,
2455 TPtxPdfContent_Paint* pPaint);
2456
2457/******************************************************************************
2458 * Squiggly
2459 *****************************************************************************/
2497 TPtxPdf_Document* pTargetDocument, TPtxGeomReal_QuadrilateralList* pMarkupArea, TPtxPdfContent_Paint* pPaint);
2498
2499/******************************************************************************
2500 * TextInsert
2501 *****************************************************************************/
2540
2541#ifdef __cplusplus
2542}
2543#endif
2544
2545#endif /* PDFTOOLS_TOOLBOX_PTXPDFANNOTS_H__ */
#define PDFTOOLS_TOOLBOX_EXPORT
Definition PdfTools_Toolbox_Platform.h:143
unsigned short WCHAR
Definition PdfTools_Toolbox_Platform.h:95
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetEndStyle(TPtxPdfAnnots_LineAnnotation *pLineAnnotation)
The ending point's style.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_AnnotationList_Add(TPtxPdfAnnots_AnnotationList *pAnnotationList, TPtxPdfAnnots_Annotation *pAnnotation)
Add an element to the end of the list.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_GetEndStyle(TPtxPdfAnnots_PolyLineAnnotation *pPolyLineAnnotation)
The ending point's style.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetAuthorA(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, char *pBuffer, size_t nBufferSize)
The author.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetLocked(TPtxPdfAnnots_MarkupInfo *pMarkupInfo)
Whether the content can be modified This does not restrict the modification of other aspects of the a...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetLocked(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, BOOL bLocked)
Whether the content can be modified This does not restrict the modification of other aspects of the a...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_EllipseAnnotation_GetFill(TPtxPdfAnnots_EllipseAnnotation *pEllipseAnnotation)
The filling paint.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_DrawingAnnotationType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_DrawingAnnotation_GetType(TPtxPdfAnnots_DrawingAnnotation *pDrawingAnnotation)
Get actual derived type of base type TPtxPdfAnnots_DrawingAnnotation.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupAnnotationType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetType(TPtxPdfAnnots_MarkupAnnotation *pMarkupAnnotation)
Get actual derived type of base type TPtxPdfAnnots_MarkupAnnotation.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetPaint(TPtxPdfAnnots_TextMarkup *pTextMarkup)
The paint the annotation and the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StrikeThrough *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StrikeThrough_CreateFromQuadrilaterals(TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pMarkupArea, TPtxPdfContent_Paint *pPaint)
Create a new strike-through with defined area The area to be striked through is defined by the given ...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetModificationDate(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const TPtxSys_Date *pModificationDate)
The date of last modification.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_RectangleAnnotation_GetFill(TPtxPdfAnnots_RectangleAnnotation *pRectangleAnnotation)
The filling paint.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FreeText *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_CreateW(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, const WCHAR *szContent, TPtxPdfContent_Paint *pPaint, TPtxPdfContent_Stroke *pStroke)
Create a free-text annotation. The returned free-text annotation is not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetCreationDate(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, TPtxSys_Date *pCreationDate)
The date of creation.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetStartStyle(TPtxPdfAnnots_LineAnnotation *pLineAnnotation)
The starting point's style.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetModificationDate(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, TPtxSys_Date *pModificationDate)
The date of last modification.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextMarkupType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetType(TPtxPdfAnnots_TextMarkup *pTextMarkup)
Get actual derived type of base type TPtxPdfAnnots_TextMarkup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_AnnotationType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetType(TPtxPdfAnnots_Annotation *pAnnotation)
Get actual derived type of base type TPtxPdfAnnots_Annotation.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetAuthorW(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const WCHAR *szAuthor)
The author.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_PolyLineAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_Create(TPtxPdf_Document *pTargetDocument, TPtxPdfContent_Path *pPath, TPtxPdfContent_Stroke *pStroke)
Create a poly-line annotation. The returned poly-line annotation is not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetNoRotate(TPtxPdfAnnots_Annotation *pAnnotation)
The annotation's rotation behavior If TRUE then the annotation's visual appearance does not rotate wi...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StickyNote_GetPopup(TPtxPdfAnnots_StickyNote *pStickyNote)
The pop-up.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetPaint(TPtxPdfAnnots_FileAttachment *pFileAttachment)
The paint for the icon and the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolygonAnnotation_GetFill(TPtxPdfAnnots_PolygonAnnotation *pPolygonAnnotation)
The filling paint.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetContentA(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, char *pBuffer, size_t nBufferSize)
The information content.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetIdA(TPtxPdfAnnots_Annotation *pAnnotation, char *pBuffer, size_t nBufferSize)
The annotation identifier A text string uniquely identifying it among all the annotations on its page...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Group *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_CustomStamp_GetAppearance(TPtxPdfAnnots_CustomStamp *pCustomStamp)
The custom stamp's visual appearance.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetSubjectA(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const char *szSubject)
The subject.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StampType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Stamp_GetType(TPtxPdfAnnots_Stamp *pStamp)
Get actual derived type of base type TPtxPdfAnnots_Stamp.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdf_FileReference *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetAttachedFile(TPtxPdfAnnots_FileAttachment *pFileAttachment)
The embedded file.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Stamp_GetPopup(TPtxPdfAnnots_Stamp *pStamp)
The pop-up.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStampType PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextStamp_GetTextType(TPtxPdfAnnots_TextStamp *pTextStamp)
The displayed text This defines a predefined text for this text stamp.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetPopup(TPtxPdfAnnots_TextMarkup *pTextMarkup)
The pop-up.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetAuthorA(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const char *szAuthor)
The author.
PDFTOOLS_TOOLBOX_EXPORT TPtxGeomReal_QuadrilateralList *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextMarkup_GetMarkupArea(TPtxPdfAnnots_TextMarkup *pTextMarkup)
The markup area This list of TPtxGeomReal_Quadrilaterals defines the markup area on the page.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetNoPrint(TPtxPdfAnnots_Annotation *pAnnotation)
The annotation's visibility when printing If TRUE then the annotation is not present in a print outpu...
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetSubjectA(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, char *pBuffer, size_t nBufferSize)
The subject.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetHidden(TPtxPdfAnnots_Annotation *pAnnotation)
The annotation's visibility If TRUE then the annotation is present, but is invisible and not availabl...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_Create(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pStart, const TPtxGeomReal_Point *pEnd, TPtxPdfContent_Stroke *pStroke)
Create a line annotation. The returned line annotation is not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetLocked(TPtxPdfAnnots_MarkupAnnotation *pMarkupAnnotation)
Whether the markup annotation can be modified This does not restrict modification of the markup annot...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Popup_GetBoundingBox(TPtxPdfAnnots_Popup *pPopup, TPtxGeomReal_Rectangle *pBoundingBox)
The pop-up location.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StickyNote *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StickyNote_CreateW(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const WCHAR *szContent, TPtxPdfContent_Paint *pPaint)
Create a sticky note annotation. The returned sticky note annotation is not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfo *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfoList_Get(TPtxPdfAnnots_MarkupInfoList *pMarkupInfoList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_StickyNote *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StickyNote_CreateA(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const char *szContent, TPtxPdfContent_Paint *pPaint)
Create a sticky note annotation. The returned sticky note annotation is not yet part of any page....
#define PDFTOOLS_TOOLBOX_CALL
Definition PdfTools_Toolbox_PtxPdfAnnots.h:26
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Highlight *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Highlight_CreateFromQuadrilaterals(TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pMarkupArea, TPtxPdfContent_Paint *pPaint)
Create a new highlight with defined area The highlight area is defined by the given pMarkupArea....
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetBoundingBox(TPtxPdfAnnots_Annotation *pAnnotation, TPtxGeomReal_Rectangle *pBoundingBox)
The location on the page.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_InkAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_InkAnnotation_Create(TPtxPdf_Document *pTargetDocument, TPtxPdfContent_Path *pPath, TPtxPdfContent_Stroke *pStroke)
Create a ink annotation. The returned ink annotation is not yet part of any page. It can be added to ...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetPopup(TPtxPdfAnnots_FileAttachment *pFileAttachment)
The pop-up.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfoList *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetReplies(TPtxPdfAnnots_MarkupAnnotation *pMarkupAnnotation)
The replies to this markup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FileAttachmentIcon PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_GetIcon(TPtxPdfAnnots_FileAttachment *pFileAttachment)
The displayed icon.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_MarkupInfo *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupAnnotation_GetInfo(TPtxPdfAnnots_MarkupAnnotation *pMarkupAnnotation)
The information content of this markup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_PolygonAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolygonAnnotation_Create(TPtxPdf_Document *pTargetDocument, TPtxPdfContent_Path *pPath, TPtxPdfContent_Stroke *pStroke, TPtxPdfContent_Paint *pFill)
Create a polygon annotation. The returned polygon annotation is not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextStamp_Create(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const double *pHeight, TPtxPdfAnnots_TextStampType iTextType)
Create a text stamp annotation. The width of the annotation is computed based on the given iTextType....
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Stamp_GetPopupPaint(TPtxPdfAnnots_Stamp *pStamp)
The paint for the popup.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetIdW(TPtxPdfAnnots_Annotation *pAnnotation, WCHAR *pBuffer, size_t nBufferSize)
The annotation identifier A text string uniquely identifying it among all the annotations on its page...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetContentA(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const char *szContent)
The information content.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetSubjectW(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, WCHAR *pBuffer, size_t nBufferSize)
The subject.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_AnnotationList_GetCount(TPtxPdfAnnots_AnnotationList *pAnnotationList)
Get the number of elements in the list.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_SetFontSize(TPtxPdfAnnots_FreeText *pFreeText, double dFontSize)
The font size.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetSubjectW(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const WCHAR *szSubject)
The subject.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_GetNoZoom(TPtxPdfAnnots_Annotation *pAnnotation)
The annotation's scaling behavior If TRUE then the annotation's visual appearance does not scale with...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_DrawingAnnotation_GetPopup(TPtxPdfAnnots_DrawingAnnotation *pDrawingAnnotation)
The pop-up.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextInsert_GetPaint(TPtxPdfAnnots_TextInsert *pTextInsert)
The paint for the annotation and the popup.
PDFTOOLS_TOOLBOX_EXPORT double PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_GetFontSize(TPtxPdfAnnots_FreeText *pFreeText)
The font size.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextStamp_CreateRawA(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const double *pHeight, TPtxPdfAnnots_TextStampType iTextType, const char *szText)
Create a text stamp annotation. The width of the annotation is computed from the given stamp text....
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_StickyNote_GetPaint(TPtxPdfAnnots_StickyNote *pStickyNote)
The paint for the icon and the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_EllipseAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_EllipseAnnotation_Create(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, TPtxPdfContent_Stroke *pStroke, TPtxPdfContent_Paint *pFill)
Create an ellipse annotation. The returned ellipse annotation is not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Popup_IsOpen(TPtxPdfAnnots_Popup *pPopup)
The pop-up's visibility state.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetStart(TPtxPdfAnnots_LineAnnotation *pLineAnnotation, TPtxGeomReal_Point *pStart)
The line's starting point.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetAuthorW(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, WCHAR *pBuffer, size_t nBufferSize)
The author.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Popup *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextInsert_GetPopup(TPtxPdfAnnots_TextInsert *pTextInsert)
The pop-up.
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_GetContentW(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, WCHAR *pBuffer, size_t nBufferSize)
The information content.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetCreationDate(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const TPtxSys_Date *pCreationDate)
The date of creation.
PDFTOOLS_TOOLBOX_EXPORT TPtxGeom_HorizontalAlignment PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_GetAlignment(TPtxPdfAnnots_FreeText *pFreeText)
The text alignment.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetLineEndingFill(TPtxPdfAnnots_LineAnnotation *pLineAnnotation)
The line ending filling paint This paint applies to both the starting end the ending point.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_LineAnnotation_GetEnd(TPtxPdfAnnots_LineAnnotation *pLineAnnotation, TPtxGeomReal_Point *pEnd)
The line's ending point.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FileAttachment *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FileAttachment_Create(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, TPtxPdf_FileReference *pAttachedFile, TPtxPdfContent_Paint *pPaint)
Create a file attachment annotation. The returned file attachment annotation is not yet part of any p...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Annotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Annotation_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdfAnnots_Annotation *pAnnotation)
Copy an annotation Copy an annotation object from an input document to the given pTargetDocument....
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_FreeText *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_CreateA(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, const char *szContent, TPtxPdfContent_Paint *pPaint, TPtxPdfContent_Stroke *pStroke)
Create a free-text annotation. The returned free-text annotation is not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_GetLineEndingFill(TPtxPdfAnnots_PolyLineAnnotation *pPolyLineAnnotation)
The line ending filling paint for both start and end.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Squiggly *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Squiggly_CreateFromQuadrilaterals(TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pMarkupArea, TPtxPdfContent_Paint *pPaint)
Create a new squiggly underline with defined area The area to be underlined is defined by the given p...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Annotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_AnnotationList_Get(TPtxPdfAnnots_AnnotationList *pAnnotationList, int iIndex)
Returns the element at the specified position in the given list.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_LineEnding PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_PolyLineAnnotation_GetStartStyle(TPtxPdfAnnots_PolyLineAnnotation *pPolyLineAnnotation)
The starting point's style.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfo_SetContentW(TPtxPdfAnnots_MarkupInfo *pMarkupInfo, const WCHAR *szContent)
The information content.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_CustomStamp *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_CustomStamp_Create(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox)
Create a custom stamp annotation. The returned custom stamp annotation's appearance has an empty cont...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_TextStamp *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_TextStamp_CreateRawW(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Point *pTopLeft, const double *pHeight, TPtxPdfAnnots_TextStampType iTextType, const WCHAR *szText)
Create a text stamp annotation. The width of the annotation is computed from the given stamp text....
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_Underline *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_Underline_CreateFromQuadrilaterals(TPtxPdf_Document *pTargetDocument, TPtxGeomReal_QuadrilateralList *pMarkupArea, TPtxPdfContent_Paint *pPaint)
Create a new underline with defined area The area to be underlined is defined by the given pMarkupAre...
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_DrawingAnnotation_GetPaint(TPtxPdfAnnots_DrawingAnnotation *pDrawingAnnotation)
The paint for line stroking and for the popup.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfAnnots_RectangleAnnotation *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_RectangleAnnotation_Create(TPtxPdf_Document *pTargetDocument, const TPtxGeomReal_Rectangle *pBoundingBox, TPtxPdfContent_Stroke *pStroke, TPtxPdfContent_Paint *pFill)
Create a rectangle annotation. The returned rectangle annotation is not yet part of any page....
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfContent_Paint *PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_FreeText_GetPaint(TPtxPdfAnnots_FreeText *pFreeText)
The paint for the text background and the popup.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfAnnots_MarkupInfoList_GetCount(TPtxPdfAnnots_MarkupInfoList *pMarkupInfoList)
Get the number of elements in the list.
TPtxPdfAnnots_MarkupAnnotationType
Type and subtype enumeration of TPtxPdfAnnots_MarkupAnnotation.
Definition PdfTools_Toolbox_Types.h:1271
TPtxPdfAnnots_DrawingAnnotationType
Type and subtype enumeration of TPtxPdfAnnots_DrawingAnnotation.
Definition PdfTools_Toolbox_Types.h:1333
TPtxPdfAnnots_FileAttachmentIcon
Definition PdfTools_Toolbox_Types.h:886
TPtxPdfAnnots_StampType
Type and subtype enumeration of TPtxPdfAnnots_Stamp.
Definition PdfTools_Toolbox_Types.h:1310
TPtxGeom_HorizontalAlignment
Definition PdfTools_Toolbox_Types.h:86
TPtxPdfAnnots_LineEnding
Definition PdfTools_Toolbox_Types.h:795
TPtxPdfAnnots_TextMarkupType
Type and subtype enumeration of TPtxPdfAnnots_TextMarkup.
Definition PdfTools_Toolbox_Types.h:1359
#define BOOL
Definition PdfTools_Toolbox_Types.h:23
TPtxPdfAnnots_AnnotationType
Type and subtype enumeration of TPtxPdfAnnots_Annotation.
Definition PdfTools_Toolbox_Types.h:1230
TPtxPdfAnnots_TextStampType
Definition PdfTools_Toolbox_Types.h:833
Description of a file A file description is used for embedded files.
A page annotation.
A list of annotations When a list of PtxPdf_Page_GetAnnotations is obtained from a page that belongs ...
A stamp annotation with custom content.
A drawing annotation An annotation used to draws something on a page.
An ellipse drawing annotation.
A file attachment annotation.
An annotation that displays text For a free-text annotation, the annotation's content is used as text...
An text highlighting annotation.
A free-hand drawing annotation.
A line annotation An annotation that draws a line on a page.
A markup annotation.
Information for a markup annotation Holds information contained in a markup annotation or in a reply ...
A drawing annotation that consists of several line segments.
A polygon annotation.
A pop-up for a markup annotation.
A rectangle drawing annotation.
A squiggly text underlining annotation.
A stamp annotation.
A sticky note annotation.
An annotation for striking through text.
An annotation that marks a point to insert text.
An annotation that marks up part(s) of a text.
A text stamp annotation.
An text underlining annotation.
Paths define shapes, trajectories, and regions of all sorts. A path is made up of one or more disconn...
Definition PdfTools_Toolbox_Types.h:2111
Definition PdfTools_Toolbox_Types.h:2139
Definition PdfTools_Toolbox_Types.h:2278