Vanilla.PDF  2.2.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
82 typedef enum {
83 FieldType_Undefined = 0,
84
90
96
102
108
114 } FieldType;
115
124 VANILLAPDF_API error_type CALLING_CONVENTION FieldCollection_GetSize(FieldCollectionHandle* handle, size_type* result);
125
130 VANILLAPDF_API error_type CALLING_CONVENTION FieldCollection_At(FieldCollectionHandle* handle, size_type at, FieldHandle** result);
131
136 VANILLAPDF_API error_type CALLING_CONVENTION FieldCollection_Release(FieldCollectionHandle* handle);
137
150 VANILLAPDF_API error_type CALLING_CONVENTION Field_CreateFromDictionary(DictionaryObjectHandle* dictionary, FieldHandle** result);
151
157 VANILLAPDF_API error_type CALLING_CONVENTION Field_GetType(FieldHandle* handle, FieldType* result);
158
163 VANILLAPDF_DEPRECATED VANILLAPDF_API error_type CALLING_CONVENTION Field_ToButton(FieldHandle* handle, ButtonFieldHandle** result);
164
169 VANILLAPDF_DEPRECATED VANILLAPDF_API error_type CALLING_CONVENTION Field_ToText(FieldHandle* handle, TextFieldHandle** result);
170
175 VANILLAPDF_DEPRECATED VANILLAPDF_API error_type CALLING_CONVENTION Field_ToChoice(FieldHandle* handle, ChoiceFieldHandle** result);
176
181 VANILLAPDF_DEPRECATED VANILLAPDF_API error_type CALLING_CONVENTION Field_ToSignature(FieldHandle* handle, SignatureFieldHandle** result);
182
187 VANILLAPDF_API error_type CALLING_CONVENTION Field_Release(FieldHandle* handle);
188
199 VANILLAPDF_API error_type CALLING_CONVENTION ButtonField_ToField(ButtonFieldHandle* handle, FieldHandle** result);
200
204 VANILLAPDF_API error_type CALLING_CONVENTION ButtonField_FromField(FieldHandle* handle, ButtonFieldHandle** result);
205
209 VANILLAPDF_API error_type CALLING_CONVENTION ButtonField_Release(ButtonFieldHandle* handle);
210
221 VANILLAPDF_API error_type CALLING_CONVENTION TextField_ToField(TextFieldHandle* handle, FieldHandle** result);
222
226 VANILLAPDF_API error_type CALLING_CONVENTION TextField_FromField(FieldHandle* handle, TextFieldHandle** result);
227
231 VANILLAPDF_API error_type CALLING_CONVENTION TextField_Release(TextFieldHandle* handle);
232
243 VANILLAPDF_API error_type CALLING_CONVENTION ChoiceField_ToField(ChoiceFieldHandle* handle, FieldHandle** result);
244
248 VANILLAPDF_API error_type CALLING_CONVENTION ChoiceField_FromField(FieldHandle* handle, ChoiceFieldHandle** result);
249
253 VANILLAPDF_API error_type CALLING_CONVENTION ChoiceField_Release(ChoiceFieldHandle* handle);
254
267 VANILLAPDF_API error_type CALLING_CONVENTION SignatureField_GetValue(SignatureFieldHandle* handle, DigitalSignatureHandle** result);
268
272 VANILLAPDF_API error_type CALLING_CONVENTION SignatureField_ToField(SignatureFieldHandle* handle, FieldHandle** result);
273
277 VANILLAPDF_API error_type CALLING_CONVENTION SignatureField_FromField(FieldHandle* handle, SignatureFieldHandle** result);
278
282 VANILLAPDF_API error_type CALLING_CONVENTION SignatureField_Release(SignatureFieldHandle* handle);
283
286#ifdef __cplusplus
287};
288#endif
289
290#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_FromField(FieldHandle *handle, ButtonFieldHandle **result)
Convert FieldHandle to ButtonFieldHandle.
error_type CALLING_CONVENTION ButtonField_Release(ButtonFieldHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION ButtonField_ToField(ButtonFieldHandle *handle, FieldHandle **result)
Reinterpret current object as FieldHandle.
A choice field contains several text items, one or more of which shall be selected as the field value...
error_type CALLING_CONVENTION ChoiceField_ToField(ChoiceFieldHandle *handle, FieldHandle **result)
Reinterpret current object as FieldHandle.
error_type CALLING_CONVENTION ChoiceField_Release(ChoiceFieldHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION ChoiceField_FromField(FieldHandle *handle, ChoiceFieldHandle **result)
Convert FieldHandle to ChoiceFieldHandle.
A dictionary object is an associative table containing pairs of objects.
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.
VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION Field_ToButton(FieldHandle *handle, ButtonFieldHandle **result)
Reinterpret current object as ButtonFieldHandle.
error_type CALLING_CONVENTION Field_CreateFromDictionary(DictionaryObjectHandle *dictionary, FieldHandle **result)
Create a field from a dictionary object. The field type is determined by the /FT entry in the diction...
VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION Field_ToText(FieldHandle *handle, TextFieldHandle **result)
Reinterpret current object as TextFieldHandle.
VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION Field_ToSignature(FieldHandle *handle, SignatureFieldHandle **result)
Reinterpret current object as SignatureFieldHandle.
error_type CALLING_CONVENTION Field_Release(FieldHandle *handle)
Decrement the internal reference counter.
VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION Field_ToChoice(FieldHandle *handle, ChoiceFieldHandle **result)
Reinterpret current object as ChoiceFieldHandle.
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_FromField(FieldHandle *handle, SignatureFieldHandle **result)
Convert FieldHandle to SignatureFieldHandle.
error_type CALLING_CONVENTION SignatureField_ToField(SignatureFieldHandle *handle, FieldHandle **result)
Reinterpret current object as FieldHandle.
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_ToField(TextFieldHandle *handle, FieldHandle **result)
Reinterpret current object as FieldHandle.
error_type CALLING_CONVENTION TextField_Release(TextFieldHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION TextField_FromField(FieldHandle *handle, TextFieldHandle **result)
Convert FieldHandle to TextFieldHandle.
FieldType
Available types of fields.
Definition c_fields.h:82
@ FieldType_Text
A text field is a box or space for text fill-in data typically entered from a keyboard.
Definition c_fields.h:101
@ FieldType_NonTerminal
Many field attributes are inheritable, meaning that if they are not explicitly specified for a given ...
Definition c_fields.h:89
@ FieldType_Button
A button field represents an interactive control on the screen that the user can manipulate with the ...
Definition c_fields.h:95
@ FieldType_Signature
A signature field (PDF 1.3) is a form field that contains a digital signature.
Definition c_fields.h:113
@ 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:107
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