Top |
PopplerAction * | poppler_action_copy () |
void | poppler_action_free () |
PopplerDest * | poppler_dest_copy () |
void | poppler_dest_free () |
PopplerAction | |
PopplerDest | |
struct | PopplerActionAny |
struct | PopplerActionGotoDest |
struct | PopplerActionGotoRemote |
struct | PopplerActionLaunch |
struct | PopplerActionUri |
struct | PopplerActionNamed |
struct | PopplerActionMovie |
struct | PopplerActionRendition |
struct | PopplerActionResetForm |
struct | PopplerActionOCGState |
struct | PopplerActionJavascript |
enum | PopplerActionType |
enum | PopplerDestType |
enum | PopplerActionMovieOperation |
PopplerActionLayer | |
enum | PopplerActionLayerAction |
GBoxed ├── PopplerAction ╰── PopplerDest GEnum ├── PopplerActionLayerAction ├── PopplerActionMovieOperation ├── PopplerActionType ╰── PopplerDestType
PopplerAction *
poppler_action_copy (PopplerAction *action
);
Copies action
, creating an identical PopplerAction.
PopplerDest *
poppler_dest_copy (PopplerDest *dest
);
Copies dest
, creating an identical PopplerDest.
A generic wrapper for actions that exposes only PopplerActionType.
Since 24.10 this type supports g_autoptr
typedef struct { PopplerDestType type; int page_num; double left; double bottom; double right; double top; double zoom; gchar *named_dest; guint change_left : 1; guint change_top : 1; guint change_zoom : 1; } PopplerDest;
Data structure for holding a destination
Note that named_dest
is the string representation of the named
destination. This is the right form to pass to poppler functions,
e.g. poppler_document_find_dest()
, but to get the destination as
it appears in the PDF itself, you need to convert it to a bytestring
with poppler_named_dest_to_bytestring()
first.
Also note that named_dest
does not have a defined encoding and
is not in a form suitable to be displayed to the user.
Since 24.10 this type supports g_autoptr
PopplerDestType |
type of destination |
|
page number |
||
left coordinate |
||
bottom coordinate |
||
right coordinate |
||
top coordinate |
||
scale factor |
||
name of the destination (POPPLER_DEST_NAMED only) |
||
whether left coordinate should be changed |
||
whether top coordinate should be changed |
||
whether scale factor should be changed |
struct PopplerActionAny { PopplerActionType type; gchar *title; };
Fields common to all PopplerActions
struct PopplerActionGotoDest { PopplerActionType type; gchar *title; PopplerDest *dest; };
Go to destination
PopplerActionType |
action type ( |
|
action title |
||
PopplerDest * |
destination |
struct PopplerActionGotoRemote { PopplerActionType type; gchar *title; gchar *file_name; PopplerDest *dest; };
Go to destination in another document
PopplerActionType |
action type ( |
|
action title |
||
file name |
||
PopplerDest * |
destination |
struct PopplerActionLaunch { PopplerActionType type; gchar *title; gchar *file_name; gchar *params; };
Launch app (or open document)
PopplerActionType |
action type ( |
|
action title |
||
file name |
||
parameters |
struct PopplerActionUri { PopplerActionType type; gchar *title; char *uri; };
URI
struct PopplerActionNamed { PopplerActionType type; gchar *title; gchar *named_dest; };
Predefined action
struct PopplerActionMovie { PopplerActionType type; gchar *title; PopplerActionMovieOperation operation; PopplerMovie *movie; };
Play movies.
PopplerActionType |
action type ( |
|
action title |
||
PopplerActionMovieOperation |
operation |
|
PopplerMovie * |
movie |
Since: 0.14
struct PopplerActionRendition { PopplerActionType type; gchar *title; gint op; PopplerMedia *media; };
Play multimedia content.
PopplerActionType |
action type ( |
|
action title |
||
operation |
||
PopplerMedia * |
media |
Since: 0.14
struct PopplerActionResetForm { PopplerActionType type; gchar *title; GList *fields; gboolean exclude; };
Resets some or all fields within a PDF form.
The default behavior resets only the list of fields
, but setting
exclude
to TRUE
will cause the action to reset all fields but those
listed. Providing an empty list of fields resets the entire form.
PopplerActionType |
action type ( |
|
action title |
||
list of field names to reset / retain. |
[element-type utf8][nullable] | |
whether to reset all but the listed fields |
Since: 0.90
struct PopplerActionOCGState { PopplerActionType type; gchar *title; GList *state_list; };
State of layer.
PopplerActionType |
action type ( |
|
action title |
||
list of PopplerActionLayers. |
[element-type PopplerActionLayer] |
Since: 0.14
struct PopplerActionJavascript { PopplerActionType type; gchar *title; gchar *script; };
Javascript.
Since: 0.18
Action types
Destination types
unknown destination |
||
go to page with coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom |
||
go to page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically |
||
go to page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window |
||
go to page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window |
||
go to page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically |
||
go to page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically |
||
go to page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window |
||
go to page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window |
||
got to page specified by a name. See |
typedef struct { PopplerActionLayerAction action; GList *layers; } PopplerActionLayer;
Action to perform over a list of layers