PDF SDK Documentation

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

Loading...
Searching...
No Matches
acroform.h
Go to the documentation of this file.
1// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
2
3#ifndef PDFSDK_CORE_ACROFORM_H_INCLUDED_
4#define PDFSDK_CORE_ACROFORM_H_INCLUDED_
5
11#include <pdfsdk/core/actions.h>
12#include <pdfsdk/core/annots.h>
13#include <pdfsdk/core/api_macro.h>
15#include <pdfsdk/errors.h>
16#include <pdfsdk/math_types.h>
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22// FormField opaque type
23typedef struct PDFieldRec_* PDField;
24
25typedef void(PDFSDK_CALLCONV* PDFieldChangedProc)(PDField field, void* clientData);
26
27// Field Flags
28typedef uint32_t PDFieldFlags;
29
36enum {
37 // Common
38 kPDFieldFlagReadOnly = 0x00000001,
39 kPDFieldFlagRequired = 0x00000002,
41 kPDFieldFlagNoExport = 0x00000004,
44 // Text
46 kPDTextFieldFlagPassword = 0x00002000,
48 kPDTextFieldFlagFileSelect = 0x00100000,
51 kPDTextFieldFlagDoNotScroll = 0x00800000,
53 kPDTextFieldFlagComb = 0x01000000,
55 kPDTextFieldFlagRichText = 0x02000000,
58 // Button
61 kPDButtonFieldFlagRadio = 0x00008000,
63 kPDButtonFieldFlagPushbutton = 0x00010000,
68 // Choice
69 kPDChoiceFieldFlagCombo = 0x00020000,
71 kPDChoiceFieldFlagEdit = 0x00040000,
77};
78
79#define kPDChoiceNoSelection ((size_t)(-1))
80
93
106
107typedef struct
108{
109 PDIconScaleWhen scaleWhen;
110 PDIconScaleHow scaleHow;
111 float allocLeft;
112 float allocBottom;
113 bool fitBounds;
114} PDIconFit;
115
131
132#define kPDAutoFontSize 0.f
133
140enum {
141 kPDSubmitFormFlagExclude = 1 << 0,
160 kPDSubmitFormFlagXFDF = 1 << 5,
180 kPDSubmitFormFlagExclFKey = 1 << 11,
188typedef uint32_t PDSubmitFormFlags;
189
197enum {
198 kPDResetFormFlagExclude = 1 << 0
199};
200typedef uint32_t PDResetFormFlags;
201
202typedef PDErrCode(PDFSDK_CALLCONV* PDSignGetNameProc)(void* signData, PDAtom* pName);
203typedef PDErrCode(PDFSDK_CALLCONV* PDSignGetCertDataProc)(void* signData, void* buffer, size_t bufLen, size_t* pSize);
204typedef PDErrCode(PDFSDK_CALLCONV* PDSignEstimateMaxSizeProc)(void* signData, size_t* pMaxSize);
205typedef PDErrCode(PDFSDK_CALLCONV* PDSignSignProc)(void* signData, const void* data, size_t dataLen, void* buffer, size_t bufLen, size_t* pSize);
206typedef PDErrCode(PDFSDK_CALLCONV* PDSignDestroyProc)(void* signData);
207
208typedef struct
209{
210 PDSignGetNameProc getFilter;
211 PDSignGetNameProc getSubFilter;
212 PDSignGetCertDataProc getCertData;
213 PDSignEstimateMaxSizeProc estimateMaxSize;
214 PDSignSignProc sign;
215 PDSignDestroyProc destroy;
217
227
236
237PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetNumFields(PDDoc doc, size_t* pNumFields);
238PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetField(PDDoc doc, size_t index, PDField* pField);
239PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAppendField(PDDoc doc, PDField field);
240PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocRemoveField(PDDoc doc, PDField field);
241
242PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateField(PDDoc doc, const wchar_t* fullnameBuf, size_t fullnameSize, PDAtom type, PDFieldFlags flags, PDField* pField);
243PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocFindField(PDDoc doc, const wchar_t* fullname, PDField* pField);
244PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocRenameField(PDDoc doc, PDField field, const wchar_t* fullnameBuf, size_t fullnameSize);
245
246PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocAttachFieldChangedCallback(PDDoc doc, PDFieldChangedProc proc, void* clientData);
247PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocDetachFieldChangedCallback(PDDoc doc, PDFieldChangedProc proc, void* clientData);
248PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocNotifyFieldChanged(PDDoc doc, PDField field);
249
250PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateActionFieldsData(PDDoc doc, const PDField* fields, size_t numFields, PDObject* pData);
251PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionFieldsDataGetNumFields(PDObject data, size_t* pNumFields);
252PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionFieldsDataGetField(PDObject data, size_t index, PDDoc doc, PDField* pField);
253PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionFieldsDataAddField(PDObject data, PDField field);
254
255PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionSubmitFormGetServerURL(PDAction action, PDFileSpec* pFileSpec);
256PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionSubmitFormSetServerURL(PDAction action, PDFileSpec fileSpec);
257PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionSubmitFormGetFieldsData(PDAction action, PDObject* pFields);
258PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionSubmitFormSetFieldsData(PDAction action, PDObject fields);
259PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionSubmitFormGetFlags(PDAction action, PDSubmitFormFlags* pFlags);
260PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionSubmitFormSetFlags(PDAction action, PDSubmitFormFlags flags);
261PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionResetFormGetFieldsData(PDAction action, PDObject* pFields);
262PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionResetFormSetFieldsData(PDAction action, PDObject fields);
263PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionResetFormGetFlags(PDAction action, PDResetFormFlags* pFlags);
264PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionResetFormSetFlags(PDAction action, PDResetFormFlags flags);
265PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionImportDataGetFileSpec(PDAction action, PDFileSpec* pFileSpec);
266PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDActionImportDataSetFileSpec(PDAction action, PDFileSpec fileSpec);
267
268PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCalculationOrderGetNumFields(PDDoc doc, size_t* pNumFields);
269PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCalculationOrderGetField(PDDoc doc, size_t index, PDField* pField);
270PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCalculationOrderInsertField(PDDoc doc, PDField field);
271PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCalculationOrderRemoveField(PDDoc doc, PDField field);
272
273PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocExportFormFDF(PDDoc doc, PDObject fields, bool exclude, const wchar_t* path);
274PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocImportFormFDF(PDDoc doc, const wchar_t* path);
275PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocResetForm(PDDoc doc, PDObject fields, PDResetFormFlags flags);
276
277PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocOpenXFAStream(PDDoc doc, PDReadStream* pStm);
278
279/*
280 An indirect reference to the widget annotation’s parent field.
281 A widget annotation may have at most one parent; that is,
282 it can be included in the Kids array of at most one field
283*/
284PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetParent(PDAnnot widget, PDField* pParent);
285PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetHighlight(PDAnnot widget, PDAnnotHighlightMode highlight);
286PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetHighlight(PDAnnot widget, PDAnnotHighlightMode* pHighlight);
287PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetBorderStyle(PDAnnot annot, const PDAnnotBorderStyle* borderStyle);
288PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetBorderStyle(PDAnnot annot, PDAnnotBorderStyle* pBorderStyle);
289PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetRotate(PDAnnot annot, PDRotate rotate);
290PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetRotate(PDAnnot annot, PDRotate* pRotate);
291PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetBorderColor(PDAnnot annot, PDColorValue borderColor);
292PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetBorderColor(PDAnnot annot, PDColorValue* pBorderColor);
293PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetBgColor(PDAnnot annot, PDColorValue bgColor);
294PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetBgColor(PDAnnot annot, PDColorValue* pBgColor);
295PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotHasBgColor(PDAnnot annot, bool* has);
296PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetFontInfo(PDAnnot widget, const PDFontInfo* fontInfo);
297PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetFontInfo(PDAnnot widget, PDFontInfo* pFontInfo);
298PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetFontColor(PDAnnot widget, PDColorValue fontColor);
299PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetFontColor(PDAnnot widget, PDColorValue* pFontColor);
300PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetFontSize(PDAnnot widget, float fontSize);
301PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetFontSize(PDAnnot widget, float* pFontSize);
302
303PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetMouseEnterAction(PDAnnot widget, PDAction action);
304PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetMouseEnterAction(PDAnnot widget, PDAction* pAction);
305PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetMouseExitAction(PDAnnot widget, PDAction action);
306PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetMouseExitAction(PDAnnot widget, PDAction* pAction);
307PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetMouseDownAction(PDAnnot widget, PDAction action);
308PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetMouseDownAction(PDAnnot widget, PDAction* pAction);
309PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetMouseUpAction(PDAnnot widget, PDAction action);
310PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetMouseUpAction(PDAnnot widget, PDAction* pAction);
311PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetFocusAction(PDAnnot widget, PDAction action);
312PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetFocusAction(PDAnnot widget, PDAction* pAction);
313PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotSetBlurAction(PDAnnot widget, PDAction action);
314PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDWidgetAnnotGetBlurAction(PDAnnot widget, PDAction* pAction);
315
316PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateButtonWidgetAnnot(PDDoc doc, PDField parent, const PDRectF* rect, PDAnnot* pOut);
317PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetCaption(PDAnnot widget, const wchar_t* captionBuf, size_t captionSize);
318PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetCaption(PDAnnot widget, wchar_t* buffer, size_t bufSize, size_t* pSize);
319PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetRolloverCaption(PDAnnot widget, const wchar_t* captionBuf, size_t captionSize);
320PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetRolloverCaption(PDAnnot widget, wchar_t* buffer, size_t bufSize, size_t* pSize);
321PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetDownCaption(PDAnnot widget, const wchar_t* captionBuf, size_t captionSize);
322PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetDownCaption(PDAnnot widget, wchar_t* buffer, size_t bufSize, size_t* pSize);
323PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetIcon(PDAnnot widget, PDEXObject icon);
324PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetIcon(PDAnnot widget, PDEXObject* pIcon);
325PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetRolloverIcon(PDAnnot widget, PDEXObject icon);
326PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetRolloverIcon(PDAnnot widget, PDEXObject* pIcon);
327PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetDownIcon(PDAnnot widget, PDEXObject icon);
328PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetDownIcon(PDAnnot widget, PDEXObject* pIcon);
329PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetIconFit(PDAnnot widget, const PDIconFit* iconFit);
330PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetIconFit(PDAnnot widget, PDIconFit* pIconFit);
331PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetTextPosition(PDAnnot widget, PDTextPosition textPosition);
332PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetTextPosition(PDAnnot widget, PDTextPosition* pTextPosition);
333PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotToggle(PDAnnot widget);
334PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetChoice(PDAnnot widget, const wchar_t* choiceBuf, size_t choiceSize);
335PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetChoice(PDAnnot widget, wchar_t* buffer, size_t bufSize, size_t* pSize);
336PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetOnStateName(PDAnnot widget, PDAtom* pName);
337PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotSetAction(PDAnnot widget, PDAction action);
338PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDButtonWidgetAnnotGetAction(PDAnnot widget, PDAction* pAction);
339
340PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateTextWidgetAnnot(PDDoc doc, PDField parent, const PDRectF* rect, PDAnnot* pOut);
341PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotSetTopLine(PDAnnot widget, size_t topLine);
342PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetTopLine(PDAnnot widget, size_t* pTopLine);
343PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotKeystroke(PDAnnot widget, size_t selStart, size_t selEnd, const wchar_t* change, size_t changeSize, bool allowOverflow);
344PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotHitTestChar(PDAnnot widget, const PDPointF* pagePt, size_t* pCharIndex);
345PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotSetText(PDAnnot widget, const wchar_t* text, size_t textSize);
346PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetText(PDAnnot widget, wchar_t* buffer, size_t bufSize, size_t* pSize);
347PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetCharQuad(PDAnnot widget, size_t index, PDQuad* pQuad);
348PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetNumVisibleLines(PDAnnot widget, size_t* pMaxLines);
349PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetNumLines(PDAnnot widget, size_t* pNumLines);
350PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetFirstCharOnLine(PDAnnot widget, size_t lineIndex, size_t* pCharIndex);
351PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetLineWithChar(PDAnnot widget, size_t charIndex, size_t* pLineIndex);
352PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotDoesNeedScroll(PDAnnot widget, PDTextWidgetScrollType* pScrollType);
353PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotSetFirstVisibleChar(PDAnnot widget, size_t charIndex);
354PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetFirstVisibleChar(PDAnnot widget, size_t* pcharIndex);
355PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetNumberOfVisibleChars(PDAnnot widget, size_t* pnumOfVisibleChars);
356PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotSetQuadding(PDAnnot widget, PDQuadding quadding);
357PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotGetQuadding(PDAnnot widget, PDQuadding* pQuadding);
358PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextWidgetAnnotHasOverflow(PDAnnot widget, bool* hasOverflow);
359
360PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateChoiceWidgetAnnot(PDDoc doc, PDField parent, const PDRectF* rect, PDAnnot* pOut);
361PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotSetTopLine(PDAnnot widget, size_t topLine);
362PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotGetTopLine(PDAnnot widget, size_t* pTopLine);
363PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotKeystroke(PDAnnot widget, size_t selStart, size_t selEnd, const wchar_t* change, size_t changeSize);
364PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotHitTestChar(PDAnnot widget, const PDPointF* pagePt, size_t* pCharIndex);
365PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotSetText(PDAnnot widget, const wchar_t* text, size_t textSize);
366PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotGetText(PDAnnot widget, wchar_t* buffer, size_t bufSize, size_t* pSize);
367PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotGetCharQuad(PDAnnot widget, size_t index, PDQuad* pQuad);
368PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotGetNumVisibleLines(PDAnnot widget, size_t* pMaxLines);
369PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotGetNumLines(PDAnnot widget, size_t* pNumLines);
370PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotGetNumOptions(PDAnnot widget, size_t* pNumOptions);
371PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotHitTestOption(PDAnnot widget, const PDPointF* pagePt, size_t* pOption);
372PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotSetSelection(PDAnnot widget, size_t option);
373PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotGetSelection(PDAnnot widget, size_t* pOption);
374PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotSetQuadding(PDAnnot widget, PDQuadding quadding);
375PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceWidgetAnnotGetQuadding(PDAnnot widget, PDQuadding* pQuadding);
376PDF_CORE_API void PDFSDK_CALLCONV PDChoiceWidgetAnnotSetGlobalSelectionColor(PDColorValue color);
377
378PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateSignWidgetAnnot(PDDoc doc, PDField parent, const PDRectF* rect, PDAnnot* pOut);
379PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignWidgetAnnotSetAppearanceParams(PDAnnot widget, PDEXObject icon, bool addCaption);
380
381PDF_CORE_API bool PDFSDK_CALLCONV PDFieldEqual(PDField fieldA, PDField fieldB);
382PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetType(PDField field, PDAtom* pType);
383PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetParent(PDField field, PDField* pParent);
384PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldIsTerminal(PDField field, bool* pTerminal);
385PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetNumChildren(PDField field, size_t* pNumChildren);
386PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetChildByIndex(PDField field, size_t index, PDField* pChild);
387PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldAppendChild(PDField field, PDField child);
388PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldRemoveChild(PDField field, PDField child);
389PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetNumWidgets(PDField field, size_t* pNumWidgets);
390PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetWidget(PDField field, size_t index, PDAnnot* pWidget);
391PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldAppendWidget(PDField field, PDAnnot widget);
392PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldRemoveWidget(PDField field, PDAnnot widget);
393PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetName(PDField field, const wchar_t* nameBuf, size_t nameSize);
394PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetName(PDField field, wchar_t* buffer, size_t bufSize, size_t* pSize);
395PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetUIName(PDField field, const wchar_t* nameBuf, size_t nameSize);
396PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetUIName(PDField field, wchar_t* buffer, size_t bufSize, size_t* pSize);
397PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetMappingName(PDField field, const wchar_t* nameBuf, size_t nameSize);
398PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetMappingName(PDField field, wchar_t* buffer, size_t bufSize, size_t* pSize);
399PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetFlags(PDField field, PDFieldFlags* pFlags);
400PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetFlags(PDField field, PDFieldFlags flags);
401PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldUpdateWidgets(PDField field);
402PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetFullName(PDField field, wchar_t* buffer, size_t bufSize, size_t* pSize);
403
404PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetModifyAction(PDField field, PDAction action);
405PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetModifyAction(PDField field, PDAction* pAction);
406PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetValidateAction(PDField field, PDAction action);
407PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetValidateAction(PDField field, PDAction* pAction);
408PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetFormatAction(PDField field, PDAction action);
409PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetFormatAction(PDField field, PDAction* pAction);
410PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetCalculateAction(PDField field, PDAction action);
411PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetCalculateAction(PDField field, PDAction* pAction);
412
413PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetValue(PDField field, wchar_t* buffer, size_t bufSize, size_t* pSize);
414PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetValue(PDField field, const wchar_t* value, size_t valueSize, PDAnnot source);
415PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetEValue(PDField field, wchar_t* buffer, size_t bufSize, size_t* pSize);
416PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetEValue(PDField field, const wchar_t* value, size_t valueSize);
417PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldGetDefaultValue(PDField field, wchar_t* buffer, size_t bufSize, size_t* pSize);
418PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDFieldSetDefaultValue(PDField field, const wchar_t* value, size_t valueSize);
419
420PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateButtonField(PDDoc doc, PDField parent, PDFieldFlags flags, PDField* pOut);
421
422PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateTextField(PDDoc doc, PDField parent, PDFieldFlags flags, PDField* pOut);
423PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextFieldSetMaxLen(PDField field, size_t maxlen);
424PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDTextFieldGetMaxLen(PDField field, size_t* pMaxLen);
425
426PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateChoiceField(PDDoc doc, PDField parent, PDFieldFlags flags, PDField* pOut);
427PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceFieldGetNumOptions(PDField field, size_t* pNumOptions);
428PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceFieldFindOptionByValue(PDField field, const wchar_t* value, size_t valueSize, size_t* pOption);
429PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceFieldFindOptionByExportValue(PDField field, const wchar_t* exportValue, size_t exportValueSize, size_t* pOption);
430PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceFieldGetOptionValue(PDField field, size_t option, wchar_t* buffer, size_t bufSize, size_t* pSize);
431PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceFieldGetOptionExportValue(PDField field, size_t option, wchar_t* buffer, size_t bufSize, size_t* pSize);
432PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceFieldInsertOption(PDField field, size_t index, const wchar_t* value, size_t valueSize, const wchar_t* exportValue, size_t exportValueSize);
433PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceFieldRemoveOption(PDField field, size_t index);
434PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDChoiceFieldRemoveAllOptions(PDField field);
435
436PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDCreateSignField(PDDoc doc, PDField parent, PDFieldFlags flags, PDField* pOut);
437PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocIsSigned(PDDoc doc, bool* pSigned);
438PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocHasURPerms(PDDoc doc, bool* pHasURPerms);
439PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldIsBlank(PDField field, bool* pBlank);
440PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldSetLock(PDField field, PDAtom action, PDObject fields, PDSignLockPerms perms);
441PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldGetLock(PDField field, PDAtom* action, PDObject* fields, PDSignLockPerms* perms);
442PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldSign(PDField field, const PDSignHandler* signHandler, void* signData, const wchar_t* reason);
443PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldAuthorSign(PDField field, PDSignLockPerms perms, const PDSignHandler* signHandler, void* signData, const wchar_t* reason);
444PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldClear(PDField field);
445PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldVerify(PDField field, bool* pValid);
446PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldDocModifiedAfterSign(PDField field, bool* pModified);
447PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldGetReason(PDField field, wchar_t* buffer, size_t bufSize, size_t* pSize);
448PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldGetSigningDate(PDField field, PDDateTime* pDate);
449PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldGetCertificate(PDField field, void* buffer, size_t bufSize, size_t* pSize);
450PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldGetRevision(PDField field, int* pRevision);
451PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDSignFieldSaveSignedVersion(PDField field, const wchar_t* filename);
452
453#ifdef __cplusplus
454}
455#endif
456
457#endif // PDFSDK_CORE_ACROFORM_H_INCLUDED_
@ kPDChoiceFieldFlagDoNotSpellCheck
Definition acroform.h:75
@ kPDChoiceFieldFlagCombo
Definition acroform.h:69
@ kPDChoiceFieldFlagMultiSelect
Definition acroform.h:74
@ kPDChoiceFieldFlagSort
Definition acroform.h:73
@ kPDButtonFieldFlagRadio
Definition acroform.h:61
@ kPDFieldFlagNoExport
Definition acroform.h:41
@ kPDTextFieldFlagMultiline
Definition acroform.h:45
@ kPDTextFieldFlagFileSelect
Definition acroform.h:48
@ kPDTextFieldFlagPassword
Definition acroform.h:46
@ kPDFieldFlagRequired
Definition acroform.h:39
@ kPDButtonFieldFlagRadiosInUnison
Definition acroform.h:65
@ kPDTextFieldFlagDoNotScroll
Definition acroform.h:51
@ kPDButtonFieldFlagNoToggleToOff
Definition acroform.h:59
@ kPDFieldFlagReadOnly
Definition acroform.h:38
@ kPDTextFieldFlagRichText
Definition acroform.h:55
@ kPDChoiceFieldFlagEdit
Definition acroform.h:71
@ kPDChoiceFieldFlagCommitOnSelChange
Definition acroform.h:76
@ kPDButtonFieldFlagPushbutton
Definition acroform.h:63
@ kPDTextFieldFlagComb
Definition acroform.h:53
@ kPDTextFieldFlagDoNotSpellCheck
Definition acroform.h:50
PDSignLockPerms
Controls the permissions and security settings of a signed PDF document.
Definition acroform.h:221
@ kPDSignLockPermsAllowNoChanges
Definition acroform.h:223
@ kPDSignLockPermsNotSet
Definition acroform.h:222
@ kPDSignLockPermsAllowFormFillAnnotate
Definition acroform.h:225
@ kPDSignLockPermsAllowFormFill
Definition acroform.h:224
PDIconScaleWhen
Defines the circumstances under which an icon shall be scaled inside an annotation rectangle.
Definition acroform.h:87
@ kPDIconScaleBigger
Definition acroform.h:89
@ kPDIconScaleNever
Definition acroform.h:91
@ kPDIconScaleSmaller
Definition acroform.h:90
@ kPDIconScaleAlways
Definition acroform.h:88
PDTextPosition
Defines where to position the text of a widget annotation’s caption relative to its icon.
Definition acroform.h:122
@ kPDTextPositionCaptionLeft
Definition acroform.h:128
@ kPDTextPositionCaptionOnIcon
Definition acroform.h:129
@ kPDTextPositionIconOnly
Definition acroform.h:124
@ kPDTextPositionCaptionRight
Definition acroform.h:127
@ kPDTextPositionCaptionBelowIcon
Definition acroform.h:125
@ kPDTextPositionCaptionOnly
Definition acroform.h:123
@ kPDTextPositionCaptionAboveIcon
Definition acroform.h:126
PDIconScaleHow
Defines the type of scaling that shall be used.
Definition acroform.h:100
@ kPDIconScaleAnamorphic
Definition acroform.h:101
@ kPDIconScaleProportional
Definition acroform.h:103
@ kPDSubmitFormFlagExportFormat
Definition acroform.h:147
@ kPDSubmitFormFlagIncludeAnnotations
Definition acroform.h:168
@ kPDSubmitFormFlagIncludeNoValueFields
Definition acroform.h:144
@ kPDSubmitFormFlagExclFKey
Definition acroform.h:180
@ kPDSubmitFormFlagGetMethod
Definition acroform.h:151
@ kPDSubmitFormFlagXFDF
Definition acroform.h:160
@ kPDSubmitFormFlagSubmitCoordinates
Definition acroform.h:156
@ kPDSubmitFormFlagCanonicalFormat
Definition acroform.h:175
@ kPDSubmitFormFlagExclude
Definition acroform.h:141
@ kPDSubmitFormFlagEmbedForm
Definition acroform.h:183
@ kPDSubmitFormFlagIncludeAppendSaves
Definition acroform.h:162
@ kPDSubmitFormFlagSubmitPDF
Definition acroform.h:173
@ kPDSubmitFormFlagExclNonUserAnnots
Definition acroform.h:178
PDTextWidgetScrollType
Defines how scroll bars are displayed and interacted with within the PDF document.
Definition acroform.h:231
@ kPDTextWidgetScrollNone
Definition acroform.h:232
@ kPDTextWidgetScrollVertical
Definition acroform.h:233
@ kPDTextWidgetScrollHorizontal
Definition acroform.h:234
Action API.
Annotations API.
PDAnnotHighlightMode
Defines the visual representation of annotations, making it easier for users to interact with and und...
Definition annots.h:173
PDQuadding
Defines the alignment of text for a free text annotation.
Definition annots.h:138
Document API.
Error codes.
int32_t PDErrCode
Definition errors.h:44
Math types.
Definition annots.h:104
Definition types.h:23
Definition fonts.h:25
Definition acroform.h:108
Definition objects.h:80
Definition math_types.h:12
Definition math_types.h:52
Definition math_types.h:30
Definition acroform.h:209