diff options
Diffstat (limited to 'help/reference/libdocument')
-rw-r--r-- | help/reference/libdocument/Makefile.am | 132 | ||||
-rw-r--r-- | help/reference/libdocument/libevdocument-docs.xml | 191 | ||||
-rw-r--r-- | help/reference/libdocument/libevdocument-overrides.txt | 0 | ||||
-rw-r--r-- | help/reference/libdocument/libevdocument-sections.txt | 781 | ||||
-rw-r--r-- | help/reference/libdocument/libevdocument.types | 55 | ||||
-rw-r--r-- | help/reference/libdocument/version.xml.in | 1 |
6 files changed, 1160 insertions, 0 deletions
diff --git a/help/reference/libdocument/Makefile.am b/help/reference/libdocument/Makefile.am new file mode 100644 index 00000000..54d57919 --- /dev/null +++ b/help/reference/libdocument/Makefile.am @@ -0,0 +1,132 @@ +# 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 +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +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.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 + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS = + +# Extra options to supply to gtkdoc-scan. +# 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 --name-space=ev + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +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)" + +# 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 = \ + --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 \ + $(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. Use base file name, no paths +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.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 = + +# 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 + +# 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 = + +# 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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS = \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + -I$(top_srcdir)/libdocument \ + -DEVINCEDATADIR=\"$(pkgdatadir)\" \ + -DMATEDATADIR=\"$(datadir)\" \ + -DEVINCE_UIDIR=\"$(pkgdatadir)\" \ + -DMATELOCALEDIR=\"$(datadir)/locale\" \ + -DEV_BACKENDSDIR=\"$(backenddir)\" \ + -DEVINCE_COMPILATION \ + $(AM_CFLAGS) \ + $(LIBDOCUMENT_CFLAGS) \ + $(WARN_CFLAGS) \ + $(DISABLE_DEPRECATED) + +GTKDOC_LIBS = \ + $(top_builddir)/libdocument/libevdocument.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 + +# 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 00000000..8071e930 --- /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.mate.org/devel/libevdocument/index.html">MATE 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 Campos</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-overrides.txt b/help/reference/libdocument/libevdocument-overrides.txt new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/help/reference/libdocument/libevdocument-overrides.txt diff --git a/help/reference/libdocument/libevdocument-sections.txt b/help/reference/libdocument/libevdocument-sections.txt new file mode 100644 index 00000000..88d3db2e --- /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 new file mode 100644 index 00000000..78d30202 --- /dev/null +++ b/help/reference/libdocument/libevdocument.types @@ -0,0 +1,55 @@ +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_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_selection_get_type +ev_selection_style_get_type +ev_transition_effect_alignment_get_type +ev_transition_effect_direction_get_type +ev_transition_effect_get_type +ev_transition_effect_type_get_type diff --git a/help/reference/libdocument/version.xml.in b/help/reference/libdocument/version.xml.in new file mode 100644 index 00000000..27323dad --- /dev/null +++ b/help/reference/libdocument/version.xml.in @@ -0,0 +1 @@ +@VERSION@
\ No newline at end of file |