PDF SDK Documentation

Comprehensive Guide for Developers: Features, Integration, and API Reference

Loading...
Searching...
No Matches
annots.h
Go to the documentation of this file.
1// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
2
3#ifndef PDFSDK_CORE_ANNOTS_H_INCLUDED_
4#define PDFSDK_CORE_ANNOTS_H_INCLUDED_
5
11#include <pdfsdk/core/api_macro.h>
12#include <pdfsdk/core/atoms.h>
13#include <pdfsdk/core/content.h>
15#include <pdfsdk/core/types.h>
16#include <pdfsdk/errors.h>
17#include <pdfsdk/math_types.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
32
33typedef void(PDFSDK_CALLCONV* PDAnnotChangedProc)(PDAnnotOperation operation, size_t iPage, PDAnnot, void* clientData);
34
43enum {
44 kPDAnnotFlagInvisible = 1 << 0,
48 kPDAnnotFlagPrint = 1 << 2,
50 kPDAnnotFlagNoZoom = 1 << 3,
53 kPDAnnotFlagNoView = 1 << 5,
62};
63typedef uint32_t PDAnnotFlags;
64
74
75#define kPDAnnotBorderMaxDashes 11
76
77typedef struct
78{
79 float hCornerRadius;
80 float vCornerRadius;
81 float width;
82 size_t dashArrayLen;
83 float dashArray[kPDAnnotBorderMaxDashes];
85
102
103typedef struct
104{
106 float width;
107 size_t dashArrayLen;
108 float dashArray[kPDAnnotBorderMaxDashes];
110
122
123typedef struct
124{
126 float intensity;
128
143
161
181
182typedef struct
183{
184 PDRectF rect;
185 PDColorValue backgroundColor;
186 float opacity;
187 PDFontInfo fontInfo;
188 float fontSize;
189 bool showAuthorAndDate;
190 const wchar_t* author;
191 const wchar_t* caption;
193
194typedef struct {
195 PDRectF rect;
196 const wchar_t* content;
197 const wchar_t* title;
199
200typedef struct
201{
202 const PDPointF* points;
203 size_t count;
204} PDInkList;
205
206typedef struct {
207 const PDInkList* inkLists;
208 size_t numInkLists;
209 const wchar_t* title;
210 PDColorValue color;
211 float width;
212 float opacity;
214
215typedef struct {
216 PDRectF rect;
217 PDColorValue color;
218 const wchar_t* title;
220
223
224typedef struct {
225 PDAtom startStyle;
226 PDAtom endStyle;
228
229typedef struct {
230 PDRectF rect;
231 PDPointF startPoint;
232 PDPointF endPoint;
233 PDLineEnding lineEnding;
234 PDColorValue color;
235 const wchar_t* title;
237
238typedef struct {
239 PDRectF rect;
240 const PDPointF* pointList;
241 size_t pointListSize;
242 PDColorValue color;
243 const wchar_t* title;
245
246typedef struct {
247 PDRectF rect;
248 const wchar_t* title;
250
251typedef struct {
252 PDRectF rect;
253 const PDQuad* quads;
254 size_t numQuads;
255 PDColorValue color;
256 const wchar_t* title;
258
259typedef struct {
260 PDRectF rect;
261 PDAction action;
262 PDAnnotHighlightMode highlightMode;
263 PDColorValue color;
265
266typedef struct {
267 PDRectF rect;
268 const PDQuad* quads;
269 size_t numQuads;
270 PDColorValue border_color;
271 PDColorValue interior_color;
272 const wchar_t* title;
274
275typedef struct {
276 PDRectF rect;
277 PDFileSpec filespec;
278 PDColorValue* color;
279 PDAtom name;
281
282typedef struct {
283 PDRectF rect;
285
286typedef struct {
287 PDRectF rect;
288 PDColorValue color;
289 const wchar_t* title;
291
292PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAttachAnnotWillChangeCallback(PDDoc doc, PDAnnotChangedProc proc, void* clientData);
293PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocDetachAnnotWillChangeCallback(PDDoc doc, PDAnnotChangedProc proc, void* clientData);
294PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocNotifyAnnotWillChange(PDDoc doc, PDAnnotOperation operation, size_t iPage, PDAnnot annot);
295PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAttachAnnotChangedCallback(PDDoc doc, PDAnnotChangedProc proc, void* clientData);
296PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocDetachAnnotChangedCallback(PDDoc doc, PDAnnotChangedProc proc, void* clientData);
297PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocNotifyAnnotChanged(PDDoc doc, PDAnnotOperation operation, size_t iPage, PDAnnot annot);
298
299PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetNumAnnots(PDPage page, size_t* pNumAnnots);
300PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetAnnot(PDPage page, size_t index, PDAnnot* pAnnot);
301PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageAddAnnot(PDPage page, size_t insertAt, PDAnnot annot);
302PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageRemoveAnnot(PDPage page, PDAnnot annot);
303PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageRemoveAnnotByIndex(PDPage page, size_t index);
304PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetAnnotIndex(PDPage page, PDAnnot annot, size_t* pIndex);
305
306// Common
307PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotCreate(PDDoc doc, PDAtom annotType, const void* createParams, PDAnnot* annot);
308PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetPDObject(PDAnnot annot, PDObject* pObj);
309PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetSubtype(PDAnnot annot, PDAtom* pSubtype);
310PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetFlags(PDAnnot annot, PDAnnotFlags flags);
311PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetFlags(PDAnnot annot, PDAnnotFlags* pFlags);
312PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetRect(PDAnnot annot, const PDRectF* rect);
313PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetRect(PDAnnot annot, PDRectF* pRect);
314PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetColor(PDAnnot annot, PDColorValue color);
315PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetColor(PDAnnot annot, PDColorValue* pColor);
316PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetContents(PDAnnot annot, const wchar_t* buffer, size_t bufSize);
317PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetContents(PDAnnot annot, wchar_t* buffer, size_t bufSize, size_t* pSize);
318PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetModDate(PDAnnot annot, const PDDateTime* date);
319PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetModDate(PDAnnot annot, PDDateTime* pDate);
320PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetBorder(PDAnnot annot, const PDAnnotBorder* border);
321PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetBorder(PDAnnot annot, PDAnnotBorder* pBorder);
322PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetOCMD(PDAnnot annot, PDOCMD ocmd);
323PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetOCMD(PDAnnot annot, PDOCMD* pOCMD);
324PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDOCConfigIsAnnotVisible(PDOCConfig config, PDAnnot annot, bool* pVisible);
325PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetAppearanceState(PDAnnot annot, PDAtom appState);
326PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetAppearanceState(PDAnnot annot, PDAtom* pAppState);
327PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetFillOpacity(PDAnnot annot, float opacity);
328PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetFillOpacity(PDAnnot annot, float* pOpacity);
329PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetStrokeOpacity(PDAnnot annot, float opacity);
330PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetStrokeOpacity(PDAnnot annot, float* pOpacity);
331PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotHasAppearance(PDAnnot annot, PDAnnotState state, PDAtom appState, bool* pHas);
332PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetName(PDAnnot annot, wchar_t* buffer, size_t bufSize, size_t* pSize);
333PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetName(PDAnnot annot, const wchar_t* buffer, size_t bufSize);
334PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetVisible(PDAnnot annot, bool* visible);
335PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetVisible(PDAnnot annot, bool visible);
336PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetBlendMode(PDAnnot annot, PDEBlendMode* pBlendMode);
337PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetBlendMode(PDAnnot annot, PDEBlendMode blendMode);
338PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotSetAppearance(PDAnnot annot, PDAnnotState state, PDAtom appState, PDEXObject app);
339PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotGetAppearance(PDAnnot annot, PDAnnotState state, PDAtom appState, PDEXObject* pApp);
340
341// Link
342PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotSetAction(PDAnnot annot, PDAction action);
343PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotGetAction(PDAnnot annot, PDAction* pAction);
344PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotRemoveAction(PDAnnot annot);
345PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotSetQuadPoints(PDAnnot annot, size_t numQuads, const PDQuad* quads);
346PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotGetNumQuads(PDAnnot annot, size_t* pNumQuads);
347PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotGetQuadPoints(PDAnnot annot, PDQuad* quads);
348PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotSetBorderStyle(PDAnnot annot, const PDAnnotBorderStyle* borderStyle);
349PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotGetBorderStyle(PDAnnot annot, PDAnnotBorderStyle* pBorderStyle);
350PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotSetDestination(PDAnnot annot, PDDest dest);
351PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLinkAnnotGetDestination(PDAnnot annot, PDDest* pDest);
352
353// Markup common
354PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDAnnotIsMarkupAnnot(PDAnnot annot, bool* pMarkup);
355
356PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotSetTitle(PDAnnot annot, const wchar_t* buffer, size_t bufSize);
357PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotGetTitle(PDAnnot annot, wchar_t* buffer, size_t bufSize, size_t* pSize);
358PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotGetPopup(PDAnnot annot, PDAnnot* pPopup);
359PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotSetRichContents(PDAnnot annot, const wchar_t* buffer, size_t bufSize);
360PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotGetRichContents(PDAnnot annot, wchar_t* buffer, size_t bufSize, size_t* pSize);
361PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotSetCreationDate(PDAnnot annot, const PDDateTime* date);
362PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotGetCreationDate(PDAnnot annot, PDDateTime* pDate);
363PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotSetSubject(PDAnnot annot, const wchar_t* buffer, size_t bufSize);
364PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotGetSubject(PDAnnot annot, wchar_t* buffer, size_t bufSize, size_t* pSize);
365PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotGetInReplyTo(PDAnnot annot, PDAnnot* pInReplyTo);
366PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotSetInReplyTo(PDAnnot annot, PDAnnot inReplyTo);
367PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotSetReplyType(PDAnnot annot, PDMarkupAnnotReplyType replyType);
368PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotGetReplyType(PDAnnot annot, PDMarkupAnnotReplyType* pReplyType);
369PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotSetIntent(PDAnnot annot, PDAtom intent);
370PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotGetIntent(PDAnnot annot, PDAtom* pIntent);
371
372// Text
373PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextAnnotSetOpen(PDAnnot annot, bool open);
374PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextAnnotIsOpen(PDAnnot annot, bool* pOpen);
375
376// TextMarkup
377PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextMarkupAnnotSetQuadPoints(PDAnnot annot, size_t numQuads, const PDQuad* quads);
378PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextMarkupAnnotGetNumQuads(PDAnnot annot, size_t* pNumQuads);
379PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextMarkupAnnotGetQuadPoints(PDAnnot annot, PDQuad* quads);
380
381// FreeText
382PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetRotate(PDAnnot annot, PDRotate* pRotate);
383PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetRotate(PDAnnot annot, PDRotate rotate);
384PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetQuadding(PDAnnot annot, PDQuadding* pQuadding);
385PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetQuadding(PDAnnot annot, PDQuadding quadding);
386PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetBorderStyle(PDAnnot annot, PDAnnotBorderStyle* pBorderStyle);
387PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetBorderStyle(PDAnnot annot, const PDAnnotBorderStyle* borderStyle);
388PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetBorderEffect(PDAnnot annot, PDAnnotBorderEffect* pBorderEffect);
389PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetBorderEffect(PDAnnot annot, const PDAnnotBorderEffect* borderEffect);
390PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetFontInfo(PDAnnot annot, PDFontInfo* pFontInfo);
391PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetFontInfo(PDAnnot annot, const PDFontInfo* fontInfo);
392PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetFontColor(PDAnnot annot, PDColorValue* pFontColor);
393PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetFontColor(PDAnnot annot, PDColorValue fontColor);
394PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetBorderColor(PDAnnot annot, PDColorValue* pFontColor);
395PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetBorderColor(PDAnnot annot, PDColorValue fontColor);
396PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetFontSize(PDAnnot annot, float* pFontSize);
397PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetFontSize(PDAnnot annot, float fontSize);
398PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetLineEnding(PDAnnot annot, PDAtom* pEndPointStyle);
399PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetLineEnding(PDAnnot annot, PDAtom endPointStyle);
400PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetRectDifferences(PDAnnot annot, PDRectF* pDifferences);
401PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetRectDifferences(PDAnnot annot, const PDRectF* differences);
402
403PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotHitTestChar(PDAnnot annot, const PDPointF* pagePt, size_t* pCharIndex);
404PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetCharQuad(PDAnnot annot, size_t index, PDQuad* pQuad);
405PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetNumLines(PDAnnot annot, size_t* pNumLines);
406PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetLineSpacing(PDAnnot annot, float* pLineSpacing);
407PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetLineSpacing(PDAnnot annot, float lineSpacing);
408PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetCharSpacing(PDAnnot annot, float* pCharSpacing);
409PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotSetCharSpacing(PDAnnot annot, float charSpacing);
410PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetFirstCharOnLine(PDAnnot annot, size_t lineIndex, size_t* pCharIndex);
411PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFreeTextAnnotGetLineWithChar(PDAnnot annot, size_t charIndex, size_t* pLineIndex);
412
413// Line
414PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetBorderStyle(PDAnnot annot, PDAnnotBorderStyle* borderStyle);
415PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetBorderStyle(PDAnnot annot, const PDAnnotBorderStyle* pBorderStyle);
416PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetInteriorColor(PDAnnot annot, PDEColor* color);
417PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetInteriorColor(PDAnnot annot, PDEColor color);
418PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetLeaderLineLength(PDAnnot annot, float* lenght);
419PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetLeaderLineLength(PDAnnot annot, float lenght);
420PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetLeaderLineExtensionLength(PDAnnot annot, float* lenght);
421PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetLeaderLineExtensionLength(PDAnnot annot, float lenght);
422PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetLeaderLineOffset(PDAnnot annot, float* offset);
423PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetLeaderLineOffset(PDAnnot annot, float offset);
424PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetShowCaption(PDAnnot annot, bool* showCaption);
425PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetShowCaption(PDAnnot annot, bool showCaption);
426PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetCaptionPosition(PDAnnot annot, PDAtom* postion);
427PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetCaptionPosition(PDAnnot annot, PDAtom postion);
428PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetCaptionOffset(PDAnnot annot, PDPointF* offset);
429PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetCaptionOffset(PDAnnot annot, PDPointF offset);
430PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetLineEnding(PDAnnot annot, PDAtom* startPointStyle, PDAtom* endPointStyle);
431PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetLineEnding(PDAnnot annot, PDAtom startPointStyle, PDAtom endPointStyle);
432PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotGetBoundaryPoints(PDAnnot annot, PDPointF* pStart, PDPointF* pEnd);
433PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDLineAnnotSetBoundaryPoints(PDAnnot annot, const PDPointF* start, const PDPointF* end);
434
435// Square / Circle
436PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSquareAnnotGetBorderStyle(PDAnnot annot, PDAnnotBorderStyle* borderStyle);
437PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSquareAnnotSetBorderStyle(PDAnnot annot, const PDAnnotBorderStyle* borderStyle);
438PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSquareAnnotGetInteriorColor(PDAnnot annot, PDEColor* color);
439PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSquareAnnotSetInteriorColor(PDAnnot annot, PDEColor color);
440PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSquareAnnotGetBorderEffect(PDAnnot annot, PDAnnotBorderEffect* borderEffect);
441PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSquareAnnotSetBorderEffect(PDAnnot annot, const PDAnnotBorderEffect* borderEffect);
442// PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSquareAnnotGetRectDifferences(PDAnnot annot, PDRectF* differences);
443// PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSquareAnnotSetRectDifferences(PDAnnot annot, PDRectF const* differences);
444
445// Polygon / PolyLine
446PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotGetBorderStyle(PDAnnot annot, PDAnnotBorderStyle* borderStyle);
447PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotSetBorderStyle(PDAnnot annot, const PDAnnotBorderStyle* borderStyle);
448PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotGetInteriorColor(PDAnnot annot, PDEColor* color);
449PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotSetInteriorColor(PDAnnot annot, PDEColor color);
450PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolygonAnnotGetBorderEffect(PDAnnot annot, PDAnnotBorderEffect* borderEffect);
451PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolygonAnnotSetBorderEffect(PDAnnot annot, const PDAnnotBorderEffect* borderEffect);
452PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotGetShowCaption(PDAnnot annot, bool* showCaption);
453PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotSetShowCaption(PDAnnot annot, bool showCaption);
454PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotGetLineEnding(PDAnnot annot, PDAtom* startPointStyle, PDAtom* endPointStyle);
455PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotSetLineEnding(PDAnnot annot, PDAtom startPointStyle, PDAtom endPointStyle);
456PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotGetVertices(PDAnnot annot, PDPointF* buffer, size_t size, size_t* pSize);
457PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPolyLineAnnotSetVertices(PDAnnot annot, const PDPointF* vertices, size_t size);
458
459// Stamp
460PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDStampAnnotCreateDynamicAppearanceStream(PDDoc doc, const PDStampAnnotCreateDynamicAppearanceStreamParams* params, PDEXObject* appearanceStream);
461
462// Ink
463PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDInkAnnotGetBorderStyle(PDAnnot annot, PDAnnotBorderStyle* borderStyle);
464PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDInkAnnotSetBorderStyle(PDAnnot annot, const PDAnnotBorderStyle* pBorderStyle);
465PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDInkAnnotGetInkPointListSize(PDAnnot annot, size_t* size);
466PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDInkAnnotSetInkPointListSize(PDAnnot annot, size_t size);
467PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDInkAnnotGetInkPointsByIndex(PDAnnot annot, size_t i, PDPointF* buffer, size_t size, size_t* pSize);
468PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDInkAnnotSetInkPointsByIndex(PDAnnot annot, size_t i, const PDPointF* buffer, size_t size);
469
470// FileAttachment
471PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileAttachmentAnnotSetFileSpec(PDAnnot annot, PDFileSpec pFileSpec);
472PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFileAttachmentAnnotGetFileSpec(PDAnnot annot, PDFileSpec* pFileSpec);
473
474// Sound
475
476// Redact
477PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDRedactAnnotSetQuadPoints(PDAnnot annot, size_t numQuads, const PDQuad* quads);
478PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDRedactAnnotGetNumQuads(PDAnnot annot, size_t* pNumQuads);
479PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDRedactAnnotGetQuadPoints(PDAnnot annot, PDQuad* quads);
480PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDRedactAnnotGetInteriorColor(PDAnnot annot, PDEColor* color);
481PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDRedactAnnotSetInteriorColor(PDAnnot annot, PDEColor color);
482PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDRedactAnnotGetAppearanceFillColor(PDAnnot annot, PDEColor* color);
483PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDRedactAnnotSetAppearanceFillColor(PDAnnot annot, PDEColor color);
484
485// Popup
486PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPopupAnnotGetOpen(PDAnnot annot, bool* open);
487PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPopupAnnotSetOpen(PDAnnot annot, bool open);
488
489#ifdef __cplusplus
490}
491#endif
492
493#endif // PDFSDK_CORE_ANNOTS_H_INCLUDED_
PDAnnotBorderEffectStyle
Defines the border effect of an annotation.
Definition annots.h:118
@ kPDAnnotBorderEffectStyleNone
Definition annots.h:119
@ kPDAnnotBorderEffectStyleCloudy
Definition annots.h:120
PDAnnotBorderType
Defines the visual style of the borders around an annotation.
Definition annots.h:95
@ kPDAnnotBorderTypeBeveled
Definition annots.h:98
@ kPDAnnotBorderTypeUnderline
Definition annots.h:100
@ kPDAnnotBorderTypeSolid
Definition annots.h:96
@ kPDAnnotBorderTypeDashed
Definition annots.h:97
@ kPDAnnotBorderTypeInset
Definition annots.h:99
PDAnnotState
Defines visual appearance of an annotation at different times based on user interaction.
Definition annots.h:68
@ kPDAnnotStateRollover
Definition annots.h:71
@ kPDAnnotStateDown
Definition annots.h:72
@ kPDAnnotStateNormal
Definition annots.h:69
PDAnnotHighlightMode
Defines the visual representation of annotations, making it easier for users to interact with and und...
Definition annots.h:173
@ kPDAnnotHighlightOutline
Definition annots.h:177
@ kPDAnnotHighlightNone
Definition annots.h:174
@ kPDAnnotHighlightInvert
Definition annots.h:175
@ kPDAnnotHighlightPush
Definition annots.h:178
@ kPDAnnotHighlightToggle
Definition annots.h:179
@ kPDAnnotFlagNoRotate
Definition annots.h:52
@ kPDAnnotFlagPrint
Definition annots.h:48
@ kPDAnnotFlagNoView
Definition annots.h:53
@ kPDAnnotFlagNoZoom
Definition annots.h:50
@ kPDAnnotFlagInvisible
Definition annots.h:44
@ kPDAnnotFlagLocked
Definition annots.h:56
@ kPDAnnotFlagToggleNoView
Definition annots.h:57
@ kPDAnnotFlagReadOnly
Definition annots.h:55
@ kPDAnnotFlagLockedContents
Definition annots.h:58
@ kPDAnnotFlagHidden
Definition annots.h:47
PDAnnotOperation
Defines actions or changes applied to annotations within a PDF document.
Definition annots.h:26
@ kPDAnnotValueChanged
Definition annots.h:30
@ kPDAnnotChanged
Definition annots.h:29
@ kPDAnnotRemoved
Definition annots.h:28
@ kPDAnnotAdded
Definition annots.h:27
PDMarkupAnnotReplyType
Defines the relationship between markup annotations.
Definition annots.h:157
@ kPDMarkupAnnotReplyGroup
Definition annots.h:159
@ kPDMarkupAnnotReplyReply
Definition annots.h:158
PDQuadding
Defines the alignment of text for a free text annotation.
Definition annots.h:138
@ kPDQuaddingCenter
Definition annots.h:140
@ kPDQuaddingRight
Definition annots.h:141
@ kPDQuaddingLeft
Definition annots.h:139
Atom API.
Content API.
Document API.
struct PDOCConfigRec_ * PDOCConfig
Definition optional_content.h:39
Error codes.
int32_t PDErrCode
Definition errors.h:44
Math types.
Definition annots.h:124
Definition annots.h:78
Definition annots.h:104
Definition annots.h:286
Definition types.h:23
Definition fonts.h:25
Definition annots.h:282
Definition annots.h:206
Definition annots.h:201
Definition annots.h:229
Definition annots.h:224
Definition objects.h:80
Definition math_types.h:12
Definition annots.h:238
Definition math_types.h:52
Definition math_types.h:30
Definition annots.h:266
Definition annots.h:246
Definition annots.h:194
Definition annots.h:251
Common types.