Vanilla.PDF  1.6.0
Cross-platform toolkit for creating and modifying PDF documents
c_fields.h
Go to the documentation of this file.
1#ifndef _C_FIELDS_H
2#define _C_FIELDS_H
3
7
8#ifdef __cplusplus
9extern "C"
10{
11#endif
12
72 typedef enum {
73 FieldType_Undefined = 0,
74
80
86
92
98 } FieldType;
99
108 VANILLAPDF_API error_type CALLING_CONVENTION FieldCollection_GetSize(FieldCollectionHandle* handle, size_type* result);
109
114 VANILLAPDF_API error_type CALLING_CONVENTION FieldCollection_At(FieldCollectionHandle* handle, size_type at, FieldHandle** result);
115
120 VANILLAPDF_API error_type CALLING_CONVENTION FieldCollection_Release(FieldCollectionHandle* handle);
121
134 VANILLAPDF_API error_type CALLING_CONVENTION Field_GetType(FieldHandle* handle, FieldType* result);
135
139 VANILLAPDF_API error_type CALLING_CONVENTION Field_ToButton(FieldHandle* handle, ButtonFieldHandle** result);
140
144 VANILLAPDF_API error_type CALLING_CONVENTION Field_ToText(FieldHandle* handle, TextFieldHandle** result);
145
149 VANILLAPDF_API error_type CALLING_CONVENTION Field_ToChoice(FieldHandle* handle, ChoiceFieldHandle** result);
150
154 VANILLAPDF_API error_type CALLING_CONVENTION Field_ToSignature(FieldHandle* handle, SignatureFieldHandle** result);
155
160 VANILLAPDF_API error_type CALLING_CONVENTION Field_Release(FieldHandle* handle);
161
172 VANILLAPDF_API error_type CALLING_CONVENTION ButtonField_Release(ButtonFieldHandle* handle);
173
184 VANILLAPDF_API error_type CALLING_CONVENTION TextField_Release(TextFieldHandle* handle);
185
196 VANILLAPDF_API error_type CALLING_CONVENTION ChoiceField_Release(ChoiceFieldHandle* handle);
197
210 VANILLAPDF_API error_type CALLING_CONVENTION SignatureField_GetValue(SignatureFieldHandle* handle, DigitalSignatureHandle** result);
211
215 VANILLAPDF_API error_type CALLING_CONVENTION SignatureField_Release(SignatureFieldHandle* handle);
216
219#ifdef __cplusplus
220};
221#endif
222
223#endif /* _C_FIELDS_H */
This file contains macro declarations for importing and exporting symbols from library boundaries.
This file contains all type forward declarations returned by the library API.
This file contains types and constants used as parameters or return values.
A button field represents an interactive control on the screen that the user can manipulate with the ...
error_type CALLING_CONVENTION ButtonField_Release(ButtonFieldHandle *handle)
Decrement the internal reference counter.
A choice field contains several text items, one or more of which shall be selected as the field value...
error_type CALLING_CONVENTION ChoiceField_Release(ChoiceFieldHandle *handle)
Decrement the internal reference counter.
Represents document's authenticated digital signature.
Collection of FieldHandle.
error_type CALLING_CONVENTION FieldCollection_GetSize(FieldCollectionHandle *handle, size_type *result)
Get size of field collection.
error_type CALLING_CONVENTION FieldCollection_Release(FieldCollectionHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION FieldCollection_At(FieldCollectionHandle *handle, size_type at, FieldHandle **result)
Get single field from array at specific position.
Base class for all fields.
error_type CALLING_CONVENTION Field_GetType(FieldHandle *handle, FieldType *result)
Return type of field. Result can be used to convert to derived type.
error_type CALLING_CONVENTION Field_ToChoice(FieldHandle *handle, ChoiceFieldHandle **result)
Reinterpret current object as ChoiceFieldHandle.
error_type CALLING_CONVENTION Field_ToSignature(FieldHandle *handle, SignatureFieldHandle **result)
Reinterpret current object as SignatureFieldHandle.
error_type CALLING_CONVENTION Field_ToButton(FieldHandle *handle, ButtonFieldHandle **result)
Reinterpret current object as ButtonFieldHandle.
error_type CALLING_CONVENTION Field_ToText(FieldHandle *handle, TextFieldHandle **result)
Reinterpret current object as TextFieldHandle.
error_type CALLING_CONVENTION Field_Release(FieldHandle *handle)
Decrement the internal reference counter.
A signature field (PDF 1.3) is a form field that contains a digital signature.
error_type CALLING_CONVENTION SignatureField_GetValue(SignatureFieldHandle *handle, DigitalSignatureHandle **result)
A signature dictionary containing the signature and specifying various attributes of the signature fi...
error_type CALLING_CONVENTION SignatureField_Release(SignatureFieldHandle *handle)
Decrement the internal reference counter.
A text field is a box or space for text fill-in data typically entered from a keyboard.
error_type CALLING_CONVENTION TextField_Release(TextFieldHandle *handle)
Decrement the internal reference counter.
FieldType
Available types of fields.
Definition: c_fields.h:72
@ FieldType_Text
A text field is a box or space for text fill-in data typically entered from a keyboard.
Definition: c_fields.h:85
@ FieldType_Button
A button field represents an interactive control on the screen that the user can manipulate with the ...
Definition: c_fields.h:79
@ FieldType_Signature
A signature field (PDF 1.3) is a form field that contains a digital signature.
Definition: c_fields.h:97
@ FieldType_Choice
A choice field contains several text items, one or more of which shall be selected as the field value...
Definition: c_fields.h:91
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62