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_actions.h
Go to the documentation of this file.
1#ifndef _C_ACTIONS_H
2#define _C_ACTIONS_H
3
7
8#ifdef __cplusplus
9extern "C"
10{
11#endif
12
66 typedef enum {
67
72
78
83
88
93
98
104
113 VANILLAPDF_API error_type CALLING_CONVENTION Action_GetActionType(ActionHandle* handle, ActionType* result);
114
118 VANILLAPDF_API error_type CALLING_CONVENTION Action_ToUnknown(ActionHandle* handle, IUnknownHandle** result);
119
123 VANILLAPDF_API error_type CALLING_CONVENTION Action_FromUnknown(IUnknownHandle* handle, ActionHandle** result);
124
130 VANILLAPDF_API error_type CALLING_CONVENTION Action_CreateFromDictionary(DictionaryObjectHandle* handle, ActionHandle** result);
131
136 VANILLAPDF_API error_type CALLING_CONVENTION Action_Release(ActionHandle* handle);
137
148 VANILLAPDF_API error_type CALLING_CONVENTION GoToAction_GetDestination(GoToActionHandle* handle, DestinationHandle** result);
149
153 VANILLAPDF_API error_type CALLING_CONVENTION GoToAction_ToAction(GoToActionHandle* handle, ActionHandle** result);
154
158 VANILLAPDF_API error_type CALLING_CONVENTION GoToAction_FromAction(ActionHandle* handle, GoToActionHandle** result);
159
163 VANILLAPDF_API error_type CALLING_CONVENTION GoToAction_Release(GoToActionHandle* handle);
164
175 VANILLAPDF_API error_type CALLING_CONVENTION URIAction_GetURI(URIActionHandle* handle, LiteralStringObjectHandle** result);
176
180 VANILLAPDF_API error_type CALLING_CONVENTION URIAction_ToAction(URIActionHandle* handle, ActionHandle** result);
181
185 VANILLAPDF_API error_type CALLING_CONVENTION URIAction_FromAction(ActionHandle* handle, URIActionHandle** result);
186
190 VANILLAPDF_API error_type CALLING_CONVENTION URIAction_Release(URIActionHandle* handle);
191
202 VANILLAPDF_API error_type CALLING_CONVENTION GoToRemoteAction_GetDestination(GoToRemoteActionHandle* handle, DestinationHandle** result);
203
207 VANILLAPDF_API error_type CALLING_CONVENTION GoToRemoteAction_GetFile(GoToRemoteActionHandle* handle, ObjectHandle** result);
208
212 VANILLAPDF_API error_type CALLING_CONVENTION GoToRemoteAction_ToAction(GoToRemoteActionHandle* handle, ActionHandle** result);
213
217 VANILLAPDF_API error_type CALLING_CONVENTION GoToRemoteAction_FromAction(ActionHandle* handle, GoToRemoteActionHandle** result);
218
222 VANILLAPDF_API error_type CALLING_CONVENTION GoToRemoteAction_Release(GoToRemoteActionHandle* handle);
223
234 VANILLAPDF_API error_type CALLING_CONVENTION NamedAction_GetName(NamedActionHandle* handle, NameObjectHandle** result);
235
239 VANILLAPDF_API error_type CALLING_CONVENTION NamedAction_ToAction(NamedActionHandle* handle, ActionHandle** result);
240
244 VANILLAPDF_API error_type CALLING_CONVENTION NamedAction_FromAction(ActionHandle* handle, NamedActionHandle** result);
245
249 VANILLAPDF_API error_type CALLING_CONVENTION NamedAction_Release(NamedActionHandle* handle);
250
253#ifdef __cplusplus
254};
255#endif
256
257#endif /* _C_ACTIONS_H */
ActionType
Derived types of ActionHandle.
Definition c_actions.h:66
@ ActionType_Launch
Definition c_actions.h:92
@ ActionType_Named
Definition c_actions.h:97
@ ActionType_GoTo
Definition c_actions.h:77
@ ActionType_JavaScript
Definition c_actions.h:102
@ ActionType_URI
Definition c_actions.h:87
@ ActionType_Undefined
Undefined unitialized default value, triggers error when used.
Definition c_actions.h:71
@ ActionType_GoToRemote
Definition c_actions.h:82
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 action to be performed when a link annotation, outline item, or other trigger is activated.
error_type CALLING_CONVENTION Action_FromUnknown(IUnknownHandle *handle, ActionHandle **result)
Convert IUnknownHandle to ActionHandle.
error_type CALLING_CONVENTION Action_Release(ActionHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION Action_GetActionType(ActionHandle *handle, ActionType *result)
Get action type of object handle.
error_type CALLING_CONVENTION Action_CreateFromDictionary(DictionaryObjectHandle *handle, ActionHandle **result)
Create an ActionHandle from a DictionaryObjectHandle.
error_type CALLING_CONVENTION Action_ToUnknown(ActionHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
Base class for all destinations.
A dictionary object is an associative table containing pairs of objects.
A go-to action changes the view to a specified destination within the same document.
error_type CALLING_CONVENTION GoToAction_Release(GoToActionHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION GoToAction_ToAction(GoToActionHandle *handle, ActionHandle **result)
Reinterpret current object as ActionHandle.
error_type CALLING_CONVENTION GoToAction_GetDestination(GoToActionHandle *handle, DestinationHandle **result)
A destination to be displayed when this action is performed.
error_type CALLING_CONVENTION GoToAction_FromAction(ActionHandle *handle, GoToActionHandle **result)
Convert ActionHandle to GoToActionHandle.
A remote go-to action is similar to a go-to action but jumps to a destination in another PDF file.
error_type CALLING_CONVENTION GoToRemoteAction_Release(GoToRemoteActionHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION GoToRemoteAction_FromAction(ActionHandle *handle, GoToRemoteActionHandle **result)
Convert ActionHandle to GoToRemoteActionHandle.
error_type CALLING_CONVENTION GoToRemoteAction_ToAction(GoToRemoteActionHandle *handle, ActionHandle **result)
Reinterpret current object as ActionHandle.
error_type CALLING_CONVENTION GoToRemoteAction_GetDestination(GoToRemoteActionHandle *handle, DestinationHandle **result)
A destination to be displayed when this action is performed.
error_type CALLING_CONVENTION GoToRemoteAction_GetFile(GoToRemoteActionHandle *handle, ObjectHandle **result)
The file in which the destination shall be found.
Base class for reference counting.
A literal string is preferable for printable data.
A name object is an atomic symbol uniquely defined by a sequence of characters.
A named action provides a way to execute a predefined action such as NextPage, PrevPage,...
error_type CALLING_CONVENTION NamedAction_FromAction(ActionHandle *handle, NamedActionHandle **result)
Convert ActionHandle to NamedActionHandle.
error_type CALLING_CONVENTION NamedAction_ToAction(NamedActionHandle *handle, ActionHandle **result)
Reinterpret current object as ActionHandle.
error_type CALLING_CONVENTION NamedAction_GetName(NamedActionHandle *handle, NameObjectHandle **result)
The name of the action that shall be performed.
error_type CALLING_CONVENTION NamedAction_Release(NamedActionHandle *handle)
Decrement the internal reference counter.
Base class for syntactic tokens.
A URI action causes a URI to be resolved.
error_type CALLING_CONVENTION URIAction_GetURI(URIActionHandle *handle, LiteralStringObjectHandle **result)
The uniform resource identifier to resolve.
error_type CALLING_CONVENTION URIAction_Release(URIActionHandle *handle)
Decrement the internal reference counter.
error_type CALLING_CONVENTION URIAction_ToAction(URIActionHandle *handle, ActionHandle **result)
Reinterpret current object as ActionHandle.
error_type CALLING_CONVENTION URIAction_FromAction(ActionHandle *handle, URIActionHandle **result)
Convert ActionHandle to URIActionHandle.
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25