libdocument/ev-link-dest.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., 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_DEST_H
  26 #define EV_LINK_DEST_H
  27
  28 #include <glib-object.h>
  29
  30 G_BEGIN_DECLS
  31
  32 typedef struct _EvLinkDest        EvLinkDest;
  33 typedef struct _EvLinkDestClass   EvLinkDestClass;
  34 typedef struct _EvLinkDestPrivate EvLinkDestPrivate;
  35
  36 #define EV_TYPE_LINK_DEST              (ev_link_dest_get_type())
  37 #define EV_LINK_DEST(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_LINK_DEST, EvLinkDest))
  38 #define EV_LINK_DEST_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_LINK_DEST, EvLinkDestClass))
  39 #define EV_IS_LINK_DEST(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_LINK_DEST))
  40 #define EV_IS_LINK_DEST_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_LINK_DEST))
  41 #define EV_LINK_DEST_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_LINK_DEST, EvLinkDestClass))
  42
  43 typedef enum {
  44         EV_LINK_DEST_TYPE_PAGE,
  45         EV_LINK_DEST_TYPE_XYZ,
  46         EV_LINK_DEST_TYPE_FIT,
  47         EV_LINK_DEST_TYPE_FITH,
  48         EV_LINK_DEST_TYPE_FITV,
  49         EV_LINK_DEST_TYPE_FITR,
  50         EV_LINK_DEST_TYPE_NAMED,
  51         EV_LINK_DEST_TYPE_PAGE_LABEL,
  52         EV_LINK_DEST_TYPE_UNKNOWN
  53 } EvLinkDestType;
  54
  55 GType           ev_link_dest_get_type       (void) G_GNUC_CONST;
  56
  57 EvLinkDestType  ev_link_dest_get_dest_type  (EvLinkDest  *self);
  58 gint            ev_link_dest_get_page       (EvLinkDest  *self);
  59 gdouble         ev_link_dest_get_top        (EvLinkDest  *self,
  60                                              gboolean    *change_top);
  61 gdouble         ev_link_dest_get_left       (EvLinkDest  *self,
  62                                              gboolean    *change_left);
  63 gdouble         ev_link_dest_get_bottom     (EvLinkDest  *self);
  64 gdouble         ev_link_dest_get_right      (EvLinkDest  *self);
  65 gdouble         ev_link_dest_get_zoom       (EvLinkDest  *self,
  66                                              gboolean    *change_zoom);
  67 const gchar    *ev_link_dest_get_named_dest (EvLinkDest  *self);
  68 const gchar    *ev_link_dest_get_page_label (EvLinkDest  *self);
  69
  70 EvLinkDest     *ev_link_dest_new_page       (gint         page);
  71 EvLinkDest     *ev_link_dest_new_xyz        (gint         page,
  72                                              gdouble      left,
  73                                              gdouble      top,
  74                                              gdouble      zoom,
  75                                              gboolean     change_left,
  76                                              gboolean     change_top,
  77                                              gboolean     change_zoom);
  78 EvLinkDest     *ev_link_dest_new_fit        (gint         page);
  79 EvLinkDest     *ev_link_dest_new_fith       (gint         page,
  80                                              gdouble      top,
  81                                              gboolean     change_top);
  82 EvLinkDest     *ev_link_dest_new_fitv       (gint         page,
  83                                              gdouble      left,
  84                                              gboolean     change_left);
  85 EvLinkDest     *ev_link_dest_new_fitr       (gint         page,
  86                                              gdouble      left,
  87                                              gdouble      bottom,
  88                                              gdouble      right,
  89                                              gdouble      top);
  90 EvLinkDest     *ev_link_dest_new_named      (const gchar *named_dest);
  91 EvLinkDest     *ev_link_dest_new_page_label (const gchar *page_label);
  92
  93 G_END_DECLS
  94
  95 #endif /* EV_LINK_DEST_H */