Evince
Evince is a document viewer capable of displaying multiple and single page document formats like PDF and Postscript.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ev-document-links.h
Go to the documentation of this file.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  */
23 
24 #if !defined (__EV_EVINCE_DOCUMENT_H_INSIDE__) && !defined (EVINCE_COMPILATION)
25 #error "Only <evince-document.h> can be included directly."
26 #endif
27 
28 #ifndef EV_DOCUMENT_LINKS_H
29 #define EV_DOCUMENT_LINKS_H
30 
31 #include <glib-object.h>
32 #include <glib.h>
33 #include <gtk/gtk.h>
34 
35 #include "ev-document.h"
36 #include "ev-link.h"
37 #include "ev-mapping-list.h"
38 
39 G_BEGIN_DECLS
40 
41 #define EV_TYPE_DOCUMENT_LINKS (ev_document_links_get_type ())
42 #define EV_DOCUMENT_LINKS(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_LINKS, EvDocumentLinks))
43 #define EV_DOCUMENT_LINKS_IFACE(k) (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_LINKS, EvDocumentLinksInterface))
44 #define EV_IS_DOCUMENT_LINKS(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_LINKS))
45 #define EV_IS_DOCUMENT_LINKS_IFACE(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_LINKS))
46 #define EV_DOCUMENT_LINKS_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_LINKS, EvDocumentLinksInterface))
47 
48 typedef struct _EvDocumentLinks EvDocumentLinks;
49 typedef struct _EvDocumentLinksInterface EvDocumentLinksInterface;
50 
51 enum {
52  EV_DOCUMENT_LINKS_COLUMN_MARKUP,
53  EV_DOCUMENT_LINKS_COLUMN_LINK,
54  EV_DOCUMENT_LINKS_COLUMN_EXPAND,
55  EV_DOCUMENT_LINKS_COLUMN_PAGE_LABEL,
56  EV_DOCUMENT_LINKS_COLUMN_NUM_COLUMNS
57 };
58 
59 struct _EvDocumentLinksInterface
60 {
61  GTypeInterface base_iface;
62 
63  /* Methods */
64  gboolean (* has_document_links) (EvDocumentLinks *document_links);
65  GtkTreeModel *(* get_links_model) (EvDocumentLinks *document_links);
66  EvMappingList *(* get_links) (EvDocumentLinks *document_links,
67  EvPage *page);
68  EvLinkDest *(* find_link_dest) (EvDocumentLinks *document_links,
69  const gchar *link_name);
70  gint (* find_link_page) (EvDocumentLinks *document_links,
71  const gchar *link_name);
72 };
73 
74 GType ev_document_links_get_type (void) G_GNUC_CONST;
75 gboolean ev_document_links_has_document_links (EvDocumentLinks *document_links);
76 GtkTreeModel *ev_document_links_get_links_model (EvDocumentLinks *document_links);
77 
78 EvMappingList *ev_document_links_get_links (EvDocumentLinks *document_links,
79  EvPage *page);
80 EvLinkDest *ev_document_links_find_link_dest (EvDocumentLinks *document_links,
81  const gchar *link_name);
82 gint ev_document_links_find_link_page (EvDocumentLinks *document_links,
83  const gchar *link_name);
84 gint ev_document_links_get_dest_page (EvDocumentLinks *document_links,
85  EvLinkDest *dest);
86 gchar *ev_document_links_get_dest_page_label (EvDocumentLinks *document_links,
87  EvLinkDest *dest);
88 gint ev_document_links_get_link_page (EvDocumentLinks *document_links,
89  EvLink *link);
90 gchar *ev_document_links_get_link_page_label (EvDocumentLinks *document_links,
91  EvLink *link);
92 
93 G_END_DECLS
94 
95 #endif