new interface to indicate document supports bookmarks.

Wed Dec 22 14:47:38 2004  Jonathan Blandford  <jrb@redhat.com>

        * backend/ev-document-bookmarks.[ch]: new interface to indicate
        document supports bookmarks.

diff --git a/ChangeLog b/ChangeLog
index 8585d5e0e999d188744b6b65388e275ded52143f..7b965ef82051b88f3eab6407116131329c5bc4b5 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Wed Dec 22 14:47:38 2004  Jonathan Blandford  <jrb@redhat.com>
+
+       * backend/ev-document-bookmarks.[ch]: new interface to indicate
+       document supports bookmarks.
+
 2004-12-22  Marco Pesenti Gritti  <marco@gnome.org>
 
        * ps/ggvutils.c: (ggv_file_readable):

diff --git a/backend/Makefile.am b/backend/Makefile.am
index c163aa0440b540938bcf87909e0dc9c7aacfed31..445029795ec959d2b8d3264e13672c8fb7a565d1 100644 (file)
--- a/backend/Makefile.am
+++ b/backend/Makefile.am
@@ -13,6 +13,8 @@ libevbackend_la_SOURCES=                      \
        ev-backend-marshal.c                    \
        ev-document.c                           \
        ev-document.h                           \
+       ev-document-bookmarks.c                 \
+       ev-document-bookmarks.h                 \
        $(NULL)
 
 ev-backend-marshalers.h: ev-backend-marshalers.list

