Evince
Evince is a document viewer capable of displaying multiple and single page document formats like PDF and Postscript.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ev-link-action.h
Go to the documentation of this file.
1 /* this file is part of evince, a gnome document viewer
2  *
3  * Copyright (C) 2006 Carlos Garcia Campos <carlosgc@gnome.org>
4  * Copyright (C) 2005 Red Hat, Inc.
5  *
6  * Evince is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Evince is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  */
20 
21 #if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
22 #error "Only <evince-document.h> can be included directly."
23 #endif
24 
25 #ifndef EV_LINK_ACTION_H
26 #define EV_LINK_ACTION_H
27 
28 #include <glib-object.h>
29 #include "ev-link-dest.h"
30 
31 G_BEGIN_DECLS
32 
33 typedef struct _EvLinkAction EvLinkAction;
34 typedef struct _EvLinkActionClass EvLinkActionClass;
35 typedef struct _EvLinkActionPrivate EvLinkActionPrivate;
36 
37 #define EV_TYPE_LINK_ACTION (ev_link_action_get_type())
38 #define EV_LINK_ACTION(object) (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_LINK_ACTION, EvLinkAction))
39 #define EV_LINK_ACTION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_LINK_ACTION, EvLinkActionClass))
40 #define EV_IS_LINK_ACTION(object) (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_LINK_ACTION))
41 #define EV_IS_LINK_ACTION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_LINK_ACTION))
42 #define EV_LINK_ACTION_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_LINK_ACTION, EvLinkActionClass))
43 
44 typedef enum {
45  EV_LINK_ACTION_TYPE_GOTO_DEST,
46  EV_LINK_ACTION_TYPE_GOTO_REMOTE,
47  EV_LINK_ACTION_TYPE_EXTERNAL_URI,
48  EV_LINK_ACTION_TYPE_LAUNCH,
49  EV_LINK_ACTION_TYPE_NAMED,
50  EV_LINK_ACTION_TYPE_LAYERS_STATE
51  /* We'll probably fill this in more as we support the other types of
52  * actions */
53 } EvLinkActionType;
54 
55 GType ev_link_action_get_type (void) G_GNUC_CONST;
56 
57 EvLinkActionType ev_link_action_get_action_type (EvLinkAction *self);
58 EvLinkDest *ev_link_action_get_dest (EvLinkAction *self);
59 const gchar *ev_link_action_get_uri (EvLinkAction *self);
60 const gchar *ev_link_action_get_filename (EvLinkAction *self);
61 const gchar *ev_link_action_get_params (EvLinkAction *self);
62 const gchar *ev_link_action_get_name (EvLinkAction *self);
63 GList *ev_link_action_get_show_list (EvLinkAction *self);
64 GList *ev_link_action_get_hide_list (EvLinkAction *self);
65 GList *ev_link_action_get_toggle_list (EvLinkAction *self);
66 
67 EvLinkAction *ev_link_action_new_dest (EvLinkDest *dest);
68 EvLinkAction *ev_link_action_new_remote (EvLinkDest *dest,
69  const gchar *filename);
70 EvLinkAction *ev_link_action_new_external_uri (const gchar *uri);
71 EvLinkAction *ev_link_action_new_launch (const gchar *filename,
72  const gchar *params);
73 EvLinkAction *ev_link_action_new_named (const gchar *name);
74 EvLinkAction *ev_link_action_new_layers_state (GList *show_list,
75  GList *hide_list,
76  GList *toggle_list);
77 
78 gboolean ev_link_action_equal (EvLinkAction *a,
79  EvLinkAction *b);
80 
81 G_END_DECLS
82 
83 #endif /* EV_LINK_ACTION_H */