backend/ev-link.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_LINK_H
  21 #define EV_LINK_H
  22
  23 #include <glib-object.h>
  24
  25 G_BEGIN_DECLS
  26
  27 typedef struct _EvLink EvLink;
  28 typedef struct _EvLinkClass EvLinkClass;
  29 typedef struct _EvLinkPrivate EvLinkPrivate;
  30
  31 #define EV_TYPE_LINK              (ev_link_get_type())
  32 #define EV_LINK(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_LINK, EvLink))
  33 #define EV_LINK_CLASS(klass)      (G_TYPE_CHACK_CLASS_CAST((klass), EV_TYPE_LINK, EvLinkClass))
  34 #define EV_IS_LINK(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_LINK))
  35 #define EV_IS_LINK_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), EV_TYPE_LINK))
  36 #define EV_LINK_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_LINK, EvLinkClass))
  37
  38 #define EV_TYPE_LINK_TYPE         (ev_link_type_get_type ())
  39
  40
  41
  42 typedef enum
  43 {
  44         EV_LINK_TYPE_TITLE,
  45         EV_LINK_TYPE_PAGE,
  46         EV_LINK_TYPE_PAGE_XYZ,
  47         EV_LINK_TYPE_PAGE_FIT,
  48         EV_LINK_TYPE_PAGE_FITH,
  49         EV_LINK_TYPE_PAGE_FITV,
  50         EV_LINK_TYPE_PAGE_FITR,
  51         EV_LINK_TYPE_EXTERNAL_URI,
  52         EV_LINK_TYPE_LAUNCH
  53         /* We'll probably fill this in more as we support the other types of
  54          * links */
  55 } EvLinkType;
  56
  57 GType           ev_link_type_get_type   (void);
  58 GType           ev_link_get_type        (void);
  59
  60 EvLink         *ev_link_new_title       (const char     *title);
  61 EvLink         *ev_link_new_page        (const char     *title,
  62                                          int             page);
  63 EvLink         *ev_link_new_page_xyz    (const char     *title,
  64                                          int             page,
  65                                          double          top,
  66                                          double          left,
  67                                          double          zoom);
  68 EvLink         *ev_link_new_page_fith   (const char     *title,
  69                                          int             page,
  70                                          double          top);
  71 EvLink         *ev_link_new_page_fitv   (const char     *title,
  72                                          int             page,
  73                                          double          left);
  74 EvLink         *ev_link_new_page_fitr   (const char     *title,
  75                                          int             page,
  76                                          double          left,
  77                                          double          bottom,
  78                                          double          right,
  79                                          double          top);
  80 EvLink         *ev_link_new_page_fit    (const char     *title,
  81                                          int             page);
  82 EvLink         *ev_link_new_external    (const char     *title,
  83                                          const char     *uri);
  84 EvLink         *ev_link_new_launch      (const char     *title,
  85                                          const char     *filename,
  86                                          const char     *params);
  87
  88 const char     *ev_link_get_title       (EvLink     *link);
  89 const char     *ev_link_get_uri         (EvLink     *link);
  90 EvLinkType      ev_link_get_link_type   (EvLink     *link);
  91 int             ev_link_get_page        (EvLink     *link);
  92 double          ev_link_get_top         (EvLink     *link);
  93 double          ev_link_get_left        (EvLink     *link);
  94 double          ev_link_get_bottom      (EvLink     *link);
  95 double          ev_link_get_right       (EvLink     *link);
  96 double          ev_link_get_zoom        (EvLink     *link);
  97 const char     *ev_link_get_filename    (EvLink     *link);
  98 const char     *ev_link_get_params      (EvLink     *link);
  99
 100 /* Link Mapping stuff */
 101
 102 typedef struct _EvLinkMapping     EvLinkMapping;
 103 struct _EvLinkMapping
 104 {
 105         EvLink *link;
 106         gdouble x1;
 107         gdouble y1;
 108         gdouble x2;
 109         gdouble y2;
 110 };
 111
 112 void    ev_link_mapping_free (GList   *link_mapping);
 113 EvLink *ev_link_mapping_find (GList   *link_mapping,
 114                               gdouble  x,
 115                               gdouble  y);
 116 G_END_DECLS
 117
 118 #endif /* !EV_LINK_H */