Vanilla.PDF  1.4.1
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 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
72  typedef enum {
78 
84 
90 
96  } FieldType;
97 
106  VANILLAPDF_API error_type CALLING_CONVENTION FieldCollection_GetSize(FieldCollectionHandle* handle, size_type* result);
107 
112  VANILLAPDF_API error_type CALLING_CONVENTION FieldCollection_At(FieldCollectionHandle* handle, size_type at, FieldHandle** result);
113 
118  VANILLAPDF_API error_type CALLING_CONVENTION FieldCollection_Release(FieldCollectionHandle* handle);
119 
132  VANILLAPDF_API error_type CALLING_CONVENTION Field_GetType(FieldHandle* handle, FieldType* result);
133 
137  VANILLAPDF_API error_type CALLING_CONVENTION Field_ToButton(FieldHandle* handle, ButtonFieldHandle** result);
138 
142  VANILLAPDF_API error_type CALLING_CONVENTION Field_ToText(FieldHandle* handle, TextFieldHandle** result);
143 
147  VANILLAPDF_API error_type CALLING_CONVENTION Field_ToChoice(FieldHandle* handle, ChoiceFieldHandle** result);
148 
152  VANILLAPDF_API error_type CALLING_CONVENTION Field_ToSignature(FieldHandle* handle, SignatureFieldHandle** result);
153 
158  VANILLAPDF_API error_type CALLING_CONVENTION Field_Release(FieldHandle* handle);
159 
170  VANILLAPDF_API error_type CALLING_CONVENTION ButtonField_Release(ButtonFieldHandle* handle);
171 
182  VANILLAPDF_API error_type CALLING_CONVENTION TextField_Release(TextFieldHandle* handle);
183 
194  VANILLAPDF_API error_type CALLING_CONVENTION ChoiceField_Release(ChoiceFieldHandle* handle);
195 
208  VANILLAPDF_API error_type CALLING_CONVENTION SignatureField_GetValue(SignatureFieldHandle* handle, DigitalSignatureHandle** result);
209 
213  VANILLAPDF_API error_type CALLING_CONVENTION SignatureField_Release(SignatureFieldHandle* handle);
214 
217 #ifdef __cplusplus
218 };
219 #endif
220 
221 #endif /* _C_FIELDS_H */
error_type Field_ToText(FieldHandle *handle, TextFieldHandle **result)
Reinterpret current object as TextFieldHandle.
Collection of FieldHandle.
error_type ChoiceField_Release(ChoiceFieldHandle *handle)
Decrement the internal reference counter.
error_type Field_ToChoice(FieldHandle *handle, ChoiceFieldHandle **result)
Reinterpret current object as ChoiceFieldHandle.
error_type TextField_Release(TextFieldHandle *handle)
Decrement the internal reference counter.
Definition: c_fields.h:77
A button field represents an interactive control on the screen that the user can manipulate with the ...
A text field is a box or space for text fill-in data typically entered from a keyboard.
This file contains all type forward declarations returned by the library API.
error_type FieldCollection_Release(FieldCollectionHandle *handle)
Decrement the internal reference counter.
error_type 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...
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62
error_type SignatureField_Release(SignatureFieldHandle *handle)
Decrement the internal reference counter.
error_type Field_GetType(FieldHandle *handle, FieldType *result)
Return type of field. Result can be used to convert to derived type.
FieldType
Available types of fields.
Definition: c_fields.h:72
error_type Field_Release(FieldHandle *handle)
Decrement the internal reference counter.
Definition: c_fields.h:89
error_type SignatureField_GetValue(SignatureFieldHandle *handle, DigitalSignatureHandle **result)
A signature dictionary containing the signature and specifying various attributes of the signature fi...
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
This file contains macro declarations for importing and exporting symbols from library boundaries...
Represents document's authenticated digital signature.
error_type Field_ToSignature(FieldHandle *handle, SignatureFieldHandle **result)
Reinterpret current object as SignatureFieldHandle.
Definition: c_fields.h:95
Definition: c_fields.h:83
error_type FieldCollection_At(FieldCollectionHandle *handle, size_type at, FieldHandle **result)
Get single field from array at specific position.
This file contains types and constants used as parameters or return values.
A signature field (PDF 1.3) is a form field that contains a digital signature.
Base class for all fields.
error_type FieldCollection_GetSize(FieldCollectionHandle *handle, size_type *result)
Get size of field collection.
error_type Field_ToButton(FieldHandle *handle, ButtonFieldHandle **result)
Reinterpret current object as ButtonFieldHandle.