Attachment 74809 Details for Bug 45384 – glib: add documentation for PopplerActions

[patch] glib: add documentation for PopplerActions

0002-glib-add-documentation-for-PopplerActions.patch (text/plain), 4.38 KB, created by Evan Nemerson on 2013-02-14 12:04:41 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Evan Nemerson

Created: 2013-02-14 12:04:41 UTC

Size: 4.38 KB

patch

obsolete

>From 904ec5f4affd4f1aa370f2c3b8741dd2df6d041c Mon Sep 17 00:00:00 2001
>From: Evan Nemerson <evan@coeus-group.com>
>Date: Thu, 14 Feb 2013 03:55:01 -0800
>Subject: [PATCH 2/2] glib: add documentation for PopplerActions
>
>Fixes bug 45384.
>---
> glib/poppler-action.h | 97 +++++++++++++++++++++++++++++++++++++++++++++++++--
> 1 file changed, 94 insertions(+), 3 deletions(-)
>
>diff --git a/glib/poppler-action.h b/glib/poppler-action.h
>index 2a5d7f8..37fac7f 100644
>--- a/glib/poppler-action.h
>+++ b/glib/poppler-action.h
>@@ -30,7 +30,7 @@ G_BEGIN_DECLS
>  * @POPPLER_ACTION_NONE: no action specified
>  * @POPPLER_ACTION_GOTO_DEST: go to destination
>  * @POPPLER_ACTION_GOTO_REMOTE: go to destination in another document
>- * @POPPLER_ACTION_LAUNCH: launch app (or open document
>+ * @POPPLER_ACTION_LAUNCH: launch app (or open document)
>  * @POPPLER_ACTION_URI: URI
>  * @POPPLER_ACTION_NAMED: predefined action
>  * @POPPLER_ACTION_MOVIE: play movies. Since 0.14
>@@ -184,7 +184,7 @@ struct _PopplerDest
> /**
>  * PopplerActionLayer:
>  * @action: a #PopplerActionLayerAction
>- * @layers: list of #PopplerLayers
>+ * @layers: (element-type PopplerLayer): list of #PopplerLayers
>  *
>  * Action to perform over a list of layers
>  */
>@@ -194,12 +194,27 @@ struct _PopplerActionLayer
> 	GList *layers;
> };
> 
>+/**
>+ * PopplerActionAny:
>+ * @type: action type
>+ * @title: action title
>+ *
>+ * Fields common to all #PopplerActions
>+ */
> struct _PopplerActionAny
> {
> 	PopplerActionType type;
> 	gchar *title;
> };
> 
>+/**
>+ * PopplerActionGotoDest:
>+ * @type: action type (%POPPLER_ACTION_GOTO_DEST)
>+ * @title: action title
>+ * @dest: destination
>+ *
>+ * Go to destination
>+ */
> struct _PopplerActionGotoDest
> {
> 	PopplerActionType type;
>@@ -208,6 +223,15 @@ struct _PopplerActionGotoDest
> 	PopplerDest *dest;
> };
> 
>+/**
>+ * PopplerActionGotoRemote:
>+ * @type: action type (%POPPLER_ACTION_GOTO_REMOTE)
>+ * @title: action title
>+ * @file_name: file name
>+ * @dest: destination
>+ *
>+ * Go to destination in another document
>+ */
> struct _PopplerActionGotoRemote
> {
> 	PopplerActionType type;
>@@ -217,6 +241,15 @@ struct _PopplerActionGotoRemote
> 	PopplerDest *dest;
> };
> 
>+/**
>+ * PopplerActionLaunch:
>+ * @type: action type (%POPPLER_ACTION_LAUNCH)
>+ * @title: action title
>+ * @file_name: file name
>+ * @params: parameters
>+ *
>+ * Launch app (or open document)
>+ */
> struct _PopplerActionLaunch
> {
> 	PopplerActionType type;
>@@ -226,6 +259,14 @@ struct _PopplerActionLaunch
> 	gchar *params;
> };
> 
>+/**
>+ * PopplerActionUri:
>+ * @type: action type (%POPPLER_ACTION_URI)
>+ * @title: action title
>+ * @uri: URI
>+ *
>+ * URI
>+ */
> struct _PopplerActionUri
> {
> 	PopplerActionType type;
>@@ -234,6 +275,14 @@ struct _PopplerActionUri
> 	char *uri;
> };
> 
>+/**
>+ * PopplerActionNamed:
>+ * @type: action type (%POPPLER_ACTION_NAMED)
>+ * @title: action title
>+ * @named_dest: named destination
>+ *
>+ * Predefined action
>+ */
> struct _PopplerActionNamed
> {
> 	PopplerActionType type;
>@@ -242,15 +291,37 @@ struct _PopplerActionNamed
> 	gchar *named_dest;
> };
> 
>+/**
>+ * PopplerActionMovie:
>+ * @type: action type (%POPPLER_ACTION_MOVIE)
>+ * @title: action title
>+ * @operation: operation
>+ * @movie: movie
>+ *
>+ * Play movies.
>+ *
>+ * Since: 0.14
>+ */
> struct _PopplerActionMovie
> {
>         PopplerActionType           type;
>         gchar                      *title;
> 
>         PopplerActionMovieOperation operation;
>-	PopplerMovie               *movie;
>+        PopplerMovie               *movie;
> };
> 
>+/**
>+ * PopplerActionRendition:
>+ * @type: action type (%POPPLER_ACTION_RENDITION)
>+ * @title: action title
>+ * @op: operation
>+ * @media: media
>+ *
>+ * Play multimedia content.
>+ *
>+ * Since: 0.14
>+ */
> struct _PopplerActionRendition
> {
> 	PopplerActionType type;
>@@ -260,6 +331,16 @@ struct _PopplerActionRendition
> 	PopplerMedia      *media;
> };
> 
>+/**
>+ * PopplerActionOCGState:
>+ * @type: action type (%POPPLER_ACTION_OCG_STATE)
>+ * @title: action title
>+ * @state_list: (element-type PopplerActionLayer): list of #PopplerActionLayer<-- -->s
>+ *
>+ * State of layer.
>+ *
>+ * Since: 0.14
>+ */
> struct _PopplerActionOCGState
> {
> 	PopplerActionType type;
>@@ -268,6 +349,16 @@ struct _PopplerActionOCGState
> 	GList            *state_list;
> };
> 
>+/**
>+ * PopplerActionJavascript:
>+ * @type: action type (%POPPLER_ACTION_JAVASCRIPT)
>+ * @title: action title
>+ * @script: javascript
>+ *
>+ * Javascript.
>+ *
>+ * Since: 0.18
>+ */
> struct _PopplerActionJavascript
> {
> 	PopplerActionType  type;
>-- 
>1.8.1.2
>

Actions: View | Splinter Review

Attachments on bug 45384: 56312 | 74809

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.