This documentation is deprecated and will no longer be updated. Please use the official documentation at vanillapdf.readthedocs.io.
Vanilla.PDF  2.3.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
94 typedef enum {
95 DestinationType_Undefined = 0,
96
104
116
125
134
147
159
168
178
194 VANILLAPDF_API error_type CALLING_CONVENTION Destination_CreateFromArray(ArrayObjectHandle* array_handle, DestinationHandle** result);
195
206 VANILLAPDF_API error_type CALLING_CONVENTION Destination_CreateFromDictionary(DictionaryObjectHandle* dict_handle, DestinationHandle** result);
207
211 VANILLAPDF_API error_type CALLING_CONVENTION Destination_GetDestinationType(DestinationHandle* handle, DestinationType* result);
212
225 VANILLAPDF_API error_type CALLING_CONVENTION Destination_GetPageNumber(DestinationHandle* handle, ObjectHandle** result);
226
230 VANILLAPDF_API error_type CALLING_CONVENTION Destination_ToUnknown(DestinationHandle* handle, IUnknownHandle** result);
231
235 VANILLAPDF_API error_type CALLING_CONVENTION Destination_FromUnknown(IUnknownHandle* handle, DestinationHandle** result);
236
242 VANILLAPDF_API error_type CALLING_CONVENTION Destination_Resolve(ObjectHandle* handle, DestinationHandle** result);
243
255 VANILLAPDF_API error_type CALLING_CONVENTION XYZDestination_FromDestination(DestinationHandle* handle, XYZDestinationHandle** result);
256
260 VANILLAPDF_API error_type CALLING_CONVENTION XYZDestination_ToDestination(XYZDestinationHandle* handle, DestinationHandle** result);
261
266 VANILLAPDF_API error_type CALLING_CONVENTION XYZDestination_GetLeft(XYZDestinationHandle* handle, ObjectHandle** result);
267
272 VANILLAPDF_API error_type CALLING_CONVENTION XYZDestination_GetTop(XYZDestinationHandle* handle, ObjectHandle** result);
273
278 VANILLAPDF_API error_type CALLING_CONVENTION XYZDestination_GetZoom(XYZDestinationHandle* handle, ObjectHandle** result);
279
284 VANILLAPDF_API error_type CALLING_CONVENTION XYZDestination_Release(XYZDestinationHandle* handle);
285
297 VANILLAPDF_API error_type CALLING_CONVENTION FitDestination_FromDestination(DestinationHandle* handle, FitDestinationHandle** result);
298
302 VANILLAPDF_API error_type CALLING_CONVENTION FitDestination_ToDestination(FitDestinationHandle* handle, DestinationHandle** result);
303
308 VANILLAPDF_API error_type CALLING_CONVENTION FitDestination_Release(FitDestinationHandle* handle);
309
317 VANILLAPDF_API error_type CALLING_CONVENTION FitHorizontalDestination_FromDestination(DestinationHandle* handle, FitHorizontalDestinationHandle** result);
318 VANILLAPDF_API error_type CALLING_CONVENTION FitHorizontalDestination_ToDestination(FitHorizontalDestinationHandle* handle, DestinationHandle** result);
319
324 VANILLAPDF_API error_type CALLING_CONVENTION FitHorizontalDestination_GetTop(FitHorizontalDestinationHandle* handle, ObjectHandle** result);
325
326 VANILLAPDF_API error_type CALLING_CONVENTION FitHorizontalDestination_Release(FitHorizontalDestinationHandle* handle);
327
335 VANILLAPDF_API error_type CALLING_CONVENTION FitVerticalDestination_FromDestination(DestinationHandle* handle, FitVerticalDestinationHandle** result);
336 VANILLAPDF_API error_type CALLING_CONVENTION FitVerticalDestination_ToDestination(FitVerticalDestinationHandle* handle, DestinationHandle** result);
337
342 VANILLAPDF_API error_type CALLING_CONVENTION FitVerticalDestination_GetLeft(FitVerticalDestinationHandle* handle, ObjectHandle** result);
343
344 VANILLAPDF_API error_type CALLING_CONVENTION FitVerticalDestination_Release(FitVerticalDestinationHandle* handle);
345
353 VANILLAPDF_API error_type CALLING_CONVENTION FitRectangleDestination_FromDestination(DestinationHandle* handle, FitRectangleDestinationHandle** result);
354 VANILLAPDF_API error_type CALLING_CONVENTION FitRectangleDestination_ToDestination(FitRectangleDestinationHandle* handle, DestinationHandle** result);
355
360 VANILLAPDF_API error_type CALLING_CONVENTION FitRectangleDestination_GetLeft(FitRectangleDestinationHandle* handle, ObjectHandle** result);
361
367
372 VANILLAPDF_API error_type CALLING_CONVENTION FitRectangleDestination_GetRight(FitRectangleDestinationHandle* handle, ObjectHandle** result);
373
378 VANILLAPDF_API error_type CALLING_CONVENTION FitRectangleDestination_GetTop(FitRectangleDestinationHandle* handle, ObjectHandle** result);
379
380 VANILLAPDF_API error_type CALLING_CONVENTION FitRectangleDestination_Release(FitRectangleDestinationHandle* handle);
381
389 VANILLAPDF_API error_type CALLING_CONVENTION FitBoundingBoxDestination_FromDestination(DestinationHandle* handle, FitBoundingBoxDestinationHandle** result);
390 VANILLAPDF_API error_type CALLING_CONVENTION FitBoundingBoxDestination_ToDestination(FitBoundingBoxDestinationHandle* handle, DestinationHandle** result);
391 VANILLAPDF_API error_type CALLING_CONVENTION FitBoundingBoxDestination_Release(FitBoundingBoxDestinationHandle* handle);
392
400 VANILLAPDF_API error_type CALLING_CONVENTION FitBoundingBoxHorizontalDestination_FromDestination(DestinationHandle* handle, FitBoundingBoxHorizontalDestinationHandle** result);
401 VANILLAPDF_API error_type CALLING_CONVENTION FitBoundingBoxHorizontalDestination_ToDestination(FitBoundingBoxHorizontalDestinationHandle* handle, DestinationHandle** result);
402
408
409 VANILLAPDF_API error_type CALLING_CONVENTION FitBoundingBoxHorizontalDestination_Release(FitBoundingBoxHorizontalDestinationHandle* handle);
410
418 VANILLAPDF_API error_type CALLING_CONVENTION FitBoundingBoxVerticalDestination_FromDestination(DestinationHandle* handle, FitBoundingBoxVerticalDestinationHandle** result);
419 VANILLAPDF_API error_type CALLING_CONVENTION FitBoundingBoxVerticalDestination_ToDestination(FitBoundingBoxVerticalDestinationHandle* handle, DestinationHandle** result);
420
426
427 VANILLAPDF_API error_type CALLING_CONVENTION FitBoundingBoxVerticalDestination_Release(FitBoundingBoxVerticalDestinationHandle* handle);
428
433 VANILLAPDF_API error_type CALLING_CONVENTION Destination_Release(DestinationHandle* handle);
434
445 VANILLAPDF_API error_type CALLING_CONVENTION NamedDestinations_Contains(NamedDestinationsHandle* handle, const NameObjectHandle* name, boolean_type* result);
446
455 VANILLAPDF_API error_type CALLING_CONVENTION NamedDestinations_Find(NamedDestinationsHandle* handle, const NameObjectHandle* name, DestinationHandle** result);
456
461 VANILLAPDF_API error_type CALLING_CONVENTION NamedDestinations_Release(NamedDestinationsHandle* handle);
462
465#ifdef __cplusplus
466};
467#endif
468
469#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.
An array object is a one-dimensional collection of objects arranged sequentially.
Base class for all destinations.
error_type CALLING_CONVENTION Destination_CreateFromArray(ArrayObjectHandle *array_handle, DestinationHandle **result)
Create a destination from an array object.
error_type CALLING_CONVENTION Destination_GetDestinationType(DestinationHandle *handle, DestinationType *result)
Get the type of destination to determine available parameters.
error_type CALLING_CONVENTION Destination_CreateFromDictionary(DictionaryObjectHandle *dict_handle, DestinationHandle **result)
Create a destination from a dictionary object.
error_type CALLING_CONVENTION Destination_ToUnknown(DestinationHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION Destination_Resolve(ObjectHandle *handle, DestinationHandle **result)
Create a DestinationHandle from a low-level ObjectHandle.
error_type CALLING_CONVENTION Destination_GetPageNumber(DestinationHandle *handle, ObjectHandle **result)
The page of the document that shall be displayed.
error_type CALLING_CONVENTION Destination_FromUnknown(IUnknownHandle *handle, DestinationHandle **result)
Convert IUnknownHandle to DestinationHandle.
A dictionary object is an associative table containing pairs of objects.
FitB destination that fits bounding box within window.
FitBH destination with vertical coordinate at top of bounding box.
error_type CALLING_CONVENTION FitBoundingBoxHorizontalDestination_GetTop(FitBoundingBoxHorizontalDestinationHandle *handle, ObjectHandle **result)
Get the top coordinate for FitBoundingBoxHorizontal destination (null means no change).
FitBV destination with horizontal coordinate at left of bounding box.
error_type CALLING_CONVENTION Destination_Release(DestinationHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION FitBoundingBoxVerticalDestination_GetLeft(FitBoundingBoxVerticalDestinationHandle *handle, ObjectHandle **result)
Get the left coordinate for FitBoundingBoxVertical destination (null means no change).
Fit destination that fits the entire page within the window.
error_type CALLING_CONVENTION FitDestination_FromDestination(DestinationHandle *handle, FitDestinationHandle **result)
Convert destination to Fit destination if the type matches.
error_type CALLING_CONVENTION FitDestination_ToDestination(FitDestinationHandle *handle, DestinationHandle **result)
Convert Fit destination back to base destination.
error_type CALLING_CONVENTION FitDestination_Release(FitDestinationHandle *handle)
Decrement the internal reference counter.
FitH destination with vertical coordinate at top edge.
error_type CALLING_CONVENTION FitHorizontalDestination_GetTop(FitHorizontalDestinationHandle *handle, ObjectHandle **result)
Get the top coordinate for FitHorizontal destination (null means no change).
FitR destination that fits specified rectangle within window.
error_type CALLING_CONVENTION FitRectangleDestination_GetLeft(FitRectangleDestinationHandle *handle, ObjectHandle **result)
Get the left coordinate for FitRectangle destination.
error_type CALLING_CONVENTION FitRectangleDestination_GetTop(FitRectangleDestinationHandle *handle, ObjectHandle **result)
Get the top coordinate for FitRectangle destination.
error_type CALLING_CONVENTION FitRectangleDestination_GetRight(FitRectangleDestinationHandle *handle, ObjectHandle **result)
Get the right coordinate for FitRectangle destination.
error_type CALLING_CONVENTION FitRectangleDestination_GetBottom(FitRectangleDestinationHandle *handle, ObjectHandle **result)
Get the bottom coordinate for FitRectangle destination.
FitV destination with horizontal coordinate at left edge.
error_type CALLING_CONVENTION FitVerticalDestination_GetLeft(FitVerticalDestinationHandle *handle, ObjectHandle **result)
Get the left coordinate for FitVertical destination (null means no change).
Base class for reference counting.
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.
XYZ destination with optional left, top, and zoom parameters.
error_type CALLING_CONVENTION XYZDestination_GetZoom(XYZDestinationHandle *handle, ObjectHandle **result)
Get the zoom factor for XYZ destination (null means no change).
error_type CALLING_CONVENTION XYZDestination_GetTop(XYZDestinationHandle *handle, ObjectHandle **result)
Get the top coordinate for XYZ destination (null means no change).
error_type CALLING_CONVENTION XYZDestination_Release(XYZDestinationHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION XYZDestination_GetLeft(XYZDestinationHandle *handle, ObjectHandle **result)
Get the left coordinate for XYZ destination (null means no change).
error_type CALLING_CONVENTION XYZDestination_FromDestination(DestinationHandle *handle, XYZDestinationHandle **result)
Convert destination to XYZ destination if the type matches.
error_type CALLING_CONVENTION XYZDestination_ToDestination(XYZDestinationHandle *handle, DestinationHandle **result)
Convert XYZ destination back to base destination.
DestinationType
Available destination types.
Definition c_destinations.h:94
@ DestinationType_XYZ
Display the page designated by page, with the coordinates (left, top) positioned at the upper-left co...
Definition c_destinations.h:103
@ DestinationType_FitBoundingBoxHorizontal
Display the page designated by page, with the vertical coordinate top positioned at the top edge of t...
Definition c_destinations.h:167
@ DestinationType_Fit
Display the page designated by page, with its contents magnified just enough to fit the entire page w...
Definition c_destinations.h:115
@ DestinationType_FitBoundingBoxVertical
Display the page designated by page, with the horizontal coordinate left positioned at the left edge ...
Definition c_destinations.h:176
@ DestinationType_FitRectangle
Display the page designated by page, with its contents magnified just enough to fit the rectangle spe...
Definition c_destinations.h:146
@ DestinationType_FitVertical
Display the page designated by page, with the horizontal coordinate left positioned at the left edge ...
Definition c_destinations.h:133
@ DestinationType_FitHorizontal
Display the page designated by page, with the vertical coordinate top positioned at the top edge of t...
Definition c_destinations.h:124
@ DestinationType_FitBoundingBox
Display the page designated by page, with its contents magnified just enough to fit its bounding box ...
Definition c_destinations.h:158
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