Vanilla.PDF  1.5.1
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 
53  typedef enum {
54 
64 
70 
75 
81 
87 
93 
98 
104 
111 
118 
125 
132 
139 
145 
150 
156 
163 
170 
176 
182 
188 
197 
203 
210 
216 
222  } AnnotationType;
223 
234  VANILLAPDF_API error_type CALLING_CONVENTION Annotation_GetAnnotationType(AnnotationHandle* handle, AnnotationType* result);
235 
239  VANILLAPDF_API error_type CALLING_CONVENTION Annotation_ToLink(AnnotationHandle* handle, LinkAnnotationHandle** result);
240 
245  VANILLAPDF_API error_type CALLING_CONVENTION Annotation_Release(AnnotationHandle* handle);
246 
257  VANILLAPDF_API error_type CALLING_CONVENTION LinkAnnotation_GetDestination(LinkAnnotationHandle* handle, DestinationHandle** result);
258 
262  VANILLAPDF_API error_type CALLING_CONVENTION LinkAnnotation_Release(LinkAnnotationHandle* handle);
263 
274  VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_GetSize(PageAnnotationsHandle* handle, size_type* result);
275 
283  VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_At(PageAnnotationsHandle* handle, size_type at, AnnotationHandle** result);
284 
289  VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_Release(PageAnnotationsHandle* handle);
290 
293 #ifdef __cplusplus
294 };
295 #endif
296 
297 #endif /* _C_ANNOTATIONS_H */
Definition: c_annotations.h:181
Definition: c_annotations.h:162
An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF...
error_type PageAnnotations_Release(PageAnnotationsHandle *handle)
Decrement the internal reference counter.
Base class for all destinations.
Definition: c_annotations.h:221
Definition: c_annotations.h:80
Definition: c_annotations.h:209
Definition: c_annotations.h:144
Definition: c_annotations.h:97
Definition: c_annotations.h:202
Definition: c_annotations.h:215
Definition: c_annotations.h:117
Definition: c_annotations.h:175
This file contains all type forward declarations returned by the library API.
Definition: c_annotations.h:196
Definition: c_annotations.h:124
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62
error_type PageAnnotations_GetSize(PageAnnotationsHandle *handle, size_type *result)
Get size of annotation array.
Definition: c_annotations.h:69
Definition: c_annotations.h:149
Undefined unitialized default value, triggers error when used.
Definition: c_annotations.h:58
Definition: c_annotations.h:63
Definition: c_annotations.h:92
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_GetAnnotationType(AnnotationHandle *handle, AnnotationType *result)
Get annotation type of object handle.
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:86
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:187
Definition: c_annotations.h:155
This file contains types and constants used as parameters or return values.
Definition: c_annotations.h:74
AnnotationType
Derived types of AnnotationHandle.
Definition: c_annotations.h:53
Definition: c_annotations.h:103
Definition: c_annotations.h:169
Definition: c_annotations.h:110
Definition: c_annotations.h:131
Definition: c_annotations.h:138