[evince] [docs] Modernise API docs
- From: Christian Persch <chpe src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [evince] [docs] Modernise API docs
- Date: Thu, 4 Feb 2010 19:06:03 +0000 (UTC)
commit 0ce9b3563b591c5fe980bcf47108a3f1b6dc6a85
Author: Christian Persch <chpe gnome org>
Date: Thu Feb 4 16:14:56 2010 +0100
[docs] Modernise API docs
Use no-tmpl gtk-doc option.
Use xi:include, add index and object hierarchy, etc.
autogen.sh | 5 +-
configure.ac | 22 +-
help/reference/libdocument/Makefile.am | 84 ++-
help/reference/libdocument/libevdocument-docs.sgml | 102 ---
help/reference/libdocument/libevdocument-docs.xml | 191 +++++
.../libdocument/libevdocument-sections.txt | 781 ++++++++++++++++++++
help/reference/libdocument/libevdocument.types | 53 +-
help/reference/libview/Makefile.am | 105 ++-
help/reference/libview/libevview-docs.sgml | 30 -
help/reference/libview/libevview-docs.xml | 145 ++++
help/reference/libview/libevview-sections.txt | 338 +++++++++
help/reference/libview/libevview.types | 30 +-
help/reference/shell/Makefile.am | 111 ++--
help/reference/shell/evince-docs.sgml | 57 --
help/reference/shell/evince-docs.xml | 163 ++++
help/reference/shell/evince-sections.txt | 472 ++++++++++++
help/reference/shell/evince.types | 27 +-
libdocument/ev-version.h.in | 38 +
18 files changed, 2407 insertions(+), 347 deletions(-)
---
diff --git a/autogen.sh b/autogen.sh
index 3fe8f4c..2996927 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -17,4 +17,7 @@ which gnome-autogen.sh || {
exit 1
}
-REQUIRED_AUTOMAKE_VERSION=1.9 USE_GNOME2_MACROS=1 . gnome-autogen.sh
+REQUIRED_AUTOMAKE_VERSION=1.10
+REQUIRED_GTK_DOC_VERSION=1.13
+USE_GNOME2_MACROS=1
+. gnome-autogen.sh
diff --git a/configure.ac b/configure.ac
index f95532a..5f62335 100644
--- a/configure.ac
+++ b/configure.ac
@@ -41,7 +41,7 @@ m4_define([ev_binary_version],[ev_document_lt_current])
AC_PREREQ([2.57])
AC_INIT([Evince],[ev_version],[http://bugzilla.gnome.org/enter_bug.cgi?product=evince],[evince])
-AM_INIT_AUTOMAKE([1.9 foreign dist-bzip2 no-dist-gzip])
+AM_INIT_AUTOMAKE([1.10 foreign dist-bzip2 no-dist-gzip])
AC_CONFIG_HEADERS([config.h])
AC_CONFIG_MACRO_DIR([m4])
@@ -66,14 +66,11 @@ AC_PROG_SED
AC_PATH_PROG([GLIB_GENMARSHAL], [glib-genmarshal])
AC_PATH_PROG([GLIB_MKENUMS],[glib-mkenums])
-GNOME_COMMON_INIT
GNOME_DOC_INIT
GNOME_MAINTAINER_MODE_DEFINES
GNOME_COMPILE_WARNINGS
GNOME_CXX_WARNINGS
-GTK_DOC_CHECK(1.0)
-
IT_PROG_INTLTOOL([0.35.0])
GETTEXT_PACKAGE=evince
@@ -261,9 +258,6 @@ if test "$with_keyring" = "yes"; then
AC_DEFINE([WITH_KEYRING],[1],[Define if KEYRING support is enabled])
fi
-GLIB_GENMARSHAL=`$PKG_CONFIG --variable=glib_genmarshal glib-2.0`
-AC_SUBST(GLIB_GENMARSHAL)
-
# ****
# DBUS
# ****
@@ -713,12 +707,25 @@ AC_SUBST(EVINCE_MIME_TYPES)
AC_CHECK_FUNC(localtime_r, AC_DEFINE(HAVE_LOCALTIME_R, 1, [Defines if localtime_r is available on your system]))
+# *****************
+# API documentation
+# *****************
+
+GTK_DOC_CHECK([1.13],[--flavour no-tmpl])
+
+AC_SUBST([GLIB_PREFIX],[$($PKG_CONFIG --variable=prefix glib-2.0)])
+AC_SUBST([GTK_PREFIX],[$($PKG_CONFIG --variable=prefix gtk+-2.0)])
+
+# ******************
# Backends directory
+# ******************
AC_SUBST([backenddir],"\$(libdir)/evince/ev_binary_version/backends")
AC_SUBST([backend_binary_version],"ev_binary_version")
+# **********
# Versioning
+# **********
AC_SUBST([EV_MAJOR_VERSION],[ev_major_version])
AC_SUBST([EV_MINOR_VERSION],[ev_minor_version])
@@ -733,6 +740,7 @@ AC_SUBST([EV_VIEW_LT_VERSION_INFO],[ev_view_lt_version_info])
AC_SUBST([EV_VIEW_LT_CURRENT_MINUS_AGE],[ev_view_lt_current_minus_age])
# *****************************************************************************
+# *****************************************************************************
AC_CONFIG_FILES([
backend/Makefile
diff --git a/help/reference/libdocument/Makefile.am b/help/reference/libdocument/Makefile.am
index ad4bc35..03dcf52 100644
--- a/help/reference/libdocument/Makefile.am
+++ b/help/reference/libdocument/Makefile.am
@@ -1,7 +1,5 @@
-## Process this file with automake to produce Makefile.in
-
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
+# We require automake 1.10 for $(abs_builddir)
+AUTOMAKE_OPTIONS = 1.10
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
@@ -9,71 +7,91 @@ AUTOMAKE_OPTIONS = 1.6
# of using the various options.
# The name of the module, e.g. 'glib'.
-DOC_MODULE=libevdocument
+DOC_MODULE = libevdocument
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+DOC_MODULE_VERSION = $(EV_API_VERSION)
+
# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=../../../libdocument
+DOC_SOURCE_DIR = ../../../libdocument
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
+SCANGOBJ_OPTIONS =
# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS =
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS = --sgml-mode --output-format=xml --name-space=ev
# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
+MKTMPL_OPTIONS =
+# Extra options to supply to gtkdoc-mkhtml
# Add the builddir to the HTML path so that version.xml is found
-MKHTML_OPTIONS=--path="$(abs_builddir)"
+MKHTML_OPTIONS = --path="$(abs_builddir)"
# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
+FIXXREF_OPTIONS = \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio \
+ --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk \
+ --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk-pixbuf \
+ --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gtk
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/libdocument/*.h
-CFILE_GLOB=$(top_srcdir)/libdocument/*.c
+HFILE_GLOB = \
+ $(top_srcdir)/libdocument/*.h \
+ $(top_builddir)/libdocument/*.h
+
+CFILE_GLOB = \
+ $(top_srcdir)/libdocument/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+# EXTRA_HFILES = $(top_builddir)/evdocument/ev-version.h
+EXTRA_HFILES =
-# Header files to ignore when scanning.
+# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES= \
- ev-debug.h \
+IGNORE_HFILES = \
+ config.h \
+ ev-debug.h \
ev-module.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
+HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files= \
- version.xml
+content_files = \
+ version.xml
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
-expand_content_files=
+expand_content_files =
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
-# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-INCLUDES= \
+GTKDOC_CFLAGS = \
-I$(top_srcdir) \
-I$(top_builddir) \
-I$(top_srcdir)/libdocument \
@@ -88,7 +106,7 @@ INCLUDES= \
$(WARN_CFLAGS) \
$(DISABLE_DEPRECATED)
-GTKDOC_LIBS= \
+GTKDOC_LIBS = \
$(top_builddir)/libdocument/libevdocument.la \
$(LIBDOCUMENT_LIBS)
@@ -97,6 +115,18 @@ include $(top_srcdir)/gtk-doc.make
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST += version.xml.in
+EXTRA_DIST += \
+ version.xml.in
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want your docs-status tested during 'make check'
+if ENABLE_GTK_DOC
+#TESTS_ENVIRONMENT = cd $(srcsrc) &&
+#TESTS = $(GTKDOC_CHECK)
+endif
-include $(top_srcdir)/git.mk
diff --git a/help/reference/libdocument/libevdocument-docs.xml b/help/reference/libdocument/libevdocument-docs.xml
new file mode 100644
index 0000000..9176bb2
--- /dev/null
+++ b/help/reference/libdocument/libevdocument-docs.xml
@@ -0,0 +1,191 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+ <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="evince-document">
+ <!--
+ Copyright © 2009, 2010 Christian Persch
+
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU General Public License, Version 2
+ as published by the Free Software Foundation; or (at your option) any
+ later version.
+
+ A copy of the license is included in the COPYING file.
+ -->
+ <bookinfo>
+ <title>Evince Document Library Reference Manual</title>
+ <releaseinfo>
+ For Evince version &version;.
+ The latest version of this documentation can be found on-line at the
+ <ulink role="online-location" url="http://library.gnome.org/devel/libevdocument/index.html";>GNOME Library</ulink>.
+ </releaseinfo>
+
+ <copyright>
+ <year>2007</year>
+ <year>2008</year>
+ <year>2009</year>
+ <holder>Nickolay V. Shmyrev</holder>
+ </copyright>
+
+ <copyright>
+ <year>2008</year>
+ <year>2009</year>
+ <year>2010</year>
+ <holder>Carlos Garcia Campo</holder>
+ </copyright>
+
+ <copyright>
+ <year>2009</year>
+ <year>2010</year>
+ <holder>Christian Persch</holder>
+ </copyright>
+
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the <citetitle>GNU General Public Licence</citetitle>
+ published by the Free Software Foundation; either version 2 of the License,
+ or (at your option) any later version.
+
+ You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
+ from the Free Software Foundation at
+ <ulink type="http" url="http://www.gnu.org/licences/";>GNU Licences web site</ulink>
+ or by writing to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>51 Franklin St</street> â?? Fifth Floor,
+ <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+ </legalnotice>
+ </bookinfo>
+
+ <part id="document-interfaces">
+ <title>Document Interfaces</title>
+ <partintro>
+ <para>
+ Provides support for writing Evince backends.
+ </para>
+ </partintro>
+
+ <xi:include href="xml/ev-async-renderer.xml"/>
+ <xi:include href="xml/ev-document.xml"/>
+ <xi:include href="xml/ev-document-annotations.xml"/>
+ <xi:include href="xml/ev-document-attachments.xml"/>
+ <xi:include href="xml/ev-document-find.xml"/>
+ <xi:include href="xml/ev-document-fonts.xml"/>
+ <xi:include href="xml/ev-document-forms.xml"/>
+ <xi:include href="xml/ev-document-images.xml"/>
+ <xi:include href="xml/ev-document-info.xml"/>
+ <xi:include href="xml/ev-document-layers.xml"/>
+ <xi:include href="xml/ev-document-links.xml"/>
+ <xi:include href="xml/ev-document-misc.xml"/>
+ <xi:include href="xml/ev-document-print.xml"/>
+ <xi:include href="xml/ev-document-security.xml"/>
+ <xi:include href="xml/ev-document-thumbnails.xml"/>
+ <xi:include href="xml/ev-document-transition.xml"/>
+ <xi:include href="xml/ev-selection.xml"/>
+ <xi:include href="xml/ev-file-exporter.xml"/>
+ </part>
+
+ <part id="document-data">
+ <title>Document Data</title>
+ <partintro>
+ <para>
+ Helper objects related to documents like attachments, links and
+ images, etc.
+ </para>
+ </partintro>
+
+ <xi:include href="xml/ev-annotation.xml"/>
+ <xi:include href="xml/ev-attachment.xml"/>
+ <xi:include href="xml/ev-form-field.xml"/>
+ <xi:include href="xml/ev-image.xml"/>
+ <xi:include href="xml/ev-layer.xml"/>
+ <xi:include href="xml/ev-link-action.xml"/>
+ <xi:include href="xml/ev-link-dest.xml"/>
+ <xi:include href="xml/ev-link.xml"/>
+ <xi:include href="xml/ev-mapping.xml"/>
+ <xi:include href="xml/ev-page.xml"/>
+ <xi:include href="xml/ev-render-context.xml"/>
+ <xi:include href="xml/ev-transition-effect.xml"/>
+ </part>
+
+ <part id="document-helpers">
+ <title>Helper Functions</title>
+ <partintro>
+ <para>
+ Helper functions common for backend implementations, and for libevdocument library users.
+ </para>
+ </partintro>
+
+ <xi:include href="xml/ev-init.xml"/>
+ <xi:include href="xml/ev-version.xml"/>
+ <xi:include href="xml/ev-file-helpers.xml"/>
+ <xi:include href="xml/ev-document-factory.xml"/>
+ <xi:include href="xml/ev-backends-manager.xml"/>
+ </part>
+
+ <chapter id="object-tree">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <!--
+ <index id="api-index-deprecated" role="deprecated">
+ <title>Index of deprecated symbols</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+ -->
+ <!--
+ <index id="api-index-2-30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
+ </index>
+ -->
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+
+ <appendix id="licence">
+ <title>Licence</title>
+
+ <para>
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the <citetitle>GNU General Public
+ Licence</citetitle> as published by the Free Software Foundation; either
+ version 2 of the Licence, or (at your option) any later version.
+ </para>
+
+ <para>
+ This library 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
+ <citetitle>GNU General Public Licence</citetitle> for
+ more details.
+ </para>
+
+ <para>
+ You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
+ from the Free Software Foundation at
+ <ulink type="http" url="http://www.gnu.org/licences/";>GNU Licences web site</ulink>
+ or by writing to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>51 Franklin St</street> â?? Fifth Floor,
+ <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+ </appendix>
+
+</book>
diff --git a/help/reference/libdocument/libevdocument-sections.txt b/help/reference/libdocument/libevdocument-sections.txt
new file mode 100644
index 0000000..88d3db2
--- /dev/null
+++ b/help/reference/libdocument/libevdocument-sections.txt
@@ -0,0 +1,781 @@
+<SECTION>
+<FILE>ev-layer</FILE>
+<TITLE>EvLayer</TITLE>
+EvLayer
+EvLayerClass
+EvLayerPrivate
+ev_layer_new
+ev_layer_get_id
+ev_layer_is_parent
+ev_layer_get_rb_group
+<SUBSECTION Standard>
+EV_LAYER
+EV_IS_LAYER
+EV_TYPE_LAYER
+ev_layer_get_type
+EV_LAYER_CLASS
+EV_IS_LAYER_CLASS
+EV_LAYER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-thumbnails</FILE>
+<TITLE>EvDocumentThumbnails</TITLE>
+EV_DOCUMENT_THUMBNAILS_IFACE
+EV_IS_DOCUMENT_THUMBNAILS_IFACE
+EvDocumentThumbnails
+EvDocumentThumbnailsIface
+ev_document_thumbnails_get_thumbnail
+ev_document_thumbnails_get_dimensions
+<SUBSECTION Standard>
+EV_DOCUMENT_THUMBNAILS
+EV_IS_DOCUMENT_THUMBNAILS
+EV_TYPE_DOCUMENT_THUMBNAILS
+ev_document_thumbnails_get_type
+EV_DOCUMENT_THUMBNAILS_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-file-exporter</FILE>
+<TITLE>EvFileExporter</TITLE>
+EvFileExporterFormat
+EvFileExporterCapabilities
+EvFileExporterContext
+EV_FILE_EXPORTER_IFACE
+EV_IS_FILE_EXPORTER_IFACE
+EvFileExporter
+EvFileExporterIface
+ev_file_exporter_begin
+ev_file_exporter_begin_page
+ev_file_exporter_do_page
+ev_file_exporter_end_page
+ev_file_exporter_end
+ev_file_exporter_get_capabilities
+<SUBSECTION Standard>
+ev_file_exporter_format_get_type
+EV_TYPE_FILE_EXPORTER_FORMAT
+ev_file_exporter_capabilities_get_type
+EV_TYPE_FILE_EXPORTER_CAPABILITIES
+EV_FILE_EXPORTER
+EV_IS_FILE_EXPORTER
+EV_TYPE_FILE_EXPORTER
+ev_file_exporter_get_type
+EV_FILE_EXPORTER_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-forms</FILE>
+<TITLE>EvDocumentForms</TITLE>
+EV_DOCUMENT_FORMS_IFACE
+EV_IS_DOCUMENT_FORMS_IFACE
+EvDocumentForms
+EvDocumentFormsIface
+ev_document_forms_get_form_fields
+ev_document_forms_form_field_text_get_text
+ev_document_forms_form_field_text_set_text
+ev_document_forms_form_field_button_get_state
+ev_document_forms_form_field_button_set_state
+ev_document_forms_form_field_choice_get_item
+ev_document_forms_form_field_choice_get_n_items
+ev_document_forms_form_field_choice_is_item_selected
+ev_document_forms_form_field_choice_select_item
+ev_document_forms_form_field_choice_toggle_item
+ev_document_forms_form_field_choice_unselect_all
+ev_document_forms_form_field_choice_set_text
+ev_document_forms_form_field_choice_get_text
+<SUBSECTION Standard>
+ev_form_field_text_type_get_type
+EV_TYPE_FORM_FIELD_TEXT_TYPE
+ev_form_field_button_type_get_type
+EV_TYPE_FORM_FIELD_BUTTON_TYPE
+ev_form_field_choice_type_get_type
+EV_TYPE_FORM_FIELD_CHOICE_TYPE
+EV_DOCUMENT_FORMS
+EV_IS_DOCUMENT_FORMS
+EV_TYPE_DOCUMENT_FORMS
+ev_document_forms_get_type
+EV_DOCUMENT_FORMS_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-print</FILE>
+<TITLE>EvDocumentPrint</TITLE>
+EV_DOCUMENT_PRINT_IFACE
+EV_IS_DOCUMENT_PRINT_IFACE
+EvDocumentPrint
+EvDocumentPrintIface
+ev_document_print_print_page
+<SUBSECTION Standard>
+EV_DOCUMENT_PRINT
+EV_IS_DOCUMENT_PRINT
+EV_TYPE_DOCUMENT_PRINT
+ev_document_print_get_type
+EV_DOCUMENT_PRINT_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-image</FILE>
+<TITLE>EvImage</TITLE>
+EvImage
+EvImageClass
+EvImagePrivate
+ev_image_new
+ev_image_new_from_pixbuf
+ev_image_get_id
+ev_image_get_page
+ev_image_get_pixbuf
+ev_image_save_tmp
+ev_image_get_tmp_uri
+<SUBSECTION Standard>
+EV_IMAGE
+EV_IS_IMAGE
+EV_TYPE_IMAGE
+ev_image_get_type
+EV_IMAGE_CLASS
+EV_IS_IMAGE_CLASS
+EV_IMAGE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-link</FILE>
+EvLink
+EvLinkClass
+EvLinkPrivate
+ev_link_new
+ev_link_get_title
+ev_link_get_action
+ev_link_get_page
+<SUBSECTION Standard>
+ev_link_action_type_get_type
+EV_TYPE_LINK_ACTION_TYPE
+ev_link_dest_type_get_type
+EV_TYPE_LINK_DEST_TYPE
+EV_LINK
+EV_IS_LINK
+EV_TYPE_LINK
+ev_link_get_type
+EV_LINK_CLASS
+EV_IS_LINK_CLASS
+EV_LINK_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-layers</FILE>
+<TITLE>EvDocumentLayers</TITLE>
+EV_DOCUMENT_LAYERS_IFACE
+EV_IS_DOCUMENT_LAYERS_IFACE
+EvDocumentLayers
+EvDocumentLayersIface
+ev_document_layers_has_layers
+ev_document_layers_get_layers
+ev_document_layers_show_layer
+ev_document_layers_hide_layer
+ev_document_layers_layer_is_visible
+<SUBSECTION Standard>
+EV_DOCUMENT_LAYERS
+EV_IS_DOCUMENT_LAYERS
+EV_TYPE_DOCUMENT_LAYERS
+ev_document_layers_get_type
+EV_DOCUMENT_LAYERS_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-links</FILE>
+<TITLE>EvDocumentLinks</TITLE>
+EV_DOCUMENT_LINKS_IFACE
+EV_IS_DOCUMENT_LINKS_IFACE
+EvDocumentLinks
+EvDocumentLinksIface
+ev_document_links_has_document_links
+ev_document_links_get_links_model
+ev_document_links_get_links
+ev_document_links_find_link_dest
+ev_document_links_get_dest_page
+ev_document_links_get_dest_page_label
+<SUBSECTION Standard>
+EV_DOCUMENT_LINKS
+EV_IS_DOCUMENT_LINKS
+EV_TYPE_DOCUMENT_LINKS
+ev_document_links_get_type
+EV_DOCUMENT_LINKS_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-attachment</FILE>
+<TITLE>EvAttachment</TITLE>
+EvAttachment
+EvAttachmentClass
+EvAttachmentPrivate
+EV_ATTACHMENT_ERROR
+ev_attachment_error_quark
+ev_attachment_new
+ev_attachment_get_name
+ev_attachment_get_description
+ev_attachment_get_modification_date
+ev_attachment_get_creation_date
+ev_attachment_get_mime_type
+ev_attachment_save
+ev_attachment_open
+<SUBSECTION Standard>
+EV_ATTACHMENT
+EV_IS_ATTACHMENT
+EV_TYPE_ATTACHMENT
+ev_attachment_get_type
+EV_ATTACHMENT_CLASS
+EV_IS_ATTACHMENT_CLASS
+EV_ATTACHMENT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-page</FILE>
+<TITLE>EvPage</TITLE>
+EvPage
+EvPageClass
+EvBackendPage
+EvBackendPageDestroyFunc
+ev_page_new
+<SUBSECTION Standard>
+EV_PAGE
+EV_IS_PAGE
+EV_TYPE_PAGE
+ev_page_get_type
+EV_PAGE_CLASS
+EV_IS_PAGE_CLASS
+EV_PAGE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-render-context</FILE>
+<TITLE>EvRenderContext</TITLE>
+EvRenderContext
+EvRenderContextClass
+ev_render_context_new
+ev_render_context_set_page
+ev_render_context_set_rotation
+ev_render_context_set_scale
+<SUBSECTION Standard>
+EV_RENDER_CONTEXT
+EV_IS_RENDER_CONTEXT
+EV_TYPE_RENDER_CONTEXT
+ev_render_context_get_type
+EV_RENDER_CONTEXT_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-form-field</FILE>
+<TITLE>EvFormField</TITLE>
+EvFormField
+EvFormFieldClass
+EvFormFieldText
+EvFormFieldTextClass
+EvFormFieldButton
+EvFormFieldButtonClass
+EvFormFieldChoice
+EvFormFieldChoiceClass
+EvFormFieldSignature
+EvFormFieldSignatureClass
+EvFormFieldTextType
+EvFormFieldButtonType
+EvFormFieldChoiceType
+ev_form_field_text_new
+ev_form_field_button_new
+ev_form_field_choice_new
+ev_form_field_signature_new
+<SUBSECTION Standard>
+EV_FORM_FIELD
+EV_IS_FORM_FIELD
+EV_TYPE_FORM_FIELD
+ev_form_field_get_type
+EV_FORM_FIELD_CLASS
+EV_IS_FORM_FIELD_CLASS
+EV_FORM_FIELD_GET_CLASS
+EV_TYPE_FORM_FIELD_TEXT
+ev_form_field_text_get_type
+EV_FORM_FIELD_TEXT
+EV_FORM_FIELD_TEXT_CLASS
+EV_IS_FORM_FIELD_TEXT
+EV_IS_FORM_FIELD_TEXT_CLASS
+EV_FORM_FIELD_TEXT_GET_CLASS
+EV_TYPE_FORM_FIELD_BUTTON
+ev_form_field_button_get_type
+EV_FORM_FIELD_BUTTON
+EV_FORM_FIELD_BUTTON_CLASS
+EV_IS_FORM_FIELD_BUTTON
+EV_IS_FORM_FIELD_BUTTON_CLASS
+EV_FORM_FIELD_BUTTON_GET_CLASS
+EV_TYPE_FORM_FIELD_CHOICE
+ev_form_field_choice_get_type
+EV_FORM_FIELD_CHOICE
+EV_FORM_FIELD_CHOICE_CLASS
+EV_IS_FORM_FIELD_CHOICE
+EV_IS_FORM_FIELD_CHOICE_CLASS
+EV_FORM_FIELD_CHOICE_GET_CLASS
+EV_TYPE_FORM_FIELD_SIGNATURE
+ev_form_field_signature_get_type
+EV_FORM_FIELD_SIGNATURE
+EV_FORM_FIELD_SIGNATURE_CLASS
+EV_IS_FORM_FIELD_SIGNATURE
+EV_IS_FORM_FIELD_SIGNATURE_CLASS
+EV_FORM_FIELD_SIGNATURE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-find</FILE>
+<TITLE>EvDocumentFind</TITLE>
+EV_DOCUMENT_FIND_IFACE
+EV_IS_DOCUMENT_FIND_IFACE
+EvDocumentFind
+EvDocumentFindIface
+ev_document_find_find_text
+<SUBSECTION Standard>
+EV_DOCUMENT_FIND
+EV_IS_DOCUMENT_FIND
+EV_TYPE_DOCUMENT_FIND
+ev_document_find_get_type
+EV_DOCUMENT_FIND_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-document</FILE>
+<TITLE>EvDocument</TITLE>
+EvDocument
+EvDocumentClass
+EvDocumentPrivate
+EV_DOCUMENT_ERROR
+EV_DOC_MUTEX_LOCK
+EV_DOC_MUTEX_UNLOCK
+EvDocumentError
+EvPoint
+EvRectangle
+EvDocumentBackendInfo
+ev_document_error_quark
+ev_document_get_doc_mutex
+ev_document_doc_mutex_lock
+ev_document_doc_mutex_unlock
+ev_document_doc_mutex_trylock
+ev_document_get_fc_mutex
+ev_document_fc_mutex_lock
+ev_document_fc_mutex_unlock
+ev_document_fc_mutex_trylock
+ev_document_get_info
+ev_document_get_backend_info
+ev_document_load
+ev_document_save
+ev_document_get_n_pages
+ev_document_get_page
+ev_document_get_page_size
+ev_document_get_page_label
+ev_document_render
+ev_document_get_uri
+ev_document_get_title
+ev_document_is_page_size_uniform
+ev_document_get_max_page_size
+ev_document_check_dimensions
+ev_document_get_max_label_len
+ev_document_has_text_page_labels
+ev_document_find_page_by_label
+ev_rect_cmp
+EV_TYPE_RECTANGLE
+ev_rectangle_get_type
+ev_rectangle_new
+ev_rectangle_copy
+ev_rectangle_free
+EV_BACKEND_IMPLEMENT_INTERFACE
+EV_BACKEND_REGISTER_WITH_CODE
+EV_BACKEND_REGISTER
+EV_DEFINE_BOXED_TYPE
+EV_DEFINE_INTERFACE
+<SUBSECTION Standard>
+EV_DOCUMENT
+EV_IS_DOCUMENT
+EV_TYPE_DOCUMENT
+ev_document_get_type
+EV_DOCUMENT_CLASS
+EV_IS_DOCUMENT_CLASS
+EV_DOCUMENT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-link-dest</FILE>
+EvLinkDest
+EvLinkDestClass
+EvLinkDestPrivate
+EvLinkDestType
+ev_link_dest_get_dest_type
+ev_link_dest_get_page
+ev_link_dest_get_top
+ev_link_dest_get_left
+ev_link_dest_get_bottom
+ev_link_dest_get_right
+ev_link_dest_get_zoom
+ev_link_dest_get_named_dest
+ev_link_dest_get_page_label
+ev_link_dest_new_page
+ev_link_dest_new_xyz
+ev_link_dest_new_fit
+ev_link_dest_new_fith
+ev_link_dest_new_fitv
+ev_link_dest_new_fitr
+ev_link_dest_new_named
+ev_link_dest_new_page_label
+<SUBSECTION Standard>
+EV_LINK_DEST
+EV_IS_LINK_DEST
+EV_TYPE_LINK_DEST
+ev_link_dest_get_type
+EV_LINK_DEST_CLASS
+EV_IS_LINK_DEST_CLASS
+EV_LINK_DEST_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-link-action</FILE>
+EvLinkAction
+EvLinkActionClass
+EvLinkActionPrivate
+EvLinkActionType
+ev_link_action_get_action_type
+ev_link_action_get_dest
+ev_link_action_get_uri
+ev_link_action_get_filename
+ev_link_action_get_params
+ev_link_action_get_name
+ev_link_action_new_dest
+ev_link_action_new_remote
+ev_link_action_new_external_uri
+ev_link_action_new_launch
+ev_link_action_new_named
+<SUBSECTION Standard>
+EV_LINK_ACTION
+EV_IS_LINK_ACTION
+EV_TYPE_LINK_ACTION
+ev_link_action_get_type
+EV_LINK_ACTION_CLASS
+EV_IS_LINK_ACTION_CLASS
+EV_LINK_ACTION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-images</FILE>
+<TITLE>EvDocumentImages</TITLE>
+EV_DOCUMENT_IMAGES_IFACE
+EV_IS_DOCUMENT_IMAGES_IFACE
+EvDocumentImages
+EvDocumentImagesIface
+ev_document_images_get_image_mapping
+ev_document_images_get_image
+<SUBSECTION Standard>
+EV_DOCUMENT_IMAGES
+EV_IS_DOCUMENT_IMAGES
+EV_TYPE_DOCUMENT_IMAGES
+ev_document_images_get_type
+EV_DOCUMENT_IMAGES_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-async-renderer</FILE>
+<TITLE>EvAsyncRenderer</TITLE>
+EV_ASYNC_RENDERER_IFACE
+EV_IS_ASYNC_RENDERER_IFACE
+EvAsyncRenderer
+EvAsyncRendererIface
+ev_async_renderer_render_pixbuf
+<SUBSECTION Standard>
+EV_ASYNC_RENDERER
+EV_IS_ASYNC_RENDERER
+EV_TYPE_ASYNC_RENDERER
+ev_async_renderer_get_type
+EV_ASYNC_RENDERER_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-selection</FILE>
+<TITLE>EvSelection</TITLE>
+EV_SELECTION_IFACE
+EV_IS_SELECTION_IFACE
+EvSelectionStyle
+EvSelection
+EvSelectionIface
+ev_selection_render_selection
+ev_selection_get_selected_text
+ev_selection_get_selection_map
+ev_selection_get_selection_region
+<SUBSECTION Standard>
+ev_selection_style_get_type
+EV_TYPE_SELECTION_STYLE
+EV_SELECTION
+EV_IS_SELECTION
+EV_TYPE_SELECTION
+ev_selection_get_type
+EV_SELECTION_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-attachments</FILE>
+<TITLE>EvDocumentAttachments</TITLE>
+EV_DOCUMENT_ATTACHMENTS_IFACE
+EV_IS_DOCUMENT_ATTACHMENTS_IFACE
+EvDocumentAttachments
+EvDocumentAttachmentsIface
+ev_document_attachments_has_attachments
+ev_document_attachments_get_attachments
+<SUBSECTION Standard>
+EV_DOCUMENT_ATTACHMENTS
+EV_IS_DOCUMENT_ATTACHMENTS
+EV_TYPE_DOCUMENT_ATTACHMENTS
+ev_document_attachments_get_type
+EV_DOCUMENT_ATTACHMENTS_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-security</FILE>
+<TITLE>EvDocumentSecurity</TITLE>
+EV_DOCUMENT_SECURITY_IFACE
+EV_IS_DOCUMENT_SECURITY_IFACE
+EvDocumentSecurity
+EvDocumentSecurityIface
+ev_document_security_has_document_security
+ev_document_security_set_password
+<SUBSECTION Standard>
+EV_DOCUMENT_SECURITY
+EV_IS_DOCUMENT_SECURITY
+EV_TYPE_DOCUMENT_SECURITY
+ev_document_security_get_type
+EV_DOCUMENT_SECURITY_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-annotation</FILE>
+<TITLE>EvAnnotation</TITLE>
+EvAnnotation
+EvAnnotationClass
+EvAnnotationMarkup
+EvAnnotationMarkupIface
+EvAnnotationText
+EvAnnotationTextClass
+EvAnnotationAttachment
+EvAnnotationAttachmentClass
+ev_annotation_markup_get_label
+ev_annotation_markup_set_label
+ev_annotation_markup_get_opacity
+ev_annotation_markup_set_opacity
+ev_annotation_markup_has_popup
+ev_annotation_markup_get_rectangle
+ev_annotation_markup_get_is_open
+ev_annotation_markup_set_is_open
+ev_annotation_text_new
+ev_annotation_attachment_new
+<SUBSECTION Standard>
+EV_ANNOTATION
+EV_IS_ANNOTATION
+EV_TYPE_ANNOTATION
+ev_annotation_get_type
+EV_ANNOTATION_CLASS
+EV_IS_ANNOTATION_CLASS
+EV_ANNOTATION_GET_CLASS
+EV_TYPE_ANNOTATION_MARKUP
+ev_annotation_markup_get_type
+EV_ANNOTATION_MARKUP
+EV_ANNOTATION_MARKUP_IFACE
+EV_IS_ANNOTATION_MARKUP
+EV_IS_ANNOTATION_MARKUP_IFACE
+EV_ANNOTATION_MARKUP_GET_IFACE
+EV_TYPE_ANNOTATION_TEXT
+ev_annotation_text_get_type
+EV_ANNOTATION_TEXT
+EV_ANNOTATION_TEXT_CLASS
+EV_IS_ANNOTATION_TEXT
+EV_IS_ANNOTATION_TEXT_CLASS
+EV_ANNOTATION_TEXT_GET_CLASS
+EV_TYPE_ANNOTATION_ATTACHMENT
+ev_annotation_attachment_get_type
+EV_ANNOTATION_ATTACHMENT
+EV_ANNOTATION_ATTACHMENT_CLASS
+EV_IS_ANNOTATION_ATTACHMENT
+EV_IS_ANNOTATION_ATTACHMENT_CLASS
+EV_ANNOTATION_ATTACHMENT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-transition</FILE>
+<TITLE>EvDocumentTransition</TITLE>
+EV_DOCUMENT_TRANSITION_IFACE
+EV_IS_DOCUMENT_TRANSITION_IFACE
+EvDocumentTransition
+EvDocumentTransitionIface
+ev_document_transition_get_page_duration
+ev_document_transition_get_effect
+<SUBSECTION Standard>
+EV_DOCUMENT_TRANSITION
+EV_IS_DOCUMENT_TRANSITION
+EV_TYPE_DOCUMENT_TRANSITION
+ev_document_transition_get_type
+EV_DOCUMENT_TRANSITION_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-transition-effect</FILE>
+EvTransitionEffectType
+EvTransitionEffectAlignment
+EvTransitionEffectDirection
+EvTransitionEffect
+EvTransitionEffectClass
+ev_transition_effect_new
+<SUBSECTION Standard>
+ev_transition_effect_type_get_type
+EV_TYPE_TRANSITION_EFFECT_TYPE
+ev_transition_effect_alignment_get_type
+EV_TYPE_TRANSITION_EFFECT_ALIGNMENT
+ev_transition_effect_direction_get_type
+EV_TYPE_TRANSITION_EFFECT_DIRECTION
+EV_TRANSITION_EFFECT
+EV_IS_TRANSITION_EFFECT
+EV_TYPE_TRANSITION_EFFECT
+ev_transition_effect_get_type
+EV_TRANSITION_EFFECT_CLASS
+EV_IS_TRANSITION_EFFECT_CLASS
+EV_TRANSITION_EFFECT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-annotations</FILE>
+<TITLE>EvDocumentAnnotations</TITLE>
+EV_DOCUMENT_ANNOTATIONS_IFACE
+EV_IS_DOCUMENT_ANNOTATIONS_IFACE
+EvDocumentAnnotations
+EvDocumentAnnotationsIface
+ev_document_annotations_get_annotations
+ev_document_annotations_annotation_set_contents
+<SUBSECTION Standard>
+EV_DOCUMENT_ANNOTATIONS
+EV_IS_DOCUMENT_ANNOTATIONS
+EV_TYPE_DOCUMENT_ANNOTATIONS
+ev_document_annotations_get_type
+EV_DOCUMENT_ANNOTATIONS_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-fonts</FILE>
+<TITLE>EvDocumentFonts</TITLE>
+EV_DOCUMENT_FONTS_IFACE
+EV_IS_DOCUMENT_FONTS_IFACE
+EvDocumentFonts
+EvDocumentFontsIface
+ev_document_fonts_scan
+ev_document_fonts_get_progress
+ev_document_fonts_fill_model
+<SUBSECTION Standard>
+EV_DOCUMENT_FONTS
+EV_IS_DOCUMENT_FONTS
+EV_TYPE_DOCUMENT_FONTS
+ev_document_fonts_get_type
+EV_DOCUMENT_FONTS_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-factory</FILE>
+ev_document_factory_get_document
+ev_document_factory_add_filters
+</SECTION>
+
+<SECTION>
+<FILE>ev-init</FILE>
+ev_init
+ev_shutdown
+</SECTION>
+
+<SECTION>
+<FILE>ev-mapping</FILE>
+EvMapping
+ev_mapping_list_find
+ev_mapping_list_find_custom
+ev_mapping_list_get_data
+ev_mapping_list_free
+</SECTION>
+
+<SECTION>
+<FILE>ev-backends-manager</FILE>
+EvTypeInfo
+ev_backends_manager_get_document
+ev_backends_manager_get_document_module_name
+ev_backends_manager_get_document_type_info
+ev_backends_manager_get_all_types_info
+</SECTION>
+
+<SECTION>
+<FILE>ev-file-helpers</FILE>
+EvCompressionType
+ev_mkstemp
+ev_mkstemp_file
+ev_mkdtemp
+ev_tmp_filename_unlink
+ev_tmp_file_unlink
+ev_tmp_uri_unlink
+ev_xfer_uri_simple
+ev_file_get_mime_type
+ev_file_uncompress
+ev_file_compress
+<SUBSECTION Standard>
+ev_compression_type_get_type
+EV_TYPE_COMPRESSION_TYPE
+</SECTION>
+
+<SECTION>
+<FILE>ev-version</FILE>
+<TITLE>Version checks</TITLE>
+EV_MAJOR_VERSION
+EV_MINOR_VERSION
+EV_MICRO_VERSION
+EV_CHECK_VERSION
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-misc</FILE>
+<TITLE>EvDocumentMisc</TITLE>
+ev_document_misc_get_thumbnail_frame
+ev_document_misc_get_page_border_size
+ev_document_misc_paint_one_page
+ev_document_misc_surface_from_pixbuf
+ev_document_misc_pixbuf_from_surface
+ev_document_misc_surface_rotate_and_scale
+ev_document_misc_invert_surface
+ev_document_misc_invert_pixbuf
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-info</FILE>
+<TITLE>EvDocumentInfo</TITLE>
+EvDocumentInfo
+EvDocumentLicense
+EvDocumentLayout
+EvDocumentMode
+EvDocumentUIHints
+PERMISSIONS_FULL
+EvDocumentPermissions
+EvDocumentInfoFields
+ev_document_info_copy
+ev_document_info_free
+ev_document_license_new
+ev_document_license_copy
+ev_document_license_free
+ev_document_license_get_text
+ev_document_license_get_uri
+ev_document_license_get_web_statement
+ev_document_error_get_type
+<SUBSECTION Standard>
+EV_TYPE_DOCUMENT_INFO
+ev_document_info_get_type
+EV_TYPE_DOCUMENT_LICENSE
+ev_document_license_get_type
+EV_TYPE_DOCUMENT_ERROR
+ev_document_layout_get_type
+EV_TYPE_DOCUMENT_LAYOUT
+ev_document_mode_get_type
+EV_TYPE_DOCUMENT_MODE
+ev_document_ui_hints_get_type
+EV_TYPE_DOCUMENT_UI_HINTS
+ev_document_permissions_get_type
+EV_TYPE_DOCUMENT_PERMISSIONS
+ev_document_info_fields_get_type
+EV_TYPE_DOCUMENT_INFO_FIELDS
+</SECTION>
diff --git a/help/reference/libdocument/libevdocument.types b/help/reference/libdocument/libevdocument.types
index e8c3ef3..78d3020 100644
--- a/help/reference/libdocument/libevdocument.types
+++ b/help/reference/libdocument/libevdocument.types
@@ -1,48 +1,55 @@
-#include "evince-document.h"
-
+ev_annotation_attachment_get_type
+ev_annotation_get_type
+ev_annotation_markup_get_type
+ev_annotation_text_get_type
ev_async_renderer_get_type
ev_attachment_get_type
+ev_compression_type_get_type
+ev_document_annotations_get_type
+ev_document_attachments_get_type
+ev_document_error_get_type
ev_document_find_get_type
ev_document_fonts_get_type
ev_document_forms_get_type
+ev_document_get_type
ev_document_images_get_type
+ev_document_info_fields_get_type
ev_document_info_get_type
+ev_document_layers_get_type
+ev_document_layout_get_type
+ev_document_license_get_type
ev_document_links_get_type
+ev_document_mode_get_type
+ev_document_permissions_get_type
+ev_document_print_get_type
ev_document_security_get_type
ev_document_thumbnails_get_type
ev_document_transition_get_type
+ev_document_ui_hints_get_type
+ev_file_exporter_capabilities_get_type
+ev_file_exporter_format_get_type
ev_file_exporter_get_type
-ev_form_field_get_type
-ev_form_field_text_get_type
ev_form_field_button_get_type
+ev_form_field_button_type_get_type
ev_form_field_choice_get_type
+ev_form_field_choice_type_get_type
+ev_form_field_get_type
ev_form_field_signature_get_type
+ev_form_field_text_get_type
+ev_form_field_text_type_get_type
ev_image_get_type
+ev_layer_get_type
ev_link_action_get_type
+ev_link_action_type_get_type
ev_link_dest_get_type
+ev_link_dest_type_get_type
ev_link_get_type
+ev_page_get_type
+ev_rectangle_get_type
ev_render_context_get_type
-ev_document_get_type
ev_selection_get_type
-ev_document_error_get_type
-ev_document_layout_get_type
-ev_document_mode_get_type
-ev_document_ui_hints_get_type
-ev_document_permissions_get_type
-ev_document_info_fields_get_type
-ev_file_exporter_format_get_type
-ev_file_exporter_capabilities_get_type
-ev_compression_type_get_type
-ev_form_field_text_type_get_type
-ev_form_field_button_type_get_type
-ev_form_field_choice_type_get_type
-ev_link_action_type_get_type
-ev_link_dest_type_get_type
ev_selection_style_get_type
-ev_transition_effect_type_get_type
ev_transition_effect_alignment_get_type
ev_transition_effect_direction_get_type
-ev_layer_get_type
-ev_page_get_type
ev_transition_effect_get_type
-ev_document_layers_get_type
+ev_transition_effect_type_get_type
diff --git a/help/reference/libview/Makefile.am b/help/reference/libview/Makefile.am
index 1f9f94d..bfcffcd 100644
--- a/help/reference/libview/Makefile.am
+++ b/help/reference/libview/Makefile.am
@@ -1,7 +1,5 @@
-## Process this file with automake to produce Makefile.in
-
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
+# We require automake 1.10 for $(abs_builddir)
+AUTOMAKE_OPTIONS = 1.10
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
@@ -9,100 +7,133 @@ AUTOMAKE_OPTIONS = 1.6
# of using the various options.
# The name of the module, e.g. 'glib'.
-DOC_MODULE=libevview
+DOC_MODULE = libevview
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+DOC_MODULE_VERSION = $(EV_API_VERSION)
+
# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting the functions and macros.
+# viewing the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=../../../libview
+DOC_SOURCE_DIR = ../../../libview
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
+SCANGOBJ_OPTIONS =
# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS =
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS = --sgml-mode --output-format=xml --name-space=ev
# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
+MKTMPL_OPTIONS =
+# Extra options to supply to gtkdoc-mkhtml
# Add the builddir to the HTML path so that version.xml is found
-MKHTML_OPTIONS=--path="$(abs_builddir)"
+MKHTML_OPTIONS = --path="$(abs_builddir)"
# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
+FIXXREF_OPTIONS = \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio \
+ --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk \
+ --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk-pixbuf \
+ --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gtk
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/libview/*.h
-CFILE_GLOB=$(top_srcdir)/libview/*.c
+HFILE_GLOB = \
+ $(top_srcdir)/libview/*.h \
+ $(top_builddir)/libview/*.h
+
+CFILE_GLOB = \
+ $(top_srcdir)/libview/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+# EXTRA_HFILES = $(top_builddir)/evview/ev-version.h
+EXTRA_HFILES =
-# Header files to ignore when scanning.
+# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES= \
- ev-pixbuf-cache.h \
- ev-timeline.h \
- ev-transition-animation.h \
- ev-view-accessible.h \
- ev-view-marshal.h \
+IGNORE_HFILES = \
+ config.h \
+ ev-pixbuf-cache.h \
+ ev-timeline.h \
+ ev-transition-animation.h \
+ ev-view-accessible.h \
+ ev-view-marshal.h \
ev-view-private.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
+HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files= \
- version.xml
+content_files = \
+ version.xml
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
-expand_content_files=
+expand_content_files =
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
-# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-INCLUDES= \
+GTKDOC_CFLAGS = \
-I$(top_srcdir) \
-I$(top_builddir) \
-I$(top_srcdir)/libview \
+ -I$(top_srcdir)/libdocument \
+ -I$(top_builddir)/libdocument \
-DDATADIR=\"$(pkgdatadir)\" \
-DGNOMEDATADIR=\"$(datadir)\" \
-DEVINCE_UIDIR=\"$(pkgdatadir)\" \
-DGNOMELOCALEDIR=\"$(datadir)/locale\" \
+ -DEV_BACKENDSDIR=\"$(backenddir)\" \
-DEVINCE_COMPILATION \
- -I$(top_srcdir)/libdocument \
- -I$(top_builddir)/libdocument \
$(AM_CFLAGS) \
$(LIBVIEW_CFLAGS) \
$(WARN_CFLAGS) \
$(DISABLE_DEPRECATED)
-GTKDOC_LIBS= \
- $(top_builddir)/libview/libevview.la \
- $(top_builddir)/libdocument/libevdocument.la \
- $(LIBVIEW_LIBS)
+GTKDOC_LIBS = \
+ $(top_builddir)/libdocument/libevdocument.la \
+ $(top_builddir)/libview/libevview.la \
+ $(LIBDOCUMENT_LIBS)
# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST += version.xml.in
+EXTRA_DIST += \
+ version.xml.in
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want your docs-status tested during 'make check'
+if ENABLE_GTK_DOC
+#TESTS_ENVIRONMENT = cd $(srcsrc) &&
+#TESTS = $(GTKDOC_CHECK)
+endif
-include $(top_srcdir)/git.mk
diff --git a/help/reference/libview/libevview-docs.xml b/help/reference/libview/libevview-docs.xml
new file mode 100644
index 0000000..40c2357
--- /dev/null
+++ b/help/reference/libview/libevview-docs.xml
@@ -0,0 +1,145 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+ <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="evince-view">
+ <!--
+ Copyright © 2009, 2010 Christian Persch
+
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU General Public License, Version 2
+ as published by the Free Software Foundation; or (at your option) any
+ later version.
+
+ A copy of the license is included in the COPYING file.
+ -->
+ <bookinfo>
+ <title>Evince View Library Reference Manual</title>
+ <releaseinfo>
+ For Evince version &version;.
+ The latest version of this documentation can be found on-line at the
+ <ulink role="online-location" url="http://library.gnome.org/devel/libevview/index.html";>GNOME Library</ulink>.
+ </releaseinfo>
+
+ <copyright>
+ <year>2007</year>
+ <year>2008</year>
+ <year>2009</year>
+ <holder>Nickolay V. Shmyrev</holder>
+ </copyright>
+
+ <copyright>
+ <year>2008</year>
+ <year>2009</year>
+ <year>2010</year>
+ <holder>Carlos Garcia Campo</holder>
+ </copyright>
+
+ <copyright>
+ <year>2009</year>
+ <year>2010</year>
+ <holder>Christian Persch</holder>
+ </copyright>
+
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the <citetitle>GNU General Public Licence</citetitle>
+ published by the Free Software Foundation; either version 2 of the License,
+ or (at your option) any later version.
+
+ You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
+ from the Free Software Foundation at
+ <ulink type="http" url="http://www.gnu.org/licences/";>GNU Licences web site</ulink>
+ or by writing to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>51 Franklin St</street> â?? Fifth Floor,
+ <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+ </legalnotice>
+ </bookinfo>
+
+ <part id="view-view">
+ <title>Evince View</title>
+ <partintro>
+ <para>
+ </para>
+ </partintro>
+
+ <xi:include href="xml/ev-annotation-window.xml"/>
+ <xi:include href="xml/ev-view.xml"/>
+ <xi:include href="xml/ev-page-cache.xml"/>
+ <xi:include href="xml/ev-print-operation.xml"/>
+ <xi:include href="xml/ev-view-presentation.xml"/>
+ <xi:include href="xml/ev-jobs.xml"/>
+ <xi:include href="xml/ev-document-model.xml"/>
+ <xi:include href="xml/ev-stock-icons.xml"/>
+ <xi:include href="xml/ev-view-type-builtins.xml"/>
+ <xi:include href="xml/ev-job-scheduler.xml"/>
+ <xi:include href="xml/ev-view-cursor.xml"/>
+ </part>
+
+ <chapter id="object-tree">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <!--
+ <index id="api-index-deprecated" role="deprecated">
+ <title>Index of deprecated symbols</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+ -->
+ <!--
+ <index id="api-index-2-30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
+ </index>
+ -->
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+
+ <appendix id="licence">
+ <title>Licence</title>
+
+ <para>
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the <citetitle>GNU General Public
+ Licence</citetitle> as published by the Free Software Foundation; either
+ version 2 of the Licence, or (at your option) any later version.
+ </para>
+
+ <para>
+ This library 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
+ <citetitle>GNU General Public Licence</citetitle> for
+ more details.
+ </para>
+
+ <para>
+ You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
+ from the Free Software Foundation at
+ <ulink type="http" url="http://www.gnu.org/licences/";>GNU Licences web site</ulink>
+ or by writing to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>51 Franklin St</street> â?? Fifth Floor,
+ <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+ </appendix>
+
+</book>
diff --git a/help/reference/libview/libevview-sections.txt b/help/reference/libview/libevview-sections.txt
new file mode 100644
index 0000000..fe50b2e
--- /dev/null
+++ b/help/reference/libview/libevview-sections.txt
@@ -0,0 +1,338 @@
+<SECTION>
+<FILE>ev-annotation-window</FILE>
+EvAnnotationWindow
+EvAnnotationWindowClass
+ev_annotation_window_new
+ev_annotation_window_get_annotation
+ev_annotation_window_set_annotation
+ev_annotation_window_is_open
+ev_annotation_window_get_rectangle
+ev_annotation_window_set_rectangle
+ev_annotation_window_grab_focus
+ev_annotation_window_ungrab_focus
+<SUBSECTION Standard>
+EV_ANNOTATION_WINDOW
+EV_IS_ANNOTATION_WINDOW
+EV_TYPE_ANNOTATION_WINDOW
+ev_annotation_window_get_type
+EV_ANNOTATION_WINDOW_CLASS
+EV_IS_ANNOTATION_WINDOW_CLASS
+EV_ANNOTATION_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-view</FILE>
+EvView
+EvViewClass
+EvViewSelectionMode
+ev_view_new
+ev_view_set_model
+ev_view_set_loading
+ev_view_reload
+ev_view_copy
+ev_view_copy_link_address
+ev_view_select_all
+ev_view_get_has_selection
+ev_view_set_presentation
+ev_view_get_presentation
+ev_view_can_zoom_in
+ev_view_zoom_in
+ev_view_can_zoom_out
+ev_view_zoom_out
+ev_view_find_next
+ev_view_find_previous
+ev_view_find_search_changed
+ev_view_find_set_highlight_search
+ev_view_find_changed
+ev_view_find_cancel
+ev_view_hide_cursor
+ev_view_show_cursor
+ev_view_scroll
+ev_view_handle_link
+ev_view_next_page
+ev_view_previous_page
+ev_view_autoscroll_start
+ev_view_autoscroll_stop
+<SUBSECTION Standard>
+EV_VIEW
+EV_IS_VIEW
+EV_TYPE_VIEW
+ev_view_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ev-page-cache</FILE>
+EvPageCache
+EvPageCacheClass
+ev_page_cache_new
+ev_page_cache_set_page_range
+ev_page_cache_get_flags
+ev_page_cache_set_flags
+ev_page_cache_get_link_mapping
+ev_page_cache_get_image_mapping
+ev_page_cache_get_form_field_mapping
+ev_page_cache_get_annot_mapping
+ev_page_cache_get_text_mapping
+<SUBSECTION Standard>
+EV_PAGE_CACHE
+EV_IS_PAGE_CACHE
+EV_TYPE_PAGE_CACHE
+ev_page_cache_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ev-print-operation</FILE>
+EvPrintOperation
+EvPrintOperationClass
+ev_print_operation_exists_for_document
+ev_print_operation_new
+ev_print_operation_set_current_page
+ev_print_operation_set_print_settings
+ev_print_operation_get_print_settings
+ev_print_operation_set_default_page_setup
+ev_print_operation_get_default_page_setup
+ev_print_operation_set_job_name
+ev_print_operation_get_job_name
+ev_print_operation_run
+ev_print_operation_cancel
+ev_print_operation_get_error
+ev_print_operation_set_embed_page_setup
+ev_print_operation_get_embed_page_setup
+ev_print_operation_get_status
+ev_print_operation_get_progress
+<SUBSECTION Standard>
+EV_PRINT_OPERATION
+EV_IS_PRINT_OPERATION
+EV_TYPE_PRINT_OPERATION
+ev_print_operation_get_type
+EV_PRINT_OPERATION_CLASS
+EV_PRINT_OPERATION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-view-presentation</FILE>
+EvViewPresentation
+EvViewPresentationClass
+ev_view_presentation_new
+ev_view_presentation_get_current_page
+<SUBSECTION Standard>
+EV_VIEW_PRESENTATION
+EV_IS_VIEW_PRESENTATION
+EV_TYPE_VIEW_PRESENTATION
+ev_view_presentation_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ev-jobs</FILE>
+<TITLE>EvJob</TITLE>
+EvJob
+EvJobClass
+EvJobRender
+EvJobRenderClass
+EvJobPageData
+EvJobPageDataClass
+EvJobThumbnail
+EvJobThumbnailClass
+EvJobLinks
+EvJobLinksClass
+EvJobAttachments
+EvJobAttachmentsClass
+EvJobFonts
+EvJobFontsClass
+EvJobLoad
+EvJobLoadClass
+EvJobSave
+EvJobSaveClass
+EvJobFind
+EvJobFindClass
+EvJobLayers
+EvJobLayersClass
+EvJobExport
+EvJobExportClass
+EvJobPrint
+EvJobPrintClass
+EvJobRunMode
+EvJobPageDataFlags
+ev_job_run
+ev_job_cancel
+ev_job_failed
+ev_job_failed_from_error
+ev_job_succeeded
+ev_job_is_finished
+ev_job_is_failed
+ev_job_get_run_mode
+ev_job_set_run_mode
+ev_job_links_new
+ev_job_attachments_new
+ev_job_export_new
+ev_job_export_set_page
+ev_job_render_new
+ev_job_render_set_selection_info
+ev_job_page_data_new
+ev_job_thumbnail_new
+ev_job_fonts_new
+ev_job_load_new
+ev_job_load_set_uri
+ev_job_load_set_password
+ev_job_save_new
+ev_job_find_new
+ev_job_find_get_n_results
+ev_job_find_get_progress
+ev_job_find_has_results
+ev_job_find_get_results
+ev_job_layers_new
+ev_job_print_new
+ev_job_print_set_page
+ev_job_print_set_cairo
+<SUBSECTION Standard>
+ev_job_run_mode_get_type
+EV_TYPE_JOB_RUN_MODE
+ev_job_page_data_flags_get_type
+EV_TYPE_JOB_PAGE_DATA_FLAGS
+ev_job_priority_get_type
+EV_TYPE_JOB_PRIORITY
+EV_JOB
+EV_IS_JOB
+EV_TYPE_JOB
+ev_job_get_type
+EV_JOB_CLASS
+EV_JOB_GET_CLASS
+EV_TYPE_JOB_LINKS
+ev_job_links_get_type
+EV_JOB_LINKS
+EV_JOB_LINKS_CLASS
+EV_IS_JOB_LINKS
+EV_TYPE_JOB_ATTACHMENTS
+ev_job_attachments_get_type
+EV_JOB_ATTACHMENTS
+EV_JOB_ATTACHMENTS_CLASS
+EV_IS_JOB_ATTACHMENTS
+EV_TYPE_JOB_RENDER
+ev_job_render_get_type
+EV_JOB_RENDER
+EV_JOB_RENDER_CLASS
+EV_IS_JOB_RENDER
+EV_TYPE_JOB_PAGE_DATA
+ev_job_page_data_get_type
+EV_JOB_PAGE_DATA
+EV_JOB_PAGE_DATA_CLASS
+EV_IS_JOB_PAGE_DATA
+EV_TYPE_JOB_THUMBNAIL
+ev_job_thumbnail_get_type
+EV_JOB_THUMBNAIL
+EV_JOB_THUMBNAIL_CLASS
+EV_IS_JOB_THUMBNAIL
+EV_TYPE_JOB_FONTS
+ev_job_fonts_get_type
+EV_JOB_FONTS
+EV_JOB_FONTS_CLASS
+EV_IS_JOB_FONTS
+EV_TYPE_JOB_LOAD
+ev_job_load_get_type
+EV_JOB_LOAD
+EV_JOB_LOAD_CLASS
+EV_IS_JOB_LOAD
+EV_TYPE_JOB_SAVE
+ev_job_save_get_type
+EV_JOB_SAVE
+EV_JOB_SAVE_CLASS
+EV_IS_JOB_SAVE
+EV_TYPE_JOB_FIND
+ev_job_find_get_type
+EV_JOB_FIND
+EV_JOB_FIND_CLASS
+EV_IS_JOB_FIND
+EV_TYPE_JOB_LAYERS
+ev_job_layers_get_type
+EV_JOB_LAYERS
+EV_JOB_LAYERS_CLASS
+EV_IS_JOB_LAYERS
+EV_TYPE_JOB_EXPORT
+ev_job_export_get_type
+EV_JOB_EXPORT
+EV_JOB_EXPORT_CLASS
+EV_IS_JOB_EXPORT
+EV_TYPE_JOB_PRINT
+ev_job_print_get_type
+EV_JOB_PRINT
+EV_JOB_PRINT_CLASS
+EV_IS_JOB_PRINT
+</SECTION>
+
+<SECTION>
+<FILE>ev-document-model</FILE>
+EvSizingMode
+EvDocumentModel
+EvDocumentModelClass
+ev_document_model_new
+ev_document_model_new_with_document
+ev_document_model_set_document
+ev_document_model_get_document
+ev_document_model_set_page
+ev_document_model_set_page_by_label
+ev_document_model_get_page
+ev_document_model_set_scale
+ev_document_model_get_scale
+ev_document_model_set_max_scale
+ev_document_model_get_max_scale
+ev_document_model_set_min_scale
+ev_document_model_get_min_scale
+ev_document_model_set_sizing_mode
+ev_document_model_get_sizing_mode
+ev_document_model_set_rotation
+ev_document_model_get_rotation
+ev_document_model_set_inverted_colors
+ev_document_model_get_inverted_colors
+ev_document_model_set_continuous
+ev_document_model_get_continuous
+ev_document_model_set_dual_page
+ev_document_model_get_dual_page
+ev_document_model_set_fullscreen
+ev_document_model_get_fullscreen
+<SUBSECTION Standard>
+ev_sizing_mode_get_type
+EV_TYPE_SIZING_MODE
+EV_DOCUMENT_MODEL
+EV_IS_DOCUMENT_MODEL
+EV_TYPE_DOCUMENT_MODEL
+ev_document_model_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ev-stock-icons</FILE>
+EV_STOCK_ZOOM
+EV_STOCK_ZOOM_PAGE
+EV_STOCK_ZOOM_WIDTH
+EV_STOCK_VIEW_DUAL
+EV_STOCK_VIEW_CONTINUOUS
+EV_STOCK_ROTATE_LEFT
+EV_STOCK_ROTATE_RIGHT
+EV_STOCK_RUN_PRESENTATION
+EV_STOCK_VISIBLE
+EV_STOCK_RESIZE_SE
+EV_STOCK_RESIZE_SW
+EV_STOCK_CLOSE
+EV_STOCK_INVERTED_COLORS
+ev_stock_icons_init
+ev_stock_icons_shutdown
+ev_stock_icons_set_screen
+</SECTION>
+
+<SECTION>
+<FILE>ev-view-type-builtins</FILE>
+ev_view_selection_mode_get_type
+EV_TYPE_VIEW_SELECTION_MODE
+</SECTION>
+
+<SECTION>
+<FILE>ev-job-scheduler</FILE>
+EvJobPriority
+ev_job_scheduler_push_job
+ev_job_scheduler_update_job
+</SECTION>
+
+<SECTION>
+<FILE>ev-view-cursor</FILE>
+EvViewCursor
+ev_view_cursor_new
+</SECTION>
diff --git a/help/reference/libview/libevview.types b/help/reference/libview/libevview.types
index 003f08c..668b715 100644
--- a/help/reference/libview/libevview.types
+++ b/help/reference/libview/libevview.types
@@ -1,19 +1,29 @@
#include <evince-view.h>
+#include "ev-annotation-window.h"
+#include "ev-page-cache.h"
+#include "ev-view-presentation.h"
-ev_job_get_type
-ev_job_links_get_type
+ev_annotation_window_get_type
+ev_document_model_get_type
ev_job_attachments_get_type
-ev_job_render_get_type
-ev_job_thumbnail_get_type
-ev_job_fonts_get_type
-ev_job_load_get_type
-ev_job_save_get_type
+ev_job_export_get_type
ev_job_find_get_type
+ev_job_fonts_get_type
+ev_job_get_type
ev_job_layers_get_type
-ev_job_export_get_type
-ev_view_get_type
-ev_job_run_mode_get_type
+ev_job_links_get_type
+ev_job_load_get_type
ev_job_page_data_flags_get_type
+ev_job_page_data_get_type
+ev_job_print_get_type
ev_job_priority_get_type
+ev_job_render_get_type
+ev_job_run_mode_get_type
+ev_job_save_get_type
+ev_job_thumbnail_get_type
+ev_page_cache_get_type
+ev_print_operation_get_type
ev_sizing_mode_get_type
+ev_view_get_type
+ev_view_presentation_get_type
ev_view_selection_mode_get_type
diff --git a/help/reference/shell/Makefile.am b/help/reference/shell/Makefile.am
index c2e18c0..948d4b1 100644
--- a/help/reference/shell/Makefile.am
+++ b/help/reference/shell/Makefile.am
@@ -1,7 +1,5 @@
-## Process this file with automake to produce Makefile.in
-
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
+# We require automake 1.10 for $(abs_builddir)
+AUTOMAKE_OPTIONS = 1.10
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
@@ -9,75 +7,98 @@ AUTOMAKE_OPTIONS = 1.6
# of using the various options.
# The name of the module, e.g. 'glib'.
-DOC_MODULE=evince
+DOC_MODULE = evince
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+# DOC_MODULE_VERSION = $(EV_API_VERSION)
# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting the functions and macros.
+# evinceing the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=../../../shell --source-dir=../../../libmisc
+DOC_SOURCE_DIR = ../../../shell --source-dir=../../../libmisc
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
+SCANGOBJ_OPTIONS =
# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS =
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS = --sgml-mode --output-format=xml --name-space=ev
# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=--source-dir=../../../libmisc
+MKTMPL_OPTIONS =--source-dir=../../../libmisc
+# Extra options to supply to gtkdoc-mkhtml
# Add the builddir to the HTML path so that version.xml is found
-MKHTML_OPTIONS=--path="$(abs_builddir)"
+MKHTML_OPTIONS = --path="$(abs_builddir)"
# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
+FIXXREF_OPTIONS = \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio \
+ --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk \
+ --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk-pixbuf \
+ --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gtk
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/shell/*.h
-CFILE_GLOB=$(top_srcdir)/shell/*.c
-
-# Header files to ignore when scanning.
+HFILE_GLOB = \
+ $(top_srcdir)/shell/*.h \
+ $(top_builddir)/shell/*.h \
+ $(top_srcdir)/libmisc/*.h \
+ $(top_builddir)/libmisc/*.h
+
+CFILE_GLOB = \
+ $(top_srcdir)/shell/*.c \
+ $(top_srcdir)/libmisc/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+# EXTRA_HFILES = $(top_builddir)/evince/ev-version.h
+EXTRA_HFILES =
+
+# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES= \
- ev-marshal.h \
- ev-marshal.c
+IGNORE_HFILES = \
+ config.h \
+ ev-marshal.h \
+ ev-application-service.h \
+ ev-daemon-service.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
+HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=
+content_files = \
+ version.xml
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
-expand_content_files=
+expand_content_files =
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
-# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-INCLUDES= \
+GTKDOC_CFLAGS = \
-I$(top_srcdir) \
-I$(top_builddir) \
- -I$(top_srcdir)/shell \
- -DDATADIR=\"$(pkgdatadir)\" \
- -DGNOMEDATADIR=\"$(datadir)\" \
+ -I$(top_srcdir)/shell \
+ -I$(top_builddir)/shell \
-I$(top_srcdir)/cut-n-paste/zoom-control/ \
-I$(top_srcdir)/cut-n-paste/toolbar-editor/ \
-I$(top_srcdir)/cut-n-paste/totem-screensaver/ \
@@ -87,6 +108,8 @@ INCLUDES= \
-I$(top_srcdir)/libmisc \
-I$(top_builddir)/libview \
-I$(top_srcdir)/properties \
+ -DDATADIR=\"$(pkgdatadir)\" \
+ -DGNOMEDATADIR=\"$(datadir)\" \
-DGNOMELOCALEDIR=\"$(datadir)/locale\" \
-DGNOMEICONDIR=\""$(datadir)/pixmaps"\" \
-DEVINCE_COMPILATION \
@@ -100,7 +123,7 @@ FILTER_OUT = \
$(top_builddir)/shell/evinced-ev-daemon.o \
$(top_builddir)/shell/ev-convert-metadata.o
-GTKDOC_LIBS= \
+GTKDOC_LIBS = \
$(top_builddir)/cut-n-paste/zoom-control/libephyzoom.la \
$(top_builddir)/cut-n-paste/toolbar-editor/libtoolbareditor.la \
$(top_builddir)/cut-n-paste/totem-screensaver/libtotemscrsaver.la \
@@ -115,23 +138,23 @@ GTKDOC_LIBS= \
$(GTK_PRINT_LIBS) \
$(filter-out $(FILTER_OUT),$(wildcard $(top_builddir)/shell/*.o))
-if ENABLE_DJVU
-GTKDOC_LIBS += $(DJVU_LIBS)
-endif
-
-if ENABLE_DVI
-GTKDOC_LIBS += -lkpathsea
-endif
-
-if WITH_TYPE1_FONTS
-GTKDOC_LIBS += -lt1
-endif
-
# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST += version.xml.in
+EXTRA_DIST += \
+ version.xml.in
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want your docs-status tested during 'make check'
+if ENABLE_GTK_DOC
+#TESTS_ENVIRONMENT = cd $(srcsrc) &&
+#TESTS = $(GTKDOC_CHECK)
+endif
-include $(top_srcdir)/git.mk
diff --git a/help/reference/shell/evince-docs.xml b/help/reference/shell/evince-docs.xml
new file mode 100644
index 0000000..4af6fa4
--- /dev/null
+++ b/help/reference/shell/evince-docs.xml
@@ -0,0 +1,163 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+ <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="evince">
+ <!--
+ Copyright © 2009, 2010 Christian Persch
+
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU General Public License, Version 2
+ as published by the Free Software Foundation; or (at your option) any
+ later version.
+
+ A copy of the license is included in the COPYING file.
+ -->
+ <bookinfo>
+ <title>Evince Programmer's Reference Manual</title>
+ <releaseinfo>
+ For Evince version &version;.
+ The latest version of this documentation can be found on-line at the
+ <ulink role="online-location" url="http://library.gnome.org/devel/evince/index.html";>GNOME Library</ulink>.
+ </releaseinfo>
+
+ <copyright>
+ <year>2007</year>
+ <year>2008</year>
+ <year>2009</year>
+ <holder>Nickolay V. Shmyrev</holder>
+ </copyright>
+
+ <copyright>
+ <year>2008</year>
+ <year>2009</year>
+ <year>2010</year>
+ <holder>Carlos Garcia Campo</holder>
+ </copyright>
+
+ <copyright>
+ <year>2009</year>
+ <year>2010</year>
+ <holder>Christian Persch</holder>
+ </copyright>
+
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the <citetitle>GNU General Public Licence</citetitle>
+ published by the Free Software Foundation; either version 2 of the License,
+ or (at your option) any later version.
+
+ You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
+ from the Free Software Foundation at
+ <ulink type="http" url="http://www.gnu.org/licences/";>GNU Licences web site</ulink>
+ or by writing to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>51 Franklin St</street> â?? Fifth Floor,
+ <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+ </legalnotice>
+ </bookinfo>
+
+ <part id="evince-frontend">
+ <title>Frontend</title>
+ <partintro>
+ <para>
+ Evince frontend.
+ </para>
+ </partintro>
+
+ <xi:include href="xml/ev-sidebar-attachments.xml"/>
+ <xi:include href="xml/ev-properties-dialog.xml"/>
+ <xi:include href="xml/ev-properties-fonts.xml"/>
+ <xi:include href="xml/ev-sidebar-page.xml"/>
+ <xi:include href="xml/ev-open-recent-action.xml"/>
+ <xi:include href="xml/ev-application.xml"/>
+ <xi:include href="xml/ev-sidebar-thumbnails.xml"/>
+ <xi:include href="xml/ev-sidebar-links.xml"/>
+ <xi:include href="xml/ev-sidebar.xml"/>
+ <xi:include href="xml/ev-properties-license.xml"/>
+ <xi:include href="xml/ev-message-area.xml"/>
+ <xi:include href="xml/ev-progress-message-area.xml"/>
+ <xi:include href="xml/ev-metadata.xml"/>
+ <xi:include href="xml/ev-window.xml"/>
+ <xi:include href="xml/ev-history.xml"/>
+ <xi:include href="xml/ev-sidebar-layers.xml"/>
+ <xi:include href="xml/ev-password-view.xml"/>
+ <xi:include href="xml/eggfindbar.xml"/>
+ <xi:include href="xml/ev-media-player-keys.xml"/>
+ <xi:include href="xml/ev-navigation-action.xml"/>
+ <xi:include href="xml/ev-file-monitor.xml"/>
+ <xi:include href="xml/ev-page-action.xml"/>
+ <xi:include href="xml/ev-window-title.xml"/>
+ <xi:include href="xml/ev-navigation-action-widget.xml"/>
+ <xi:include href="xml/ev-application-service.xml"/>
+ <xi:include href="xml/ev-keyring.xml"/>
+ <xi:include href="xml/ev-utils.xml"/>
+ <xi:include href="xml/ev-page-action-widget.xml"/>
+ </part>
+
+ <chapter id="object-tree">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <!--
+ <index id="api-index-deprecated" role="deprecated">
+ <title>Index of deprecated symbols</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+ -->
+ <!--
+ <index id="api-index-2-30" role="2.30">
+ <title>Index of new symbols in 2.30</title>
+ <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
+ </index>
+ -->
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+
+ <appendix id="licence">
+ <title>Licence</title>
+
+ <para>
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the <citetitle>GNU General Public
+ Licence</citetitle> as published by the Free Software Foundation; either
+ version 2 of the Licence, or (at your option) any later version.
+ </para>
+
+ <para>
+ This library 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
+ <citetitle>GNU General Public Licence</citetitle> for
+ more details.
+ </para>
+
+ <para>
+ You may obtain a copy of the <citetitle>GNU General Public Licence</citetitle>
+ from the Free Software Foundation at
+ <ulink type="http" url="http://www.gnu.org/licences/";>GNU Licences web site</ulink>
+ or by writing to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>51 Franklin St</street> â?? Fifth Floor,
+ <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+ </appendix>
+
+</book>
diff --git a/help/reference/shell/evince-sections.txt b/help/reference/shell/evince-sections.txt
new file mode 100644
index 0000000..a775f7e
--- /dev/null
+++ b/help/reference/shell/evince-sections.txt
@@ -0,0 +1,472 @@
+<SECTION>
+<FILE>ev-sidebar-attachments</FILE>
+<TITLE>EvSidebarAttachments</TITLE>
+EvSidebarAttachments
+EvSidebarAttachmentsClass
+EvSidebarAttachmentsPrivate
+ev_sidebar_attachments_new
+<SUBSECTION Standard>
+EV_SIDEBAR_ATTACHMENTS
+EV_IS_SIDEBAR_ATTACHMENTS
+EV_TYPE_SIDEBAR_ATTACHMENTS
+ev_sidebar_attachments_get_type
+EV_SIDEBAR_ATTACHMENTS_CLASS
+EV_IS_SIDEBAR_ATTACHMENTS_CLASS
+EV_SIDEBAR_ATTACHMENTS_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-properties-dialog</FILE>
+EvPropertiesDialog
+EvPropertiesDialogClass
+EvPropertiesDialogPrivate
+ev_properties_dialog_new
+ev_properties_dialog_set_document
+<SUBSECTION Standard>
+EV_PROPERTIES_DIALOG
+EV_IS_PROPERTIES_DIALOG
+EV_TYPE_PROPERTIES_DIALOG
+ev_properties_dialog_get_type
+EV_PROPERTIES_DIALOG_CLASS
+EV_IS_PROPERTIES_DIALOG_CLASS
+EV_PROPERTIES_DIALOG_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-properties-fonts</FILE>
+EvPropertiesFonts
+EvPropertiesFontsClass
+EvPropertiesFontsPrivate
+EV_TYPE_PROPERTIES_FONTS
+EV_PROPERTIES_FONTS
+EV_PROPERTIES_FONTS_CLASS
+EV_PROPERTIES_FONTS_GET_CLASS
+ev_properties_fonts_new
+ev_properties_fonts_set_document
+<SUBSECTION Standard>
+EV_IS_PROPERTIES
+ev_properties_fonts_get_type
+EV_IS_PROPERTIES_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-sidebar-page</FILE>
+<TITLE>EvSidebarPage</TITLE>
+EV_SIDEBAR_PAGE_IFACE
+EV_IS_SIDEBAR_PAGE_IFACE
+EvSidebarPage
+EvSidebarPageIface
+ev_sidebar_page_support_document
+ev_sidebar_page_set_model
+ev_sidebar_page_get_label
+<SUBSECTION Standard>
+EV_SIDEBAR_PAGE
+EV_IS_SIDEBAR_PAGE
+EV_TYPE_SIDEBAR_PAGE
+ev_sidebar_page_get_type
+EV_SIDEBAR_PAGE_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>ev-open-recent-action</FILE>
+<TITLE>EvOpenRecentAction</TITLE>
+EvOpenRecentAction
+EvOpenRecentActionClass
+<SUBSECTION Standard>
+EV_OPEN_RECENT_ACTION
+EV_IS_OPEN_RECENT_ACTION
+EV_TYPE_OPEN_RECENT_ACTION
+ev_open_recent_action_get_type
+EV_OPEN_RECENT_ACTION_CLASS
+EV_IS_OPEN_RECENT_ACTION_CLASS
+EV_OPEN_RECENT_ACTION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-application</FILE>
+EvApplication
+EvApplicationClass
+EV_APP
+ev_application_get_instance
+ev_application_shutdown
+ev_application_load_session
+ev_application_open_window
+ev_application_open_uri_at_dest
+ev_application_open_uri_list
+ev_application_has_window
+ev_application_get_uri
+ev_application_get_media_keys
+ev_application_set_filechooser_uri
+ev_application_get_filechooser_uri
+ev_application_screensaver_enable
+ev_application_screensaver_disable
+ev_application_get_dot_dir
+ev_application_get_data_dir
+<SUBSECTION Standard>
+EV_APPLICATION
+EV_IS_APPLICATION
+EV_TYPE_APPLICATION
+ev_application_get_type
+EV_APPLICATION_CLASS
+EV_IS_APPLICATION_CLASS
+EV_APPLICATION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-sidebar-thumbnails</FILE>
+<TITLE>EvSidebarThumbnails</TITLE>
+EvSidebarThumbnails
+EvSidebarThumbnailsClass
+EvSidebarThumbnailsPrivate
+ev_sidebar_thumbnails_new
+<SUBSECTION Standard>
+EV_SIDEBAR_THUMBNAILS
+EV_IS_SIDEBAR_THUMBNAILS
+EV_TYPE_SIDEBAR_THUMBNAILS
+ev_sidebar_thumbnails_get_type
+EV_SIDEBAR_THUMBNAILS_CLASS
+EV_IS_SIDEBAR_THUMBNAILS_CLASS
+EV_SIDEBAR_THUMBNAILS_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-sidebar-links</FILE>
+<TITLE>EvSidebarLinks</TITLE>
+EvSidebarLinks
+EvSidebarLinksClass
+EvSidebarLinksPrivate
+ev_sidebar_links_new
+<SUBSECTION Standard>
+EV_SIDEBAR_LINKS
+EV_IS_SIDEBAR_LINKS
+EV_TYPE_SIDEBAR_LINKS
+ev_sidebar_links_get_type
+EV_SIDEBAR_LINKS_CLASS
+EV_IS_SIDEBAR_LINKS_CLASS
+EV_SIDEBAR_LINKS_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-sidebar</FILE>
+<TITLE>EvSidebar</TITLE>
+EvSidebar
+EvSidebarClass
+EvSidebarPrivate
+ev_sidebar_new
+ev_sidebar_add_page
+ev_sidebar_set_page
+ev_sidebar_set_model
+<SUBSECTION Standard>
+EV_SIDEBAR
+EV_IS_SIDEBAR
+EV_TYPE_SIDEBAR
+ev_sidebar_get_type
+EV_SIDEBAR_CLASS
+EV_IS_SIDEBAR_CLASS
+EV_SIDEBAR_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-properties-license</FILE>
+EvPropertiesLicense
+EvPropertiesLicenseClass
+EvPropertiesLicensePrivate
+ev_properties_license_new
+ev_properties_license_set_license
+<SUBSECTION Standard>
+EV_PROPERTIES_LICENSE
+EV_IS_PROPERTIES_LICENSE
+EV_TYPE_PROPERTIES_LICENSE
+ev_properties_license_get_type
+EV_PROPERTIES_LICENSE_CLASS
+EV_IS_PROPERTIES_LICENSE_CLASS
+EV_PROPERTIES_LICENSE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-message-area</FILE>
+<TITLE>EvMessageArea</TITLE>
+EvMessageArea
+EvMessageAreaClass
+EvMessageAreaPrivate
+ev_message_area_new
+ev_message_area_set_image
+ev_message_area_set_image_from_stock
+ev_message_area_set_text
+ev_message_area_set_secondary_text
+<SUBSECTION Standard>
+EV_MESSAGE_AREA
+EV_IS_MESSAGE_AREA
+EV_TYPE_MESSAGE_AREA
+ev_message_area_get_type
+EV_MESSAGE_AREA_CLASS
+EV_IS_MESSAGE_AREA_CLASS
+EV_MESSAGE_AREA_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-progress-message-area</FILE>
+<TITLE>EvProgressMessageArea</TITLE>
+EvProgressMessageArea
+EvProgressMessageAreaClass
+EvProgressMessageAreaPrivate
+ev_progress_message_area_new
+ev_progress_message_area_set_status
+ev_progress_message_area_set_fraction
+<SUBSECTION Standard>
+EV_PROGRESS_MESSAGE_AREA
+EV_IS_PROGRESS_MESSAGE_AREA
+EV_TYPE_PROGRESS_MESSAGE_AREA
+ev_progress_message_area_get_type
+EV_PROGRESS_MESSAGE_AREA_CLASS
+EV_IS_PROGRESS_MESSAGE_AREA_CLASS
+EV_PROGRESS_MESSAGE_AREA_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-metadata</FILE>
+EvMetadata
+EvMetadataClass
+ev_metadata_new
+ev_metadata_get_string
+ev_metadata_set_string
+ev_metadata_get_int
+ev_metadata_set_int
+ev_metadata_get_double
+ev_metadata_set_double
+ev_metadata_get_boolean
+ev_metadata_set_boolean
+ev_is_metadata_supported_for_file
+<SUBSECTION Standard>
+EV_METADATA
+EV_IS_METADATA
+EV_TYPE_METADATA
+ev_metadata_get_type
+EV_METADATA_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-window</FILE>
+<TITLE>EvWindow</TITLE>
+EvWindowRunMode
+EvPrintRange
+EvPrintPageSet
+EvWindow
+EvWindowClass
+EvWindowPrivate
+ev_window_new
+ev_window_get_uri
+ev_window_open_uri
+ev_window_open_document
+ev_window_is_empty
+ev_window_print_range
+<SUBSECTION Standard>
+EV_WINDOW
+EV_IS_WINDOW
+EV_TYPE_WINDOW
+ev_window_get_type
+EV_WINDOW_CLASS
+EV_IS_WINDOW_CLASS
+EV_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-history</FILE>
+<TITLE>EvHistory</TITLE>
+EvHistory
+EvHistoryPrivate
+EvHistoryClass
+ev_history_new
+ev_history_add_link
+ev_history_get_link_nth
+ev_history_get_n_links
+<SUBSECTION Standard>
+EV_HISTORY
+EV_IS_HISTORY
+EV_TYPE_HISTORY
+ev_history_get_type
+EV_HISTORY_CLASS
+EV_IS_HISTORY_CLASS
+EV_HISTORY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-sidebar-layers</FILE>
+<TITLE>EvSidebarLayers</TITLE>
+EvSidebarLayers
+EvSidebarLayersClass
+EvSidebarLayersPrivate
+ev_sidebar_layers_new
+<SUBSECTION Standard>
+EV_SIDEBAR_LAYERS
+EV_IS_SIDEBAR_LAYERS
+EV_TYPE_SIDEBAR_LAYERS
+ev_sidebar_layers_get_type
+EV_SIDEBAR_LAYERS_CLASS
+EV_IS_SIDEBAR_LAYERS_CLASS
+EV_SIDEBAR_LAYERS_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-password-view</FILE>
+<TITLE>EvPasswordView</TITLE>
+EvPasswordView
+EvPasswordViewClass
+EvPasswordViewPrivate
+ev_password_view_new
+ev_password_view_set_uri
+ev_password_view_ask_password
+ev_password_view_get_password
+ev_password_view_get_password_save_flags
+<SUBSECTION Standard>
+EV_PASSWORD_VIEW
+EV_IS_PASSWORD_VIEW
+EV_TYPE_PASSWORD_VIEW
+ev_password_view_get_type
+</SECTION>
+
+<SECTION>
+<FILE>eggfindbar</FILE>
+<TITLE>EggFindBar</TITLE>
+EggFindBar
+EggFindBarClass
+EggFindBarPrivate
+egg_find_bar_new
+egg_find_bar_set_search_string
+egg_find_bar_get_search_string
+egg_find_bar_set_case_sensitive
+egg_find_bar_get_case_sensitive
+egg_find_bar_get_all_matches_color
+egg_find_bar_get_current_match_color
+egg_find_bar_set_status_text
+<SUBSECTION Standard>
+EGG_FIND_BAR
+EGG_IS_FIND_BAR
+EGG_TYPE_FIND_BAR
+egg_find_bar_get_type
+EGG_FIND_BAR_CLASS
+EGG_IS_FIND_BAR_CLASS
+EGG_FIND_BAR_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-media-player-keys</FILE>
+EvMediaPlayerKeys
+EvMediaPlayerKeysClass
+ev_media_player_keys_new
+ev_media_player_keys_focused
+<SUBSECTION Standard>
+EV_MEDIA_PLAYER_KEYS
+EV_IS_MEDIA_PLAYER_KEYS
+EV_TYPE_MEDIA_PLAYER_KEYS
+ev_media_player_keys_get_type
+EV_MEDIA_PLAYER_KEYS_CLASS
+EV_IS_MEDIA_PLAYER_KEYS_CLASS
+EV_MEDIA_PLAYER_KEYS_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-navigation-action</FILE>
+<TITLE>EvNavigationAction</TITLE>
+EvNavigationAction
+EvNavigationActionPrivate
+EvNavigationActionClass
+ev_navigation_action_set_history
+<SUBSECTION Standard>
+EV_NAVIGATION_ACTION
+EV_IS_NAVIGATION_ACTION
+EV_TYPE_NAVIGATION_ACTION
+ev_navigation_action_get_type
+EV_NAVIGATION_ACTION_CLASS
+EV_IS_NAVIGATION_ACTION_CLASS
+EV_NAVIGATION_ACTION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-file-monitor</FILE>
+<TITLE>EvFileMonitor</TITLE>
+EvFileMonitor
+EvFileMonitorClass
+EvFileMonitorPrivate
+ev_file_monitor_new
+<SUBSECTION Standard>
+EV_FILE_MONITOR
+EV_IS_FILE_MONITOR
+EV_TYPE_FILE_MONITOR
+ev_file_monitor_get_type
+EV_FILE_MONITOR_CLASS
+EV_IS_FILE_MONITOR_CLASS
+EV_FILE_MONITOR_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-page-action</FILE>
+<TITLE>EvPageAction</TITLE>
+EvPageAction
+EvPageActionPrivate
+EvPageActionClass
+ev_page_action_set_model
+ev_page_action_set_links_model
+ev_page_action_grab_focus
+<SUBSECTION Standard>
+EV_PAGE_ACTION
+EV_IS_PAGE_ACTION
+EV_TYPE_PAGE_ACTION
+ev_page_action_get_type
+EV_PAGE_ACTION_CLASS
+EV_IS_PAGE_ACTION_CLASS
+EV_PAGE_ACTION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>ev-window-title</FILE>
+EvWindowTitle
+EvWindowTitleType
+ev_window_title_new
+ev_window_title_set_type
+ev_window_title_set_document
+ev_window_title_set_uri
+ev_window_title_free
+</SECTION>
+
+<SECTION>
+<FILE>ev-navigation-action-widget</FILE>
+<TITLE>EvNavigationActionWidget</TITLE>
+EV_TYPE_NAVIGATION_ACTION_WIDGET
+EV_NAVIGATION_ACTION_WIDGET
+EvNavigationActionWidget
+EvNavigationActionWidgetClass
+ev_navigation_action_widget_get_type
+ev_navigation_action_widget_set_menu
+</SECTION>
+
+<SECTION>
+<FILE>ev-keyring</FILE>
+ev_keyring_is_available
+ev_keyring_lookup_password
+ev_keyring_save_password
+</SECTION>
+
+<SECTION>
+<FILE>ev-utils</FILE>
+ev_pixbuf_add_shadow
+ev_print_region_contents
+ev_gui_menu_position_tree_selection
+get_num_monitors
+get_screen_dpi
+file_chooser_dialog_add_writable_pixbuf_formats
+get_gdk_pixbuf_format_by_extension
+</SECTION>
+
+<SECTION>
+<FILE>ev-page-action-widget</FILE>
+<TITLE>EvPageActionWidget</TITLE>
+EV_TYPE_PAGE_ACTION_WIDGET
+EV_PAGE_ACTION_WIDGET
+EvPageActionWidget
+EvPageActionWidgetClass
+ev_page_action_widget_get_type
+ev_page_action_widget_update_links_model
+ev_page_action_widget_set_model
+ev_page_action_widget_grab_focus
+</SECTION>
diff --git a/help/reference/shell/evince.types b/help/reference/shell/evince.types
index ad3906d..dea7db5 100644
--- a/help/reference/shell/evince.types
+++ b/help/reference/shell/evince.types
@@ -1,15 +1,24 @@
-#include "ev-application.h"
-#include "ev-navigation-action.h"
-#include "ev-navigation-action-widget.h"
-#include "ev-page-action.h"
-#include "ev-page-action-widget.h"
-#include "ev-window.h"
-
+egg_find_bar_get_type
ev_application_get_type
+ev_file_monitor_get_type
+ev_history_get_type
+ev_media_player_keys_get_type
+ev_message_area_get_type
+ev_metadata_get_type
ev_navigation_action_get_type
ev_navigation_action_widget_get_type
-ev_navigation_action_widget_get_type
+ev_open_recent_action_get_type
ev_page_action_get_type
ev_page_action_widget_get_type
-ev_page_action_widget_get_type
+ev_password_view_get_type
+ev_progress_message_area_get_type
+ev_properties_dialog_get_type
+ev_properties_fonts_get_type
+ev_properties_license_get_type
+ev_sidebar_attachments_get_type
+ev_sidebar_get_type
+ev_sidebar_layers_get_type
+ev_sidebar_links_get_type
+ev_sidebar_page_get_type
+ev_sidebar_thumbnails_get_type
ev_window_get_type
diff --git a/libdocument/ev-version.h.in b/libdocument/ev-version.h.in
index 2601622..bdad6f7 100644
--- a/libdocument/ev-version.h.in
+++ b/libdocument/ev-version.h.in
@@ -19,10 +19,48 @@
#ifndef EV_VERSION_H
#define EV_VERSION_H
+/**
+ * SECTION:ev-version
+ * @short_description: Library version checks
+ *
+ * These macros enable compile time checks of the library version.
+ */
+
+/**
+ * EV_MAJOR_VERSION:
+ *
+ * The major version number of the EV library
+ * (e.g. in version 3.1.4 this is 3).
+ */
+
#define EV_MAJOR_VERSION (@EV_MAJOR_VERSION@)
+
+/**
+ * EV_MINOR_VERSION:
+ *
+ * The minor version number of the EV library
+ * (e.g. in version 3.1.4 this is 1).
+ */
#define EV_MINOR_VERSION (@EV_MINOR_VERSION@)
+
+/**
+ * EV_MICRO_VERSION:
+ *
+ * The micro version number of the EV library
+ * (e.g. in version 3.1.4 this is 4).
+ */
#define EV_MICRO_VERSION (@EV_MICRO_VERSION@)
+/**
+ * EV_CHECK_VERSION:
+ * @major: required major version
+ * @minor: required minor version
+ * @micro: required micro version
+ *
+ * Macro to check the library version at compile time.
+ * It returns <literal>1</literal> if the version of EV is greater or
+ * equal to the required one, and <literal>0</literal> otherwise.
+ */
#define EV_CHECK_VERSION(major,minor,micro) \
(EV_MAJOR_VERSION > (major) || \
(EV_MAJOR_VERSION == (major) && EV_MINOR_VERSION > (minor)) || \
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
