Vanilla.PDF  2.0.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
7
8#ifdef __cplusplus
9extern "C"
10{
11#endif
12
223
234 VANILLAPDF_API error_type CALLING_CONVENTION Annotation_GetAnnotationType(AnnotationHandle* handle, AnnotationType* result);
235
239 VANILLAPDF_API error_type CALLING_CONVENTION Annotation_ToUnknown(AnnotationHandle* handle, IUnknownHandle** result);
240
244 VANILLAPDF_API error_type CALLING_CONVENTION Annotation_FromUnknown(IUnknownHandle* handle, AnnotationHandle** result);
245
250 VANILLAPDF_API error_type CALLING_CONVENTION Annotation_Release(AnnotationHandle* handle);
251
262 VANILLAPDF_API error_type CALLING_CONVENTION LinkAnnotation_GetDestination(LinkAnnotationHandle* handle, DestinationHandle** result);
263
267 VANILLAPDF_API error_type CALLING_CONVENTION LinkAnnotation_ToBaseAnnotation(LinkAnnotationHandle* handle, AnnotationHandle** result);
268
272 VANILLAPDF_API error_type CALLING_CONVENTION LinkAnnotation_FromBaseAnnotation(AnnotationHandle* handle, LinkAnnotationHandle** result);
273
277 VANILLAPDF_API error_type CALLING_CONVENTION LinkAnnotation_Release(LinkAnnotationHandle* handle);
278
289 VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_GetSize(PageAnnotationsHandle* handle, size_type* result);
290
298 VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_At(PageAnnotationsHandle* handle, size_type at, AnnotationHandle** result);
299
303 VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_ToUnknown(PageAnnotationsHandle* handle, IUnknownHandle** result);
304
308 VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_FromUnknown(IUnknownHandle* handle, PageAnnotationsHandle** result);
309
314 VANILLAPDF_API error_type CALLING_CONVENTION PageAnnotations_Release(PageAnnotationsHandle* handle);
315
318#ifdef __cplusplus
319};
320#endif
321
322#endif /* _C_ANNOTATIONS_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.
An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF...
error_type CALLING_CONVENTION Annotation_ToUnknown(AnnotationHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION Annotation_GetAnnotationType(AnnotationHandle *handle, AnnotationType *result)
Get annotation type of object handle.
error_type CALLING_CONVENTION Annotation_FromUnknown(IUnknownHandle *handle, AnnotationHandle **result)
Convert IUnknownHandle to PageAnnotationsHandle.
error_type CALLING_CONVENTION Annotation_Release(AnnotationHandle *handle)
Decrement the internal reference counter.
Base class for all destinations.
Base class for reference counting.
An array of annotation dictionaries that shall contain indirect references to all AnnotationHandle as...
error_type CALLING_CONVENTION PageAnnotations_FromUnknown(IUnknownHandle *handle, PageAnnotationsHandle **result)
Convert IUnknownHandle to PageAnnotationsHandle.
error_type CALLING_CONVENTION PageAnnotations_ToUnknown(PageAnnotationsHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION PageAnnotations_At(PageAnnotationsHandle *handle, size_type at, AnnotationHandle **result)
Get single annotation from array at specific position.
error_type CALLING_CONVENTION PageAnnotations_GetSize(PageAnnotationsHandle *handle, size_type *result)
Get size of annotation array.
error_type CALLING_CONVENTION PageAnnotations_Release(PageAnnotationsHandle *handle)
Decrement the internal reference counter.
AnnotationType
Derived types of AnnotationHandle.
Definition c_annotations.h:53
@ AnnotationType_TripleD
Definition c_annotations.h:215
@ AnnotationType_Link
Definition c_annotations.h:69
@ AnnotationType_Polygon
Definition c_annotations.h:97
@ AnnotationType_TrapNetwork
Definition c_annotations.h:202
@ AnnotationType_RubberStamp
Definition c_annotations.h:138
@ AnnotationType_Popup
Definition c_annotations.h:155
@ AnnotationType_Watermark
Definition c_annotations.h:209
@ AnnotationType_Caret
Definition c_annotations.h:144
@ AnnotationType_Highlight
Definition c_annotations.h:110
@ AnnotationType_PrinterMark
Definition c_annotations.h:196
@ AnnotationType_Circle
Definition c_annotations.h:92
@ AnnotationType_FileAttachment
Definition c_annotations.h:162
@ AnnotationType_StrikeOut
Definition c_annotations.h:131
@ AnnotationType_Ink
Definition c_annotations.h:149
@ AnnotationType_Underline
Definition c_annotations.h:117
@ AnnotationType_Undefined
Undefined unitialized default value, triggers error when used.
Definition c_annotations.h:58
@ AnnotationType_Screen
Definition c_annotations.h:187
@ AnnotationType_PolyLine
Definition c_annotations.h:103
@ AnnotationType_Square
Definition c_annotations.h:86
@ AnnotationType_Text
Definition c_annotations.h:63
@ AnnotationType_Redaction
Definition c_annotations.h:221
@ AnnotationType_Sound
Definition c_annotations.h:169
@ AnnotationType_Widget
Definition c_annotations.h:181
@ AnnotationType_Movie
Definition c_annotations.h:175
@ AnnotationType_Line
Definition c_annotations.h:80
@ AnnotationType_Squiggly
Definition c_annotations.h:124
@ AnnotationType_FreeText
Definition c_annotations.h:74
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