diff --git a/backend/ev-document-bookmarks.c b/backend/ev-document-bookmarks.c
new file mode 100644 (file)
index 0000000..a98b1e6
--- /dev/null
+++ b/backend/ev-document-bookmarks.c
@@ -0,0 +1,104 @@
+/* ev-document-bookmarks.h
+ *  this file is part of evince, a gnome document_bookmarks viewer
+ * 
+ * Copyright (C) 2004 Red Hat, Inc.
+ *
+ * Author:
+ *   Jonathan Blandford <jrb@alum.mit.edu>
+ *
+ * Evince is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Evince is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+#include "config.h"
+
+#include "ev-document-bookmarks.h"
+
+GType
+ev_document_bookmarks_get_type (void)
+{
+       static GType type = 0;
+
+       if (G_UNLIKELY (type == 0))
+       {
+               static const GTypeInfo our_info =
+               {
+                       sizeof (EvDocumentBookmarksIface),
+                       NULL,
+                       NULL,
+               };
+
+               type = g_type_register_static (G_TYPE_INTERFACE,
+                                              "EvDocumentBookmarks",
+                                              &our_info, (GTypeFlags)0);
+       }
+
+       return type;
+}
+
+gboolean
+ev_document_bookmarks_has_document_bookmarks (EvDocumentBookmarks *document_bookmarks)
+{
+       EvDocumentBookmarksIface *iface = EV_DOCUMENT_BOOKMARKS_GET_IFACE (document_bookmarks);
+       return iface->has_document_bookmarks (document_bookmarks);
+}
+
+EvDocumentBookmarksIter *
+ev_document_bookmarks_begin_read (EvDocumentBookmarks *document_bookmarks)
+{
+       EvDocumentBookmarksIface *iface = EV_DOCUMENT_BOOKMARKS_GET_IFACE (document_bookmarks);
+
+       return iface->begin_read (document_bookmarks);
+}
+
+gboolean 
+ev_document_bookmarks_get_values (EvDocumentBookmarks      *document_bookmarks,
+                                 EvDocumentBookmarksIter  *iter,
+                                 char                    **title,
+                                 EvDocumentBookmarksType  *type,
+                                 gint                     *page)
+{
+       EvDocumentBookmarksIface *iface = EV_DOCUMENT_BOOKMARKS_GET_IFACE (document_bookmarks);
+
+       return iface->get_values (document_bookmarks, iter, title, type, page);
+}
+
+EvDocumentBookmarksIter *
+ev_document_bookmarks_has_child (EvDocumentBookmarks     *document_bookmarks,
+                                EvDocumentBookmarksIter *iter)
+{
+       EvDocumentBookmarksIface *iface = EV_DOCUMENT_BOOKMARKS_GET_IFACE (document_bookmarks);
+
+       return iface->has_child (document_bookmarks, iter);
+}
+
+
+gboolean 
+ev_document_bookmarks_next (EvDocumentBookmarks     *document_bookmarks,
+                           EvDocumentBookmarksIter *iter)
+{
+       EvDocumentBookmarksIface *iface = EV_DOCUMENT_BOOKMARKS_GET_IFACE (document_bookmarks);
+
+       return iface->next (document_bookmarks, iter);
+}
+
+
+void
+ev_document_bookmarks_free_iter (EvDocumentBookmarks     *document_bookmarks,
+                                EvDocumentBookmarksIter *iter)
+{
+       EvDocumentBookmarksIface *iface = EV_DOCUMENT_BOOKMARKS_GET_IFACE (document_bookmarks);
+
+       iface->free_iter (document_bookmarks, iter);
+}

diff --git a/backend/ev-document-bookmarks.h b/backend/ev-document-bookmarks.h
new file mode 100644 (file)
index 0000000..430e2f6
--- /dev/null
+++ b/backend/ev-document-bookmarks.h
@@ -0,0 +1,96 @@
+/* ev-document-bookmarks.h
+ *  this file is part of evince, a gnome document_bookmarks viewer
+ * 
+ * Copyright (C) 2004 Red Hat, Inc.
+ *
+ * Author:
+ *   Jonathan Blandford <jrb@alum.mit.edu>
+ *
+ * Evince is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Evince is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+/* Acrobat insists on calling the TOC a bookmark, b/c they allow people to add
+ * their own..  We will continue this convention despite it being an obviously
+ * bad name.
+ */
+
+#ifndef EV_DOCUMENT_BOOKMARKS_H
+#define EV_DOCUMENT_BOOKMARKS_H
+
+#include <glib-object.h>
+#include <glib.h>
+#include <gdk/gdk.h>
+#include "ev-document.h"
+
+G_BEGIN_DECLS
+
+
+#define EV_TYPE_DOCUMENT_BOOKMARKS           (ev_document_bookmarks_get_type ())
+#define EV_DOCUMENT_BOOKMARKS(o)             (G_TYPE_CHECK_INSTANCE_CAST ((o), EV_TYPE_DOCUMENT_BOOKMARKS, EvDocumentBookmarks))
+#define EV_DOCUMENT_BOOKMARKS_IFACE(k)       (G_TYPE_CHECK_CLASS_CAST((k), EV_TYPE_DOCUMENT_BOOKMARKS, EvDocumentBookmarksIface))
+#define EV_IS_DOCUMENT_BOOKMARKS(o)          (G_TYPE_CHECK_INSTANCE_TYPE ((o), EV_TYPE_DOCUMENT_BOOKMARKS))
+#define EV_IS_DOCUMENT_BOOKMARKS_IFACE(k)     (G_TYPE_CHECK_CLASS_TYPE ((k), EV_TYPE_DOCUMENT_BOOKMARKS))
+#define EV_DOCUMENT_BOOKMARKS_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), EV_TYPE_DOCUMENT_BOOKMARKS, EvDocumentBookmarksIface))
+
+typedef struct _EvDocumentBookmarks            EvDocumentBookmarks;
+typedef struct _EvDocumentBookmarksIface       EvDocumentBookmarksIface;
+typedef struct _EvDocumentBookmarksIter        EvDocumentBookmarksIter;
+
+typedef enum
+{
+       EV_DOCUMENT_BOOKMARKS_TYPE_TITLE,
+       EV_DOCUMENT_BOOKMARKS_TYPE_LINK,
+       EV_DOCUMENT_BOOKMARKS_TYPE_EXTERNAL_URI,
+} EvDocumentBookmarksType;
+
+struct _EvDocumentBookmarksIface
+{
+       GTypeInterface base_iface;
+
+       /* Methods  */
+       gboolean                 (* has_document_bookmarks) (EvDocumentBookmarks      *document_bookmarks);
+       EvDocumentBookmarksIter *(* begin_read)             (EvDocumentBookmarks      *document_bookmarks);
+       gboolean                 (* get_values)             (EvDocumentBookmarks      *document_bookmarks,
+                                                            EvDocumentBookmarksIter  *iter,
+                                                            gchar                   **title,
+                                                            EvDocumentBookmarksType  *type,
+                                                            gint                     *page);
+       EvDocumentBookmarksIter *(* has_child)              (EvDocumentBookmarks      *document_bookmarks,
+                                                            EvDocumentBookmarksIter  *iter);
+       gboolean                 (* next)                   (EvDocumentBookmarks      *document_bookmarks,
+                                                            EvDocumentBookmarksIter  *iter);
+       void                     (* free_iter)              (EvDocumentBookmarks      *document_bookmarks,
+                                                            EvDocumentBookmarksIter  *iter);
+};
+
+GType                    ev_document_bookmarks_get_type               (void);
+gboolean                 ev_document_bookmarks_has_document_bookmarks (EvDocumentBookmarks      *document_bookmarks);
+EvDocumentBookmarksIter *ev_document_bookmarks_begin_read             (EvDocumentBookmarks      *document_bookmarks);
+gboolean                 ev_document_bookmarks_get_values             (EvDocumentBookmarks      *document_bookmarks,
+                                                                      EvDocumentBookmarksIter  *iter,
+                                                                      char                    **title,
+                                                                      EvDocumentBookmarksType  *type,
+                                                                      gint                     *page);
+EvDocumentBookmarksIter *ev_document_bookmarks_has_child              (EvDocumentBookmarks      *document_bookmarks,
+                                                                      EvDocumentBookmarksIter  *iter);
+gboolean                 ev_document_bookmarks_next                   (EvDocumentBookmarks      *document_bookmarks,
+                                                                      EvDocumentBookmarksIter  *iter);
+void                     ev_document_bookmarks_free_iter              (EvDocumentBookmarks      *document_bookmarks,
+                                                                      EvDocumentBookmarksIter  *iter);
+
+
+G_END_DECLS
+
+#endif