1#ifndef _C_DESTINATIONS_H
2#define _C_DESTINATIONS_H
95 DestinationType_Undefined = 0,
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_GetPageNumber(DestinationHandle *handle, ObjectHandle **result)
The page of the document that shall be displayed.
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).
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