ev-link-action

ev-link-action

Synopsis

                    EvLinkAction;
                    EvLinkActionClass;
enum                EvLinkActionType;
gboolean            ev_link_action_equal                (EvLinkAction *a,
                                                         EvLinkAction *b);
EvLinkActionType    ev_link_action_get_action_type      (EvLinkAction *self);
EvLinkDest *        ev_link_action_get_dest             (EvLinkAction *self);
const gchar *       ev_link_action_get_uri              (EvLinkAction *self);
const gchar *       ev_link_action_get_filename         (EvLinkAction *self);
const gchar *       ev_link_action_get_params           (EvLinkAction *self);
const gchar *       ev_link_action_get_name             (EvLinkAction *self);
GList *             ev_link_action_get_hide_list        (EvLinkAction *self);
GList *             ev_link_action_get_show_list        (EvLinkAction *self);
GList *             ev_link_action_get_toggle_list      (EvLinkAction *self);
EvLinkAction *      ev_link_action_new_layers_state     (GList *show_list,
                                                         GList *hide_list,
                                                         GList *toggle_list);
EvLinkAction *      ev_link_action_new_dest             (EvLinkDest *dest);
EvLinkAction *      ev_link_action_new_remote           (EvLinkDest *dest,
                                                         const gchar *filename);
EvLinkAction *      ev_link_action_new_external_uri     (const gchar *uri);
EvLinkAction *      ev_link_action_new_launch           (const gchar *filename,
                                                         const gchar *params);
EvLinkAction *      ev_link_action_new_named            (const gchar *name);

Object Hierarchy

  GObject
   +----EvLinkAction
  GEnum
   +----EvLinkActionType

Properties

  "dest"                     EvLinkDest*           : Read / Write / Construct Only
  "filename"                 gchar*                : Read / Write / Construct Only
  "hide-list"                gpointer              : Read / Write / Construct Only
  "name"                     gchar*                : Read / Write / Construct Only
  "params"                   gchar*                : Read / Write / Construct Only
  "show-list"                gpointer              : Read / Write / Construct Only
  "toggle-list"              gpointer              : Read / Write / Construct Only
  "type"                     EvLinkActionType      : Read / Write / Construct Only
  "uri"                      gchar*                : Read / Write / Construct Only

Description

Details

EvLinkAction

typedef struct _EvLinkAction EvLinkAction;

EvLinkActionClass

typedef struct _EvLinkActionClass EvLinkActionClass;

enum EvLinkActionType

typedef enum {
	EV_LINK_ACTION_TYPE_GOTO_DEST,
	EV_LINK_ACTION_TYPE_GOTO_REMOTE,
	EV_LINK_ACTION_TYPE_EXTERNAL_URI,
	EV_LINK_ACTION_TYPE_LAUNCH,
	EV_LINK_ACTION_TYPE_NAMED,
	EV_LINK_ACTION_TYPE_LAYERS_STATE
	/* We'll probably fill this in more as we support the other types of
	 * actions */
} EvLinkActionType;

EV_LINK_ACTION_TYPE_GOTO_DEST

EV_LINK_ACTION_TYPE_GOTO_REMOTE

EV_LINK_ACTION_TYPE_EXTERNAL_URI

EV_LINK_ACTION_TYPE_LAUNCH

EV_LINK_ACTION_TYPE_NAMED

EV_LINK_ACTION_TYPE_LAYERS_STATE


ev_link_action_equal ()

gboolean            ev_link_action_equal                (EvLinkAction *a,
                                                         EvLinkAction *b);

Checks whether a and b are equal.

a :

a EvLinkAction

b :

a EvLinkAction

Returns :

TRUE iff a and b are equal

Since 3.8


ev_link_action_get_action_type ()

EvLinkActionType    ev_link_action_get_action_type      (EvLinkAction *self);

ev_link_action_get_dest ()

EvLinkDest *        ev_link_action_get_dest             (EvLinkAction *self);

self :

an EvLinkAction

Returns :

an EvLinkDest. [transfer none]

ev_link_action_get_uri ()

const gchar *       ev_link_action_get_uri              (EvLinkAction *self);

ev_link_action_get_filename ()

const gchar *       ev_link_action_get_filename         (EvLinkAction *self);

ev_link_action_get_params ()

const gchar *       ev_link_action_get_params           (EvLinkAction *self);

ev_link_action_get_name ()

const gchar *       ev_link_action_get_name             (EvLinkAction *self);

ev_link_action_get_hide_list ()

GList *             ev_link_action_get_hide_list        (EvLinkAction *self);

self :

an EvLinkAction

Returns :

a list of EvLayer objects. [transfer none][element-type EvLayer]

ev_link_action_get_show_list ()

GList *             ev_link_action_get_show_list        (EvLinkAction *self);

self :

an EvLinkAction

Returns :

a list of EvLayer objects. [transfer none][element-type EvLayer]

ev_link_action_get_toggle_list ()

GList *             ev_link_action_get_toggle_list      (EvLinkAction *self);

self :

an EvLinkAction

Returns :

a list of EvLayer objects. [transfer none][element-type EvLayer]

ev_link_action_new_layers_state ()

EvLinkAction *      ev_link_action_new_layers_state     (GList *show_list,
                                                         GList *hide_list,
                                                         GList *toggle_list);

show_list :

a list of EvLayer objects. [element-type EvLayer]

hide_list :

a list of EvLayer objects. [element-type EvLayer]

toggle_list :

a list of EvLayer objects. [element-type EvLayer]

Returns :

a new EvLinkAction. [transfer full]

ev_link_action_new_dest ()

EvLinkAction *      ev_link_action_new_dest             (EvLinkDest *dest);

ev_link_action_new_remote ()

EvLinkAction *      ev_link_action_new_remote           (EvLinkDest *dest,
                                                         const gchar *filename);

ev_link_action_new_external_uri ()

EvLinkAction *      ev_link_action_new_external_uri     (const gchar *uri);

ev_link_action_new_launch ()

EvLinkAction *      ev_link_action_new_launch           (const gchar *filename,
                                                         const gchar *params);

ev_link_action_new_named ()

EvLinkAction *      ev_link_action_new_named            (const gchar *name);

Property Details

The "dest" property

  "dest"                     EvLinkDest*           : Read / Write / Construct Only

The link action destination.


The "filename" property

  "filename"                 gchar*                : Read / Write / Construct Only

The link action filename.

Default value: NULL


The "hide-list" property

  "hide-list"                gpointer              : Read / Write / Construct Only

The list of layers that should be hidden.


The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

The link action name.

Default value: NULL


The "params" property

  "params"                   gchar*                : Read / Write / Construct Only

The link action params.

Default value: NULL


The "show-list" property

  "show-list"                gpointer              : Read / Write / Construct Only

The list of layers that should be shown.


The "toggle-list" property

  "toggle-list"              gpointer              : Read / Write / Construct Only

The list of layers that should be toggled.


The "type" property

  "type"                     EvLinkActionType      : Read / Write / Construct Only

The link action type.

Default value: EV_LINK_ACTION_TYPE_GOTO_DEST


The "uri" property

  "uri"                      gchar*                : Read / Write / Construct Only

The link action URI.

Default value: NULL