Vanilla.PDF  1.4.1
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 
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 
38  typedef enum {
45  DestinationType_XYZ = 0,
46 
57  DestinationType_Fit,
58 
66  DestinationType_FitHorizontal,
67 
75  DestinationType_FitVertical,
76 
88  DestinationType_FitRectangle,
89 
100  DestinationType_FitBoundingBox,
101 
109  DestinationType_FitBoundingBoxHorizontal,
110 
118  DestinationType_FitBoundingBoxVertical,
119  } DestinationType;
120 
138  VANILLAPDF_API error_type CALLING_CONVENTION Destination_GetPageNumber(DestinationHandle* handle, ObjectHandle** result);
139 
144  VANILLAPDF_API error_type CALLING_CONVENTION Destination_Release(DestinationHandle* handle);
145 
156  VANILLAPDF_API error_type CALLING_CONVENTION NamedDestinations_Contains(NamedDestinationsHandle* handle, const NameObjectHandle* name, boolean_type* result);
157 
166  VANILLAPDF_API error_type CALLING_CONVENTION NamedDestinations_Find(NamedDestinationsHandle* handle, const NameObjectHandle* name, DestinationHandle** result);
167 
172  VANILLAPDF_API error_type CALLING_CONVENTION NamedDestinations_Release(NamedDestinationsHandle* handle);
173 
176 #ifdef __cplusplus
177 };
178 #endif
179 
180 #endif /* _C_DESTINATIONS_H */
DestinationType_FitBoundingBoxHorizontal
Display the page designated by page, with the vertical coordinate top positioned at the top edge of t...
Definition: c_destinations.h:109
NamedDestinationsHandle::NamedDestinations_Find
error_type NamedDestinations_Find(NamedDestinationsHandle *handle, const NameObjectHandle *name, DestinationHandle **result)
Find mapped value for key name.
DestinationType_Fit
Display the page designated by page, with its contents magnified just enough to fit the entire page w...
Definition: c_destinations.h:57
DestinationType_FitBoundingBoxVertical
Display the page designated by page, with the horizontal coordinate left positioned at the left edge ...
Definition: c_destinations.h:118
NamedDestinationsHandle::NamedDestinations_Contains
error_type NamedDestinations_Contains(NamedDestinationsHandle *handle, const NameObjectHandle *name, boolean_type *result)
Determine if current map contains name.
DestinationType_FitHorizontal
Display the page designated by page, with the vertical coordinate top positioned at the top edge of t...
Definition: c_destinations.h:66
DestinationHandle
Base class for all destinations.
DestinationType_FitVertical
Display the page designated by page, with the horizontal coordinate left positioned at the left edge ...
Definition: c_destinations.h:75
NamedDestinationsHandle
A map of unique names mapped to their associated a DestinationHandle.
c_handles.h
This file contains all type forward declarations returned by the library API.
DestinationType_XYZ
Display the page designated by page, with the coordinates (left, top) positioned at the upper-left co...
Definition: c_destinations.h:45
DestinationType_FitRectangle
Display the page designated by page, with its contents magnified just enough to fit the rectangle spe...
Definition: c_destinations.h:88
DestinationType
DestinationType
Available destination types.
Definition: c_destinations.h:38
DestinationHandle::Destination_GetPageNumber
error_type Destination_GetPageNumber(DestinationHandle *handle, ObjectHandle **result)
The page of the document that shall be displayed.
ObjectHandle
Base class for syntactic tokens.
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...
DestinationHandle::Destination_Release
error_type Destination_Release(DestinationHandle *handle)
Decrement the internal reference counter.
c_values.h
This file contains types and constants used as parameters or return values.
NameObjectHandle
Represents unique name references in document.
DestinationType_FitBoundingBox
Display the page designated by page, with its contents magnified just enough to fit its bounding box ...
Definition: c_destinations.h:100
boolean_type
int8_t boolean_type
Boolean type supported in C.
Definition: c_types.h:31
NamedDestinationsHandle::NamedDestinations_Release
error_type NamedDestinations_Release(NamedDestinationsHandle *handle)
Decrement the internal reference counter.