1 /* ev-document-bookmarks.h
2 * this file is part of evince, a gnome document_bookmarks viewer
4 * Copyright (C) 2004 Red Hat, Inc.
7 * Jonathan Blandford <jrb@alum.mit.edu>
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.
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.
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.
24 /* Acrobat insists on calling the TOC a bookmark, b/c they allow people to add
25 * their own.. We will continue this convention despite it being an obviously
29 #ifndef EV_DOCUMENT_BOOKMARKS_H
30 #define EV_DOCUMENT_BOOKMARKS_H
32 #include <glib-object.h>
35 #include "ev-document.h"
40 #define EV_TYPE_DOCUMENT_BOOKMARKS (ev_document_bookmarks_get_type ())
41 #define EV_DOCUMENT_BOOKMARKS(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_BOOKMARKS, EvDocumentBookmarks))
42 #define EV_DOCUMENT_BOOKMARKS_IFACE(k) (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_BOOKMARKS, EvDocumentBookmarksIface))
43 #define EV_IS_DOCUMENT_BOOKMARKS(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_BOOKMARKS))
44 #define EV_IS_DOCUMENT_BOOKMARKS_IFACE(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_BOOKMARKS))
45 #define EV_DOCUMENT_BOOKMARKS_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_BOOKMARKS, EvDocumentBookmarksIface))
47 typedef struct _EvDocumentBookmarks EvDocumentBookmarks;
48 typedef struct _EvDocumentBookmarksIface EvDocumentBookmarksIface;
49 typedef struct _EvDocumentBookmarksIter EvDocumentBookmarksIter;
53 EV_DOCUMENT_BOOKMARKS_TYPE_TITLE,
54 EV_DOCUMENT_BOOKMARKS_TYPE_LINK,
55 EV_DOCUMENT_BOOKMARKS_TYPE_EXTERNAL_URI,
56 } EvDocumentBookmarksType;
58 struct _EvDocumentBookmarksIface
60 GTypeInterface base_iface;
63 gboolean (* has_document_bookmarks) (EvDocumentBookmarks *document_bookmarks);
64 EvDocumentBookmarksIter *(* begin_read) (EvDocumentBookmarks *document_bookmarks);
65 gboolean (* get_values) (EvDocumentBookmarks *document_bookmarks,
66 EvDocumentBookmarksIter *iter,
68 EvDocumentBookmarksType *type,
70 EvDocumentBookmarksIter *(* get_child) (EvDocumentBookmarks *document_bookmarks,
71 EvDocumentBookmarksIter *iter);
72 gboolean (* next) (EvDocumentBookmarks *document_bookmarks,
73 EvDocumentBookmarksIter *iter);
74 void (* free_iter) (EvDocumentBookmarks *document_bookmarks,
75 EvDocumentBookmarksIter *iter);
78 GType ev_document_bookmarks_get_type (void);
79 gboolean ev_document_bookmarks_has_document_bookmarks (EvDocumentBookmarks *document_bookmarks);
80 EvDocumentBookmarksIter *ev_document_bookmarks_begin_read (EvDocumentBookmarks *document_bookmarks);
81 gboolean ev_document_bookmarks_get_values (EvDocumentBookmarks *document_bookmarks,
82 EvDocumentBookmarksIter *iter,
84 EvDocumentBookmarksType *type,
86 EvDocumentBookmarksIter *ev_document_bookmarks_get_child (EvDocumentBookmarks *document_bookmarks,
87 EvDocumentBookmarksIter *iter);
88 gboolean ev_document_bookmarks_next (EvDocumentBookmarks *document_bookmarks,
89 EvDocumentBookmarksIter *iter);
90 void ev_document_bookmarks_free_iter (EvDocumentBookmarks *document_bookmarks,
91 EvDocumentBookmarksIter *iter);