Vanilla.PDF  1.6.0
Cross-platform toolkit for creating and modifying PDF documents
c_destinations.h
Go to the documentation of this file.
1#ifndef _C_DESTINATIONS_H
2#define _C_DESTINATIONS_H
3
7
8#ifdef __cplusplus
9extern "C"
10{
11#endif
12
38 typedef enum {
39 DestinationType_Undefined = 0,
40
48
60
69
78
91
103
112
122
140 VANILLAPDF_API error_type CALLING_CONVENTION Destination_GetPageNumber(DestinationHandle* handle, ObjectHandle** result);
141
146 VANILLAPDF_API error_type CALLING_CONVENTION Destination_Release(DestinationHandle* handle);
147
158 VANILLAPDF_API error_type CALLING_CONVENTION NamedDestinations_Contains(NamedDestinationsHandle* handle, const NameObjectHandle* name, boolean_type* result);
159
168 VANILLAPDF_API error_type CALLING_CONVENTION NamedDestinations_Find(NamedDestinationsHandle* handle, const NameObjectHandle* name, DestinationHandle** result);
169
174 VANILLAPDF_API error_type CALLING_CONVENTION NamedDestinations_Release(NamedDestinationsHandle* handle);
175
178#ifdef __cplusplus
179};
180#endif
181
182#endif /* _C_DESTINATIONS_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.
Base class for all destinations.
error_type CALLING_CONVENTION Destination_Release(DestinationHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION Destination_GetPageNumber(DestinationHandle *handle, ObjectHandle **result)
The page of the document that shall be displayed.
A name object is an atomic symbol uniquely defined by a sequence of characters.
A map of unique names mapped to their associated a DestinationHandle.
error_type CALLING_CONVENTION NamedDestinations_Contains(NamedDestinationsHandle *handle, const NameObjectHandle *name, boolean_type *result)
Determine if current map contains name.
error_type CALLING_CONVENTION NamedDestinations_Release(NamedDestinationsHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION NamedDestinations_Find(NamedDestinationsHandle *handle, const NameObjectHandle *name, DestinationHandle **result)
Find mapped value for key name.
Base class for syntactic tokens.
DestinationType
Available destination types.
Definition: c_destinations.h:38
@ DestinationType_XYZ
Display the page designated by page, with the coordinates (left, top) positioned at the upper-left co...
Definition: c_destinations.h:47
@ DestinationType_FitBoundingBoxHorizontal
Display the page designated by page, with the vertical coordinate top positioned at the top edge of t...
Definition: c_destinations.h:111
@ DestinationType_Fit
Display the page designated by page, with its contents magnified just enough to fit the entire page w...
Definition: c_destinations.h:59
@ DestinationType_FitBoundingBoxVertical
Display the page designated by page, with the horizontal coordinate left positioned at the left edge ...
Definition: c_destinations.h:120
@ DestinationType_FitRectangle
Display the page designated by page, with its contents magnified just enough to fit the rectangle spe...
Definition: c_destinations.h:90
@ DestinationType_FitVertical
Display the page designated by page, with the horizontal coordinate left positioned at the left edge ...
Definition: c_destinations.h:77
@ DestinationType_FitHorizontal
Display the page designated by page, with the vertical coordinate top positioned at the top edge of t...
Definition: c_destinations.h:68
@ DestinationType_FitBoundingBox
Display the page designated by page, with its contents magnified just enough to fit its bounding box ...
Definition: c_destinations.h:102
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
int8_t boolean_type
Boolean type supported in C.
Definition: c_types.h:31