diff options
Diffstat (limited to 'help/reference/libview')
| -rw-r--r-- | help/reference/libview/Makefile.am | 139 | ||||
| -rw-r--r-- | help/reference/libview/libevview-docs.xml | 145 | ||||
| -rw-r--r-- | help/reference/libview/libevview-overrides.txt | 0 | ||||
| -rw-r--r-- | help/reference/libview/libevview-sections.txt | 338 | ||||
| -rw-r--r-- | help/reference/libview/libevview.types | 29 | ||||
| -rw-r--r-- | help/reference/libview/version.xml.in | 1 |
6 files changed, 652 insertions, 0 deletions
diff --git a/help/reference/libview/Makefile.am b/help/reference/libview/Makefile.am new file mode 100644 index 00000000..d00a8be1 --- /dev/null +++ b/help/reference/libview/Makefile.am @@ -0,0 +1,139 @@ +# 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 = 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.xml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# viewing the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR = ../../../libview + +# 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)/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. Use base file name, no paths +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.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 = + +# 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)/libview \ + -I$(top_srcdir)/libdocument \ + -I$(top_builddir)/libdocument \ + -DEVINCEDATADIR=\"$(pkgdatadir)\" \ + -DMATEDATADIR=\"$(datadir)\" \ + -DEVINCE_UIDIR=\"$(pkgdatadir)\" \ + -DMATELOCALEDIR=\"$(datadir)/locale\" \ + -DEV_BACKENDSDIR=\"$(backenddir)\" \ + -DEVINCE_COMPILATION \ + $(AM_CFLAGS) \ + $(LIBVIEW_CFLAGS) \ + $(WARN_CFLAGS) \ + $(DISABLE_DEPRECATED) + +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 + +# 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 00000000..8bed6139 --- /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.mate.org/devel/libevview/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="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-overrides.txt b/help/reference/libview/libevview-overrides.txt new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/help/reference/libview/libevview-overrides.txt diff --git a/help/reference/libview/libevview-sections.txt b/help/reference/libview/libevview-sections.txt new file mode 100644 index 00000000..fe50b2eb --- /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 new file mode 100644 index 00000000..668b715a --- /dev/null +++ b/help/reference/libview/libevview.types @@ -0,0 +1,29 @@ +#include <evince-view.h> +#include "ev-annotation-window.h" +#include "ev-page-cache.h" +#include "ev-view-presentation.h" + +ev_annotation_window_get_type +ev_document_model_get_type +ev_job_attachments_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_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/libview/version.xml.in b/help/reference/libview/version.xml.in new file mode 100644 index 00000000..27323dad --- /dev/null +++ b/help/reference/libview/version.xml.in @@ -0,0 +1 @@ +@VERSION@
\ No newline at end of file |