From a6a9e8990dfb06ba0644c1de93d59f0e7b787a88 Mon Sep 17 00:00:00 2001 From: "Nickolay V. Shmyrev" Date: Tue, 30 Jan 2007 01:37:54 +0000 Subject: [PATCH] Updated index document. 2007-01-30 Nickolay V. Shmyrev * reference/Makefile.am: * reference/evince-docs.sgml: * reference/evince.types: Updated index document. svn path=/trunk/; revision=2276 --- help/ChangeLog | 8 ++ help/reference/Makefile.am | 7 +- help/reference/evince-docs.sgml | 156 ++++++++++++++++++++++++++++---- help/reference/evince.types | 37 ++++++-- 4 files changed, 182 insertions(+), 26 deletions(-) diff --git a/help/ChangeLog b/help/ChangeLog index ef7397bd..3af83ae9 100644 --- a/help/ChangeLog +++ b/help/ChangeLog @@ -1,3 +1,11 @@ +2007-01-30 Nickolay V. Shmyrev + + * reference/Makefile.am: + * reference/evince-docs.sgml: + * reference/evince.types: + + Updated index document. + 2007-01-29 Nickolay V. Shmyrev * reference/Makefile.am: diff --git a/help/reference/Makefile.am b/help/reference/Makefile.am index ecf70a8c..6da188bc 100644 --- a/help/reference/Makefile.am +++ b/help/reference/Makefile.am @@ -47,7 +47,12 @@ CFILE_GLOB=$(top_srcdir)/shell/*.c $(top_srcdir)/libdocument/*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES= +IGNORE_HFILES= \ +ev-backend-marshal.c \ +ev-backend-marshalers.h \ +ev-backend-marshalers.c \ +ev-marshal.h \ +ev-marshal.c # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png diff --git a/help/reference/evince-docs.sgml b/help/reference/evince-docs.sgml index 46fdae78..d5bd32c2 100644 --- a/help/reference/evince-docs.sgml +++ b/help/reference/evince-docs.sgml @@ -1,41 +1,159 @@ - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ]> Evince Programmer's Reference Manual - - + + + <phrase>Document interfaces</phrase> + + + Provides support for writing Evince backends. For example EvAttachment is used to represent document attachments. + The core have objects that represent various document + interfaces. - &ev-attachment; - - - - + + &ev-document-factory; + &ev-document; + &ev-document-find; + &ev-document-fonts; + &ev-document-images; + &ev-document-info; + &ev-document-links; + &ev-document-misc; + &ev-document-security; + &ev-document-thumbnails; + &ev-document-transition; + + + + <phrase>Document data</phrase> + + + + Helper objects related to document like attachments, links and images. + + + &ev-attachment; + &ev-link; + &ev-link-action; + &ev-link-dest; + &ev-image; + &ev-render-context; + &ev-selection; + + + + <phrase>Helper functions</phrase> + + + + Helper functions common for backend implementation + + + &ev-async-renderer; + &ev-file-exporter; + &ev-file-helpers; + + + + <phrase>Evince Frontend</phrase> + + Evince internals are rather simple. There are an application singleton that maintains list of windows and provides common services, each window shows loaded document, it has menus sidebar, toolbar and main view. - - - &ev-window; - Main window class - &ev-view; - View for document - &ev-page-cache; - Document page cache - - + + &ev-history; + &ev-job-queue; + &ev-jobs; + &ev-metadata-manager; + &ev-navigation-action; + &ev-navigation-action-widget; + &ev-page-action; + &ev-page-action-widget; + &ev-page-cache; + &ev-password-view; + &ev-password; + &ev-pixbuf-cache; + &ev-print-job; + &ev-properties-dialog; + &ev-properties-fonts; + &ev-sidebar-attachments; + &ev-sidebar-links; + &ev-sidebar-page; + &ev-sidebar-thumbnails; + &ev-sidebar; + &ev-stock-icons; + &ev-tooltip; + &ev-utils; + &ev-view-accessible; + &ev-view; + &ev-window-title; + &ev-window; + + diff --git a/help/reference/evince.types b/help/reference/evince.types index c3ca8615..015fb1c4 100644 --- a/help/reference/evince.types +++ b/help/reference/evince.types @@ -1,14 +1,39 @@ -#include "ev-window.h" -#include "ev-document.h" +#include "ev-application.h" +#include "ev-async-renderer.h" #include "ev-attachment.h" +#include "ev-document-find.h" +#include "ev-document.h" +#include "ev-document-links.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-page-cache.h" -#include "ev-application.h" #include "ev-view.h" #include "ev-view-private.h" +#include "ev-window.h" -ev_window_get_type -ev_document_get_type +ev_application_get_type +ev_async_renderer_get_type ev_attachment_get_type +ev_document_find_get_type +ev_document_get_type +ev_document_links_get_type +ev_job_fonts_get_type +ev_job_links_get_type +ev_job_load_get_type +ev_job_print_get_type +ev_job_render_get_type +ev_job_thumbnail_get_type +ev_link_action_get_type +ev_link_dest_get_type +ev_navigation_action_get_type +ev_navigation_action_widget_get_type +ev_navigation_action_widget_get_type +ev_page_action_get_type +ev_page_action_widget_get_type +ev_page_action_widget_get_type ev_page_cache_get_type -ev_application_get_type +ev_view_accessible_factory_get_type ev_view_get_type +ev_window_get_type -- 2.43.5