Vanilla.PDF  1.5.3
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 {
39  DestinationType_Undefined = 0,
40 
47  DestinationType_XYZ,
48 
59  DestinationType_Fit,
60 
68  DestinationType_FitHorizontal,
69 
77  DestinationType_FitVertical,
78 
90  DestinationType_FitRectangle,
91 
102  DestinationType_FitBoundingBox,
103 
111  DestinationType_FitBoundingBoxHorizontal,
112 
120  DestinationType_FitBoundingBoxVertical,
121  } DestinationType;
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 */
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
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:59
DestinationType_FitBoundingBoxVertical
Display the page designated by page, with the horizontal coordinate left positioned at the left edge ...
Definition: c_destinations.h:120
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:68
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:77
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:47
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
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
A name object is an atomic symbol uniquely defined by a sequence of characters.
DestinationType_FitBoundingBox
Display the page designated by page, with its contents magnified just enough to fit its bounding box ...
Definition: c_destinations.h:102
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.