backend/ev-document-links.h

   1 /* ev-document-links.h
   2  *  this file is part of evince, a gnome document viewer
   3  *
   4  * Copyright (C) 2004 Red Hat, Inc.
   5  *
   6  * Author:
   7  *   Jonathan Blandford <jrb@alum.mit.edu>
   8  *
   9  * Evince is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * Evince is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef EV_DOCUMENT_LINKS_H
  25 #define EV_DOCUMENT_LINKS_H
  26
  27 #include <glib-object.h>
  28 #include <glib.h>
  29 #include <gdk/gdk.h>
  30
  31 #include "ev-document.h"
  32 #include "ev-link.h"
  33
  34 G_BEGIN_DECLS
  35
  36
  37 #define EV_TYPE_DOCUMENT_LINKS            (ev_document_links_get_type ())
  38 #define EV_DOCUMENT_LINKS(o)              (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_LINKS, EvDocumentLinks))
  39 #define EV_DOCUMENT_LINKS_IFACE(k)        (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_LINKS, EvDocumentLinksIface))
  40 #define EV_IS_DOCUMENT_LINKS(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_LINKS))
  41 #define EV_IS_DOCUMENT_LINKS_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_LINKS))
  42 #define EV_DOCUMENT_LINKS_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_LINKS, EvDocumentLinksIface))
  43
  44 typedef struct _EvDocumentLinks      EvDocumentLinks;
  45 typedef struct _EvDocumentLinksIface EvDocumentLinksIface;
  46 typedef struct _EvDocumentLinksIter  EvDocumentLinksIter;
  47
  48 struct _EvDocumentLinksIface
  49 {
  50         GTypeInterface base_iface;
  51
  52         /* Methods  */
  53         gboolean             (* has_document_links) (EvDocumentLinks      *document_links);
  54         EvDocumentLinksIter *(* begin_read)         (EvDocumentLinks      *document_links);
  55         EvLink              *(* get_link)           (EvDocumentLinks      *document_links,
  56                                                      EvDocumentLinksIter  *iter);
  57         EvDocumentLinksIter *(* get_child)          (EvDocumentLinks      *document_links,
  58                                                      EvDocumentLinksIter  *iter);
  59         gboolean             (* next)               (EvDocumentLinks      *document_links,
  60                                                      EvDocumentLinksIter  *iter);
  61         void                 (* free_iter)          (EvDocumentLinks      *document_links,
  62                                                      EvDocumentLinksIter  *iter);
  63 };
  64
  65 GType                    ev_document_links_get_type           (void);
  66 gboolean                 ev_document_links_has_document_links (EvDocumentLinks      *document_links);
  67 EvDocumentLinksIter     *ev_document_links_begin_read         (EvDocumentLinks      *document_links);
  68 EvLink                  *ev_document_links_get_link           (EvDocumentLinks      *document_links,
  69                                                                EvDocumentLinksIter  *iter);
  70 EvDocumentLinksIter     *ev_document_links_get_child          (EvDocumentLinks      *document_links,
  71                                                                EvDocumentLinksIter  *iter);
  72 gboolean                 ev_document_links_next               (EvDocumentLinks      *document_links,
  73                                                                EvDocumentLinksIter  *iter);
  74 void                     ev_document_links_free_iter          (EvDocumentLinks      *document_links,
  75                                                                EvDocumentLinksIter  *iter);
  76
  77
  78 G_END_DECLS
  79
  80 #endif