backend/ev-bookmark.h

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2005 Red Hat, Inc.
   4  *
   5  * Evince is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * Evince is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef EV_BOOKMARK_H
  21 #define EV_BOOKMARK_H
  22
  23 #include <glib-object.h>
  24
  25 G_BEGIN_DECLS
  26
  27 typedef struct _EvBookmark EvBookmark;
  28 typedef struct _EvBookmarkClass EvBookmarkClass;
  29 typedef struct _EvBookmarkPrivate EvBookmarkPrivate;
  30
  31 #define EV_TYPE_BOOKMARK                (ev_bookmark_get_type())
  32 #define EV_BOOKMARK(object)             (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_BOOKMARK, EvBookmark))
  33 #define EV_BOOKMARK_CLASS(klass)        (G_TYPE_CHACK_CLASS_CAST((klass), EV_TYPE_BOOKMARK, EvBookmarkClass))
  34 #define EV_IS_BOOKMARK(object)          (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_BOOKMARK))
  35 #define EV_IS_BOOKMARK_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_BOOKMARK))
  36 #define EV_BOOKMARK_GET_CLASS(object)   (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_BOOKMARK, EvBookmarkClass))
  37
  38 #define EV_TYPE_BOOKMARK_TYPE (ev_bookmark_type_get_type ())
  39
  40 typedef enum
  41 {
  42         EV_BOOKMARK_TYPE_TITLE,
  43         EV_BOOKMARK_TYPE_LINK,
  44         EV_BOOKMARK_TYPE_EXTERNAL_URI
  45 } EvBookmarkType;
  46
  47 struct _EvBookmark {
  48         GObject base_instance;
  49         EvBookmarkPrivate *priv;
  50 };
  51
  52 struct _EvBookmarkClass {
  53         GObjectClass base_class;
  54 };
  55
  56 GType           ev_bookmark_type_get_type       (void);
  57 GType           ev_bookmark_get_type            (void);
  58
  59 EvBookmark     *ev_bookmark_new                 (const char     *title,
  60                                                  EvBookmarkType  type,
  61                                                  int             page);
  62 const char     *ev_bookmark_get_title           (EvBookmark     *bookmark);
  63 void            ev_bookmark_set_title           (EvBookmark     *bookmark,
  64                                                  const char     *title);
  65 EvBookmarkType  ev_bookmark_get_bookmark_type   (EvBookmark     *bookmark);
  66 void            ev_bookmark_set_bookmark_type   (EvBookmark     *bookmark,
  67                                                  EvBookmarkType  type);
  68 int             ev_bookmark_get_page            (EvBookmark     *bookmark);
  69 void            ev_bookmark_set_page            (EvBookmark     *bookmark,
  70                                                  int             page);
  71
  72 G_END_DECLS
  73
  74 #endif /* !EV_BOOKMARK_H */