Vanilla.PDF  1.3.0
Cross-platform toolkit for creating and modifying PDF documents
c_annotations.h
Go to the documentation of this file.
1 #ifndef _C_ANNOTATIONS_H
2 #define _C_ANNOTATIONS_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 
50  typedef enum {
56 
62 
67 
73 
79 
85 
90 
96 
103 
110 
117 
124 
131 
137 
142 
148 
155 
162 
168 
174 
180 
189 
195 
202 
208 
214  } AnnotationType;
215 
226  VANILLAPDF_API error_type CALLING_CONVENTION Annotation_GetType(AnnotationHandle* handle, AnnotationType* result);
227 
231  VANILLAPDF_API error_type CALLING_CONVENTION Annotation_ToLink(AnnotationHandle* handle, LinkAnnotationHandle** result);
232 
237  VANILLAPDF_API error_type CALLING_CONVENTION Annotation_Release(AnnotationHandle* handle);
238 
249  VANILLAPDF_API error_type CALLING_CONVENTION LinkAnnotation_GetDestination(LinkAnnotationHandle* handle, DestinationHandle** result);
250 
254  VANILLAPDF_API error_type CALLING_CONVENTION LinkAnnotation_Release(LinkAnnotationHandle* handle);
255 
266  VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_Size(PageAnnotationsHandle* handle, size_type* result);
267 
275  VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_At(PageAnnotationsHandle* handle, size_type at, AnnotationHandle** result);
276 
281  VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_Release(PageAnnotationsHandle* handle);
282 
285 #ifdef __cplusplus
286 };
287 #endif
288 
289 #endif /* _C_ANNOTATIONS_H */
Definition: c_annotations.h:173
Definition: c_annotations.h:154
Base class for all annotations.
error_type PageAnnotations_Release(PageAnnotationsHandle *handle)
Decrement the internal reference counter.
Base class for all destinations.
error_type Annotation_GetType(AnnotationHandle *handle, AnnotationType *result)
Get annotation type of object handle.
Definition: c_annotations.h:213
Definition: c_annotations.h:72
Definition: c_annotations.h:201
Definition: c_annotations.h:136
Definition: c_annotations.h:89
error_type PageAnnotations_Size(PageAnnotationsHandle *handle, size_type *result)
Get size of annotation array.
Definition: c_annotations.h:194
Definition: c_annotations.h:207
Definition: c_annotations.h:109
Definition: c_annotations.h:167
This file contains all type forward declarations returned by the library API.
Definition: c_annotations.h:188
Definition: c_annotations.h:116
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62
Definition: c_annotations.h:61
Definition: c_annotations.h:141
Definition: c_annotations.h:55
Definition: c_annotations.h:84
error_type Annotation_ToLink(AnnotationHandle *handle, LinkAnnotationHandle **result)
Reinterpret current object as LinkAnnotationHandle.
An array of annotation dictionaries that shall contain indirect references to all AnnotationHandle as...
error_type Annotation_Release(AnnotationHandle *handle)
Decrement the internal reference counter.
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
Definition: c_annotations.h:78
This file contains macro declarations for importing and exporting symbols from library boundaries...
error_type PageAnnotations_At(PageAnnotationsHandle *handle, size_type at, AnnotationHandle **result)
Get single annotation from array at specific position.
Definition: c_annotations.h:179
Definition: c_annotations.h:147
This file contains types and constants used as parameters or return values.
Definition: c_annotations.h:66
AnnotationType
Required for conversion to derived types.
Definition: c_annotations.h:50
Definition: c_annotations.h:95
Definition: c_annotations.h:161
Definition: c_annotations.h:102
Definition: c_annotations.h:123
Definition: c_annotations.h:130