libdocument/ev-link-action.h

   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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef EV_LINK_ACTION_H
  22 #define EV_LINK_ACTION_H
  23
  24 #include <glib-object.h>
  25 #include "ev-link-dest.h"
  26
  27 G_BEGIN_DECLS
  28
  29 typedef struct _EvLinkAction        EvLinkAction;
  30 typedef struct _EvLinkActionClass   EvLinkActionClass;
  31 typedef struct _EvLinkActionPrivate EvLinkActionPrivate;
  32
  33 #define EV_TYPE_LINK_ACTION              (ev_link_action_get_type())
  34 #define EV_LINK_ACTION(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_LINK_ACTION, EvLinkAction))
  35 #define EV_LINK_ACTION_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_LINK_ACTION, EvLinkActionClass))
  36 #define EV_IS_LINK_ACTION(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_LINK_ACTION))
  37 #define EV_IS_LINK_ACTION_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_LINK_ACTION))
  38 #define EV_LINK_ACTION_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_LINK_ACTION, EvLinkActionClass))
  39
  40 #define EV_TYPE_LINK_ACTION_TYPE         (ev_link_action_type_get_type ())
  41
  42 typedef enum {
  43         EV_LINK_ACTION_TYPE_GOTO_DEST,
  44         EV_LINK_ACTION_TYPE_GOTO_REMOTE,
  45         EV_LINK_ACTION_TYPE_EXTERNAL_URI,
  46         EV_LINK_ACTION_TYPE_LAUNCH,
  47         EV_LINK_ACTION_TYPE_NAMED
  48         /* We'll probably fill this in more as we support the other types of
  49          * actions */
  50 } EvLinkActionType;
  51
  52 GType            ev_link_action_type_get_type    (void) G_GNUC_CONST;
  53 GType            ev_link_action_get_type         (void) G_GNUC_CONST;
  54
  55 EvLinkActionType ev_link_action_get_action_type  (EvLinkAction *self);
  56 EvLinkDest      *ev_link_action_get_dest         (EvLinkAction *self);
  57 const gchar     *ev_link_action_get_uri          (EvLinkAction *self);
  58 const gchar     *ev_link_action_get_filename     (EvLinkAction *self);
  59 const gchar     *ev_link_action_get_params       (EvLinkAction *self);
  60 const gchar     *ev_link_action_get_name         (EvLinkAction *self);
  61
  62 EvLinkAction    *ev_link_action_new_dest         (EvLinkDest   *dest);
  63 EvLinkAction    *ev_link_action_new_remote       (EvLinkDest   *dest,
  64                                                   const gchar  *filename);
  65 EvLinkAction    *ev_link_action_new_external_uri (const gchar  *uri);
  66 EvLinkAction    *ev_link_action_new_launch       (const gchar  *filename,
  67                                                   const gchar  *params);
  68 EvLinkAction    *ev_link_action_new_named        (const gchar  *name);
  69
  70 G_END_DECLS
  71
  72 #endif /* EV_LINK_ACTION_H */