Vanilla.PDF  1.5.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 {
73  FieldType_Undefined = 0,
74 
79  FieldType_Button,
80 
85  FieldType_Text,
86 
91  FieldType_Choice,
92 
97  FieldType_Signature,
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 */
FieldHandle::Field_ToText
error_type Field_ToText(FieldHandle *handle, TextFieldHandle **result)
Reinterpret current object as TextFieldHandle.
FieldCollectionHandle
Collection of FieldHandle.
ChoiceFieldHandle::ChoiceField_Release
error_type ChoiceField_Release(ChoiceFieldHandle *handle)
Decrement the internal reference counter.
FieldHandle::Field_ToChoice
error_type Field_ToChoice(FieldHandle *handle, ChoiceFieldHandle **result)
Reinterpret current object as ChoiceFieldHandle.
TextFieldHandle::TextField_Release
error_type TextField_Release(TextFieldHandle *handle)
Decrement the internal reference counter.
FieldType_Button
Definition: c_fields.h:79
ButtonFieldHandle
A button field represents an interactive control on the screen that the user can manipulate with the ...
TextFieldHandle
A text field is a box or space for text fill-in data typically entered from a keyboard.
c_handles.h
This file contains all type forward declarations returned by the library API.
FieldCollectionHandle::FieldCollection_Release
error_type FieldCollection_Release(FieldCollectionHandle *handle)
Decrement the internal reference counter.
ButtonFieldHandle::ButtonField_Release
error_type ButtonField_Release(ButtonFieldHandle *handle)
Decrement the internal reference counter.
ChoiceFieldHandle
A choice field contains several text items, one or more of which shall be selected as the field value...
size_type
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62
SignatureFieldHandle::SignatureField_Release
error_type SignatureField_Release(SignatureFieldHandle *handle)
Decrement the internal reference counter.
FieldHandle::Field_GetType
error_type Field_GetType(FieldHandle *handle, FieldType *result)
Return type of field. Result can be used to convert to derived type.
FieldType
FieldType
Available types of fields.
Definition: c_fields.h:72
FieldHandle::Field_Release
error_type Field_Release(FieldHandle *handle)
Decrement the internal reference counter.
FieldType_Choice
Definition: c_fields.h:91
SignatureFieldHandle::SignatureField_GetValue
error_type SignatureField_GetValue(SignatureFieldHandle *handle, DigitalSignatureHandle **result)
A signature dictionary containing the signature and specifying various attributes of the signature fi...
error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries...
DigitalSignatureHandle
Represents document's authenticated digital signature.
FieldHandle::Field_ToSignature
error_type Field_ToSignature(FieldHandle *handle, SignatureFieldHandle **result)
Reinterpret current object as SignatureFieldHandle.
FieldType_Signature
Definition: c_fields.h:97
FieldType_Text
Definition: c_fields.h:85
FieldCollectionHandle::FieldCollection_At
error_type FieldCollection_At(FieldCollectionHandle *handle, size_type at, FieldHandle **result)
Get single field from array at specific position.
c_values.h
This file contains types and constants used as parameters or return values.
SignatureFieldHandle
A signature field (PDF 1.3) is a form field that contains a digital signature.
FieldHandle
Base class for all fields.
FieldCollectionHandle::FieldCollection_GetSize
error_type FieldCollection_GetSize(FieldCollectionHandle *handle, size_type *result)
Get size of field collection.
FieldHandle::Field_ToButton
error_type Field_ToButton(FieldHandle *handle, ButtonFieldHandle **result)
Reinterpret current object as ButtonFieldHandle.