eog r4555 - in trunk: . doc doc/reference



Author: csaavedra
Date: Tue Apr 29 22:19:40 2008
New Revision: 4555
URL: http://svn.gnome.org/viewvc/eog?rev=4555&view=rev

Log:
2008-04-29  Claudio Saavedra  <csaavedra gnome org>

	* Makefile.am: Add doc to SUBDIRS and --enable-gtk-doc to 
	DISTCHECK_CONFIGURE_FLAGS.
	* autogen.sh: Check for gtk-doc.
	* configure.ac: Add GTK_DOC_CHECK and new generated files to 
	AC_CONFIG_FILES.
	* doc/Makefile.am: New file.
	* doc/reference/Makefile.am: Reference documentation.
	* doc/reference/eog-docs.sgml:
	* doc/reference/eog-sections.txt:
	* doc/reference/eog.types:
	* doc/reference/version.xml.in:

	Add API reference for plugins developers. Fixes bug #526352.



Added:
   trunk/doc/
   trunk/doc/Makefile.am
   trunk/doc/reference/
   trunk/doc/reference/Makefile.am
   trunk/doc/reference/eog-docs.sgml
   trunk/doc/reference/eog-sections.txt
   trunk/doc/reference/eog.types
   trunk/doc/reference/version.xml.in
Modified:
   trunk/ChangeLog
   trunk/Makefile.am
   trunk/autogen.sh
   trunk/configure.ac

Modified: trunk/Makefile.am
==============================================================================
--- trunk/Makefile.am	(original)
+++ trunk/Makefile.am	Tue Apr 29 22:19:40 2008
@@ -2,7 +2,7 @@
 jpeg_DIRS = jpegutils
 endif
 
-SUBDIRS = $(jpeg_DIRS) cut-n-paste bindings src plugins po help data
+SUBDIRS = $(jpeg_DIRS) cut-n-paste bindings src plugins po help data doc
 
 EXTRA_DIST = 			\
 	HACKING			\
@@ -20,7 +20,7 @@
         intltool-update         \
 	gnome-doc-utils.make
 
-DISTCHECK_CONFIGURE_FLAGS = --disable-schemas-install --disable-scrollkeeper
+DISTCHECK_CONFIGURE_FLAGS = --disable-schemas-install --disable-scrollkeeper --enable-gtk-doc
 
 # Ignore scrollkeeper issues for now.  @#*$& scrollkeeper
 distuninstallcheck_listfiles = find . -type f -print | grep -v scrollkeeper | grep -v /share/gnome/help/ | grep -v \.omf

Modified: trunk/autogen.sh
==============================================================================
--- trunk/autogen.sh	(original)
+++ trunk/autogen.sh	Tue Apr 29 22:19:40 2008
@@ -17,6 +17,11 @@
     exit 1
 }
 
+gtkdocize || {
+    echo "You are missing gtk-doc. Please install it"
+    exit 1
+}
+
 REQUIRED_AUTOCONF_VERSION=2.59
 REQUIRED_AUTOMAKE_VERSION=1.7
 REQUIRED_INTLTOOL_VERSION=0.35.0

Modified: trunk/configure.ac
==============================================================================
--- trunk/configure.ac	(original)
+++ trunk/configure.ac	Tue Apr 29 22:19:40 2008
@@ -36,6 +36,8 @@
 AC_PATH_PROG([GLIB_GENMARSHAL], [glib-genmarshal])
 AC_PATH_PROG([GLIB_MKENUMS],[glib-mkenums])
 
+GTK_DOC_CHECK(1.9)
+
 AC_CHECK_FUNCS(strptime)
 
 # ****************************************************************
@@ -388,6 +390,9 @@
 data/icons/scalable/Makefile
 data/icons/scalable/actions/Makefile
 data/icons/scalable/apps/Makefile
+doc/Makefile
+doc/reference/Makefile
+doc/reference/version.xml
 plugins/Makefile
 plugins/reload/Makefile
 plugins/fullscreen/Makefile

Added: trunk/doc/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/doc/Makefile.am	Tue Apr 29 22:19:40 2008
@@ -0,0 +1,2 @@
+SUBDIRS = \
+	reference

Added: trunk/doc/reference/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/doc/reference/Makefile.am	Tue Apr 29 22:19:40 2008
@@ -0,0 +1,119 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# 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=eog
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# 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=../../src
+
+# 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
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# 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=
+
+# 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)/src/*.h
+CFILE_GLOB=$(top_srcdir)/src/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES= \
+	eog-python-plugin.h \
+	eog-image-private.h \
+	eog-image-jpeg.h \
+	eog-marshal.h \
+	eog-application-service.h \
+	eog-enum-types.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=
+
+# 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES= \
+	-I$(top_srcdir)		\
+	-I$(top_builddir)	\
+	-I$(top_srcdir)/src	\
+	-I$(top_srcdir)/plugins \
+	-I$(top_srcdir)/jpegutils				\
+	-I$(top_srcdir)/cut-n-paste/toolbar-editor		\
+	-I$(top_srcdir)/cut-n-paste/totem-screensaver		\
+	$(EOG_CFLAGS)
+
+if ENABLE_PYTHON
+BINDING_LIBS = $(top_builddir)/bindings/python/eog.la
+MORE_GTKDOC_LIBS = $(PYTHON_LIBS)
+endif
+
+if ENABLE_JPEG
+jpeg_LIB = -L$(top_builddir)/jpegutils -leog-jpegutils
+endif
+
+GTKDOC_LIBS=\
+	$(top_builddir)/src/libeog.la 	\
+	-L$(top_builddir)/cut-n-paste/toolbar-editor -ltoolbareditor \
+	-L$(top_builddir)/cut-n-paste/totem-screensaver -ltotemscrsaver \
+	$(BINDING_LIBS)			\
+	$(LIBJPEG)			\
+	$(X_LIBS)			\
+	$(EOG_LIBS)			\
+	$(jpeg_LIB)			\
+	$(MORE_GTKDOC_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'
+#TESTS = $(GTKDOC_CHECK)

Added: trunk/doc/reference/eog-docs.sgml
==============================================================================
--- (empty file)
+++ trunk/doc/reference/eog-docs.sgml	Tue Apr 29 22:19:40 2008
@@ -0,0 +1,84 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
+  <bookinfo>
+    <title>Eye of GNOME Reference Manual</title>
+    <releaseinfo>
+      for Eye of GNOME &version;
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>User Interface</title>
+    <xi:include href="xml/eog-properties-dialog.xml"/>
+    <xi:include href="xml/eog-list-store.xml"/>
+    <xi:include href="xml/eog-file-chooser.xml"/>
+    <xi:include href="xml/eog-thumb-nav.xml"/>
+    <xi:include href="xml/eog-thumb-view.xml"/>
+    <xi:include href="xml/eog-scroll-view.xml"/>
+    <xi:include href="xml/eog-window.xml"/>
+    <xi:include href="xml/eog-statusbar.xml"/>
+    <xi:include href="xml/eog-exif-details.xml"/>
+    <xi:include href="xml/eog-message-area.xml"/>
+    <xi:include href="xml/eog-dialog.xml"/>
+    <xi:include href="xml/eog-sidebar.xml"/>
+    <xi:include href="xml/eog-thumbnail.xml"/>
+    <xi:include href="xml/eog-save-as-dialog-helper.xml"/>
+    <xi:include href="xml/eog-pixbuf-cell-renderer.xml"/>
+    <xi:include href="xml/eog-error-message-area.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Image data and manipulation</title>
+    <xi:include href="xml/eog-image.xml"/>
+    <xi:include href="xml/eog-image-save-info.xml"/>
+    <xi:include href="xml/eog-transform.xml"/>
+    <xi:include href="xml/eog-metadata-reader.xml"/>
+    <xi:include href="xml/eog-metadata-reader-png.xml"/>
+    <xi:include href="xml/eog-metadata-reader-jpg.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Printing</title>
+    <xi:include href="xml/eog-print-preview.xml"/>
+    <xi:include href="xml/eog-print-image-setup.xml"/>
+    <xi:include href="xml/eog-print.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Application and configuration</title>
+    <xi:include href="xml/eog-preferences-dialog.xml"/>
+    <xi:include href="xml/eog-application.xml"/>
+    <xi:include href="xml/eog-session.xml"/>
+    <xi:include href="xml/eog-config-keys.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Plugins</title>
+    <xi:include href="xml/eog-python-module.xml"/>
+    <xi:include href="xml/eog-module.xml"/>
+    <xi:include href="xml/eog-plugin.xml"/>
+    <xi:include href="xml/eog-plugin-manager.xml"/>
+    <xi:include href="xml/eog-plugin-engine.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Utilities</title>
+    <xi:include href="xml/eog-debug.xml"/>
+    <xi:include href="xml/eog-uri-converter.xml"/>
+    <xi:include href="xml/eog-util.xml"/>
+    <xi:include href="xml/eog-exif-util.xml"/>
+    <xi:include href="xml/eog-pixbuf-util.xml"/>
+    <xi:include href="xml/zoom.xml"/>
+    <xi:include href="xml/uta.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Asynchronous jobs</title>
+    <xi:include href="xml/eog-jobs.xml"/>
+    <xi:include href="xml/eog-job-queue.xml"/>
+  </chapter>
+</book>

Added: trunk/doc/reference/eog-sections.txt
==============================================================================
--- (empty file)
+++ trunk/doc/reference/eog-sections.txt	Tue Apr 29 22:19:40 2008
@@ -0,0 +1,853 @@
+<SECTION>
+<FILE>eog-image</FILE>
+EogImagePrivate
+EogImageData
+EOG_IMAGE_DATA_ALL
+EogImageError
+EOG_IMAGE_ERROR
+EogImageStatus
+<TITLE>EogImage</TITLE>
+EogImage
+eog_image_error_quark
+eog_image_new
+eog_image_new_file
+eog_image_load
+eog_image_cancel_load
+eog_image_has_data
+eog_image_data_ref
+eog_image_data_unref
+eog_image_set_thumbnail
+eog_image_save_as_by_info
+eog_image_save_by_info
+eog_image_get_pixbuf
+eog_image_get_thumbnail
+eog_image_get_size
+eog_image_get_bytes
+eog_image_is_modified
+eog_image_modified
+eog_image_get_caption
+eog_image_get_collate_key
+eog_image_get_exif_info
+eog_image_get_xmp_info
+eog_image_get_file
+eog_image_get_uri_for_display
+eog_image_get_status
+eog_image_transform
+eog_image_autorotate
+eog_image_get_profile
+eog_image_apply_display_profile
+eog_image_undo
+eog_image_get_supported_mime_types
+eog_image_is_supported_mime_type
+<SUBSECTION Standard>
+EOG_IMAGE
+EOG_IS_IMAGE
+EOG_TYPE_IMAGE
+eog_image_get_type
+EOG_IMAGE_CLASS
+EOG_IS_IMAGE_CLASS
+EOG_IMAGE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-preferences-dialog</FILE>
+EogPreferencesDialogPrivate
+<TITLE>EogPreferencesDialog</TITLE>
+EogPreferencesDialog
+eog_preferences_dialog_get_instance
+<SUBSECTION Standard>
+EOG_PREFERENCES_DIALOG
+EOG_IS_PREFERENCES_DIALOG
+EOG_TYPE_PREFERENCES_DIALOG
+eog_preferences_dialog_get_type
+EOG_PREFERENCES_DIALOG_CLASS
+EOG_IS_PREFERENCES_DIALOG_CLASS
+EOG_PREFERENCES_DIALOG_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-python-module</FILE>
+EogPythonModulePrivate
+<TITLE>EogPythonModule</TITLE>
+EogPythonModule
+eog_python_module_new
+eog_python_module_new_object
+eog_python_init
+eog_python_shutdown
+eog_python_garbage_collect
+<SUBSECTION Standard>
+EOG_PYTHON_MODULE
+EOG_IS_PYTHON_MODULE
+EOG_TYPE_PYTHON_MODULE
+eog_python_module_get_type
+EOG_PYTHON_MODULE_CLASS
+EOG_IS_PYTHON_MODULE_CLASS
+EOG_PYTHON_MODULE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-list-store</FILE>
+EogListStorePrivate
+EOG_LIST_STORE_THUMB_SIZE
+EogListStoreColumn
+<TITLE>EogListStore</TITLE>
+EogListStore
+eog_list_store_new
+eog_list_store_new_from_glist
+eog_list_store_append_image
+eog_list_store_add_files
+eog_list_store_remove_image
+eog_list_store_get_pos_by_image
+eog_list_store_get_image_by_pos
+eog_list_store_get_pos_by_iter
+eog_list_store_length
+eog_list_store_get_initial_pos
+eog_list_store_thumbnail_set
+eog_list_store_thumbnail_unset
+eog_list_store_thumbnail_refresh
+<SUBSECTION Standard>
+EOG_LIST_STORE
+EOG_IS_LIST_STORE
+EOG_TYPE_LIST_STORE
+eog_list_store_get_type
+EOG_LIST_STORE_CLASS
+EOG_IS_LIST_STORE_CLASS
+EOG_LIST_STORE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-print-preview</FILE>
+EogPrintPreviewPrivate
+<TITLE>EogPrintPreview</TITLE>
+EogPrintPreview
+eog_print_preview_new
+eog_print_preview_new_with_pixbuf
+eog_print_preview_set_page_margins
+eog_print_preview_set_from_page_setup
+eog_print_preview_get_image_position
+eog_print_preview_set_image_position
+eog_print_preview_set_scale
+<SUBSECTION Standard>
+EOG_PRINT_PREVIEW
+EOG_IS_PRINT_PREVIEW
+EOG_TYPE_PRINT_PREVIEW
+eog_print_preview_get_type
+EOG_PRINT_PREVIEW_CLASS
+EOG_IS_PRINT_PREVIEW_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-transform</FILE>
+EogTransformType
+EogTransformPrivate
+<TITLE>EogTransform</TITLE>
+EogTransform
+eog_transform_apply
+eog_transform_reverse
+eog_transform_compose
+eog_transform_is_identity
+eog_transform_identity_new
+eog_transform_rotate_new
+eog_transform_flip_new
+eog_transform_scale_new
+eog_transform_new
+eog_transform_get_transform_type
+<SUBSECTION Standard>
+EOG_TRANSFORM
+EOG_IS_TRANSFORM
+EOG_TYPE_TRANSFORM
+eog_transform_get_type
+EOG_TRANSFORM_CLASS
+EOG_IS_TRANSFORM_CLASS
+EOG_TRANSFORM_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-file-chooser</FILE>
+EogFileChooserPrivate
+<TITLE>EogFileChooser</TITLE>
+EogFileChooser
+eog_file_chooser_new
+eog_file_chooser_get_format
+<SUBSECTION Standard>
+EOG_FILE_CHOOSER
+EOG_IS_FILE_CHOOSER
+EOG_TYPE_FILE_CHOOSER
+eog_file_chooser_get_type
+EOG_FILE_CHOOSER_CLASS
+EOG_IS_FILE_CHOOSER_CLASS
+EOG_FILE_CHOOSER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-metadata-reader</FILE>
+EOG_METADATA_READER_GET_INTERFACE
+EogMetadataReader
+EogMetadataReaderInterface
+EogMetadataFileType
+eog_metadata_reader_new
+eog_metadata_reader_consume
+eog_metadata_reader_finished
+eog_metadata_reader_get_exif_chunk
+eog_metadata_reader_get_exif_data
+eog_metadata_reader_get_xmp_data
+eog_metadata_reader_get_iptc_chunk
+eog_metadata_reader_get_iptc_data
+eog_metadata_reader_get_icc_profile
+<SUBSECTION Standard>
+EOG_METADATA_READER
+EOG_IS_METADATA_READER
+EOG_TYPE_METADATA_READER
+eog_metadata_reader_get_type
+</SECTION>
+
+<SECTION>
+<FILE>eog-module</FILE>
+EogModulePrivate
+<TITLE>EogModule</TITLE>
+EogModule
+eog_module_new
+eog_module_get_path
+eog_module_new_object
+<SUBSECTION Standard>
+EOG_MODULE
+EOG_IS_MODULE
+EOG_TYPE_MODULE
+eog_module_get_type
+EOG_MODULE_CLASS
+EOG_IS_MODULE_CLASS
+EOG_MODULE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-properties-dialog</FILE>
+EogPropertiesDialogPrivate
+EogPropertiesDialogPage
+<TITLE>EogPropertiesDialog</TITLE>
+EogPropertiesDialog
+eog_properties_dialog_new
+eog_properties_dialog_update
+eog_properties_dialog_set_page
+<SUBSECTION Standard>
+EOG_PROPERTIES_DIALOG
+EOG_IS_PROPERTIES_DIALOG
+EOG_TYPE_PROPERTIES_DIALOG
+eog_properties_dialog_get_type
+EOG_PROPERTIES_DIALOG_CLASS
+EOG_IS_PROPERTIES_DIALOG_CLASS
+EOG_PROPERTIES_DIALOG_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-jobs</FILE>
+EOG_TYPE_JOB_THUMBNAIL
+EOG_JOB_THUMBNAIL
+EOG_JOB_THUMBNAIL_CLASS
+EOG_IS_JOB_THUMBNAIL
+EOG_TYPE_JOB_LOAD
+EOG_JOB_LOAD
+EOG_JOB_LOAD_CLASS
+EOG_IS_JOB_LOAD
+EOG_TYPE_JOB_MODEL
+EOG_JOB_MODEL
+EOG_JOB_MODEL_CLASS
+EOG_IS_JOB_MODEL
+EOG_TYPE_JOB_TRANSFORM
+EOG_JOB_TRANSFORM
+EOG_JOB_TRANSFORM_CLASS
+EOG_IS_JOB_TRANSFORM
+EOG_TYPE_JOB_SAVE
+EOG_JOB_SAVE
+EOG_JOB_SAVE_CLASS
+EOG_IS_JOB_SAVE
+EOG_JOB_SAVE_GET_CLASS
+EOG_TYPE_JOB_SAVE_AS
+EOG_JOB_SAVE_AS
+EOG_JOB_SAVE_AS_CLASS
+EOG_IS_JOB_SAVE_AS
+<TITLE>EogJob</TITLE>
+EogJob
+<TITLE>EogJobThumbnail</TITLE>
+EogJobThumbnail
+<TITLE>EogJobLoad</TITLE>
+EogJobLoad
+<TITLE>EogJobModel</TITLE>
+EogJobModel
+<TITLE>EogJobTransform</TITLE>
+EogJobTransform
+EogJobSaveResponse
+<TITLE>EogJobSave</TITLE>
+EogJobSave
+<TITLE>EogJobSaveAs</TITLE>
+EogJobSaveAs
+eog_job_finished
+eog_job_set_progress
+eog_job_thumbnail_get_type
+eog_job_thumbnail_new
+eog_job_thumbnail_run
+eog_job_load_get_type
+eog_job_load_new
+eog_job_load_run
+eog_job_model_get_type
+eog_job_model_new
+eog_job_model_run
+eog_job_transform_get_type
+eog_job_transform_new
+eog_job_transform_run
+eog_job_save_get_type
+eog_job_save_new
+eog_job_save_run
+eog_job_save_as_get_type
+eog_job_save_as_new
+<SUBSECTION Standard>
+EOG_JOB
+EOG_IS_JOB
+EOG_TYPE_JOB
+eog_job_get_type
+EOG_JOB_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-thumb-nav</FILE>
+EogThumbNavPrivate
+EogThumbNavMode
+<TITLE>EogThumbNav</TITLE>
+EogThumbNav
+eog_thumb_nav_new
+eog_thumb_nav_get_show_buttons
+eog_thumb_nav_set_show_buttons
+eog_thumb_nav_get_mode
+eog_thumb_nav_set_mode
+<SUBSECTION Standard>
+EOG_THUMB_NAV
+EOG_IS_THUMB_NAV
+EOG_TYPE_THUMB_NAV
+eog_thumb_nav_get_type
+EOG_THUMB_NAV_CLASS
+EOG_IS_THUMB_NAV_CLASS
+EOG_THUMB_NAV_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-metadata-reader-png</FILE>
+EogMetadataReaderPngPrivate
+<TITLE>EogMetadataReaderPng</TITLE>
+EogMetadataReaderPng
+<SUBSECTION Standard>
+EOG_METADATA_READER_PNG
+EOG_IS_METADATA_READER_PNG
+EOG_TYPE_METADATA_READER_PNG
+eog_metadata_reader_png_get_type
+EOG_METADATA_READER_PNG_CLASS
+EOG_IS_METADATA_READER_PNG_CLASS
+EOG_METADATA_READER_PNG_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-uri-converter</FILE>
+EogURIConverterPrivate
+EogUCType
+EogUCInfo
+EogUCError
+EOG_UC_ERROR
+<TITLE>EogURIConverter</TITLE>
+EogURIConverter
+eog_uc_error_quark
+eog_uri_converter_new
+eog_uri_converter_check
+eog_uri_converter_requires_exif
+eog_uri_converter_do
+eog_uri_converter_preview
+eog_uri_converter_print_list
+<SUBSECTION Standard>
+EOG_URI_CONVERTER
+EOG_IS_URI_CONVERTER
+EOG_TYPE_URI_CONVERTER
+eog_uri_converter_get_type
+EOG_URI_CONVERTER_CLASS
+EOG_IS_URI_CONVERTER_CLASS
+EOG_URI_CONVERTER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-print-image-setup</FILE>
+EogPrintImageSetupPrivate
+<TITLE>EogPrintImageSetup</TITLE>
+EogPrintImageSetup
+eog_print_image_setup_new
+eog_print_image_setup_get_options
+<SUBSECTION Standard>
+EOG_PRINT_IMAGE_SETUP
+EOG_IS_PRINT_IMAGE_SETUP
+EOG_TYPE_PRINT_IMAGE_SETUP
+eog_print_image_setup_get_type
+EOG_PRINT_IMAGE_SETUP_CLASS
+EOG_IS_PRINT_IMAGE_SETUP_CLASS
+EOG_PRINT_IMAGE_SETUP_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-thumb-view</FILE>
+EogThumbViewPrivate
+EogThumbViewSelectionChange
+<TITLE>EogThumbView</TITLE>
+EogThumbView
+eog_thumb_view_new
+eog_thumb_view_set_model
+eog_thumb_view_set_item_height
+eog_thumb_view_get_n_selected
+eog_thumb_view_get_first_selected_image
+eog_thumb_view_get_selected_images
+eog_thumb_view_select_single
+eog_thumb_view_set_current_image
+eog_thumb_view_set_thumbnail_popup
+<SUBSECTION Standard>
+EOG_THUMB_VIEW
+EOG_IS_THUMB_VIEW
+EOG_TYPE_THUMB_VIEW
+eog_thumb_view_get_type
+EOG_THUMB_VIEW_CLASS
+EOG_IS_THUMB_VIEW_CLASS
+EOG_THUMB_VIEW_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-plugin</FILE>
+EogPluginPrivate
+EOG_PLUGIN_CONST
+<TITLE>EogPlugin</TITLE>
+EogPlugin
+eog_plugin_activate
+eog_plugin_deactivate
+eog_plugin_update_ui
+eog_plugin_is_configurable
+eog_plugin_create_configure_dialog
+EOG_PLUGIN_REGISTER_TYPE_WITH_CODE
+EOG_PLUGIN_REGISTER_TYPE
+EOG_PLUGIN_DEFINE_TYPE_WITH_CODE
+EOG_PLUGIN_DEFINE_TYPE
+<SUBSECTION Standard>
+EOG_PLUGIN
+EOG_IS_PLUGIN
+EOG_TYPE_PLUGIN
+eog_plugin_get_type
+EOG_PLUGIN_CLASS
+EOG_IS_PLUGIN_CLASS
+EOG_PLUGIN_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-application</FILE>
+EogApplicationPrivate
+EOG_APP
+<TITLE>EogApplication</TITLE>
+EogApplication
+eog_application_get_instance
+eog_application_register_service
+eog_application_shutdown
+eog_application_open_window
+eog_application_open_uri_list
+eog_application_open_file_list
+eog_application_open_uris
+eog_application_get_windows
+eog_application_get_toolbars_model
+eog_application_save_toolbars_model
+eog_application_reset_toolbars_model
+eog_application_screensaver_enable
+eog_application_screensaver_disable
+<SUBSECTION Standard>
+EOG_APPLICATION
+EOG_IS_APPLICATION
+EOG_TYPE_APPLICATION
+eog_application_get_type
+EOG_APPLICATION_CLASS
+EOG_IS_APPLICATION_CLASS
+EOG_APPLICATION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-plugin-manager</FILE>
+EogPluginManagerPrivate
+<TITLE>EogPluginManager</TITLE>
+EogPluginManager
+eog_plugin_manager_new
+<SUBSECTION Standard>
+EOG_PLUGIN_MANAGER
+EOG_IS_PLUGIN_MANAGER
+EOG_TYPE_PLUGIN_MANAGER
+eog_plugin_manager_get_type
+EOG_PLUGIN_MANAGER_CLASS
+EOG_IS_PLUGIN_MANAGER_CLASS
+EOG_PLUGIN_MANAGER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-scroll-view</FILE>
+EogScrollViewPrivate
+<TITLE>EogScrollView</TITLE>
+EogScrollView
+EogTransparencyStyle
+eog_scroll_view_new
+eog_scroll_view_set_image
+eog_scroll_view_set_scroll_wheel_zoom
+eog_scroll_view_set_zoom_upscale
+eog_scroll_view_set_zoom_multiplier
+eog_scroll_view_set_antialiasing
+eog_scroll_view_set_transparency
+eog_scroll_view_scrollbars_visible
+eog_scroll_view_set_popup
+eog_scroll_view_zoom_in
+eog_scroll_view_zoom_out
+eog_scroll_view_zoom_fit
+eog_scroll_view_set_zoom
+eog_scroll_view_get_zoom
+eog_scroll_view_get_zoom_is_min
+eog_scroll_view_get_zoom_is_max
+eog_scroll_view_show_cursor
+eog_scroll_view_hide_cursor
+<SUBSECTION Standard>
+EOG_SCROLL_VIEW
+EOG_IS_SCROLL_VIEW
+EOG_TYPE_SCROLL_VIEW
+eog_scroll_view_get_type
+EOG_SCROLL_VIEW_CLASS
+EOG_IS_SCROLL_VIEW_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-window</FILE>
+EogWindowPrivate
+EOG_WINDOW_ERROR
+EogWindowMode
+EogWindowError
+EogStartupFlags
+<TITLE>EogWindow</TITLE>
+EogWindow
+eog_window_new
+eog_window_get_mode
+eog_window_set_mode
+eog_window_get_ui_manager
+eog_window_get_store
+eog_window_get_view
+eog_window_get_sidebar
+eog_window_get_thumb_view
+eog_window_get_thumb_nav
+eog_window_get_statusbar
+eog_window_get_image
+eog_window_open_file_list
+eog_window_is_empty
+<SUBSECTION Standard>
+EOG_WINDOW
+EOG_IS_WINDOW
+EOG_TYPE_WINDOW
+eog_window_get_type
+EOG_WINDOW_CLASS
+EOG_IS_WINDOW_CLASS
+EOG_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-statusbar</FILE>
+EogStatusbarPrivate
+<TITLE>EogStatusbar</TITLE>
+EogStatusbar
+eog_statusbar_new
+eog_statusbar_set_image_number
+eog_statusbar_set_progress
+eog_statusbar_set_has_resize_grip
+<SUBSECTION Standard>
+EOG_STATUSBAR
+EOG_IS_STATUSBAR
+EOG_TYPE_STATUSBAR
+eog_statusbar_get_type
+EOG_STATUSBAR_CLASS
+EOG_IS_STATUSBAR_CLASS
+EOG_STATUSBAR_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-exif-details</FILE>
+EogExifDetailsPrivate
+<TITLE>EogExifDetails</TITLE>
+EogExifDetails
+eog_exif_details_new
+eog_exif_details_update
+eog_exif_details_xmp_update
+<SUBSECTION Standard>
+EOG_EXIF_DETAILS
+EOG_IS_EXIF_DETAILS
+EOG_TYPE_EXIF_DETAILS
+eog_exif_details_get_type
+EOG_EXIF_DETAILS_CLASS
+EOG_IS_EXIF_DETAILS_CLASS
+EOG_EXIF_DETAILS_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-message-area</FILE>
+EogMessageAreaPrivate
+<TITLE>EogMessageArea</TITLE>
+EogMessageArea
+eog_message_area_new
+eog_message_area_new_with_buttons
+eog_message_area_set_contents
+eog_message_area_add_action_widget
+eog_message_area_add_button
+eog_message_area_add_stock_button_with_text
+eog_message_area_add_buttons
+eog_message_area_set_response_sensitive
+eog_message_area_set_default_response
+eog_message_area_response
+<SUBSECTION Standard>
+EOG_MESSAGE_AREA
+EOG_IS_MESSAGE_AREA
+EOG_TYPE_MESSAGE_AREA
+eog_message_area_get_type
+EOG_MESSAGE_AREA_CLASS
+EOG_IS_MESSAGE_AREA_CLASS
+EOG_MESSAGE_AREA_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-metadata-reader-jpg</FILE>
+EogMetadataReaderJpgPrivate
+<TITLE>EogMetadataReaderJpg</TITLE>
+EogMetadataReaderJpg
+<SUBSECTION Standard>
+EOG_METADATA_READER_JPG
+EOG_IS_METADATA_READER_JPG
+EOG_TYPE_METADATA_READER_JPG
+eog_metadata_reader_jpg_get_type
+EOG_METADATA_READER_JPG_CLASS
+EOG_IS_METADATA_READER_JPG_CLASS
+EOG_METADATA_READER_JPG_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-dialog</FILE>
+EogDialogPrivate
+<TITLE>EogDialog</TITLE>
+EogDialog
+eog_dialog_construct
+eog_dialog_show
+eog_dialog_hide
+eog_dialog_get_controls
+<SUBSECTION Standard>
+EOG_DIALOG
+EOG_IS_DIALOG
+EOG_TYPE_DIALOG
+eog_dialog_get_type
+EOG_DIALOG_CLASS
+EOG_IS_DIALOG_CLASS
+EOG_DIALOG_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-image-save-info</FILE>
+<TITLE>EogImageSaveInfo</TITLE>
+EogImageSaveInfo
+EOG_FILE_FORMAT_JPEG
+eog_image_save_info_from_image
+eog_image_save_info_from_uri
+eog_image_save_info_from_file
+<SUBSECTION Standard>
+EOG_IMAGE_SAVE_INFO
+EOG_IS_IMAGE_SAVE_INFO
+EOG_TYPE_IMAGE_SAVE_INFO
+eog_image_save_info_get_type
+EOG_IMAGE_SAVE_INFO_CLASS
+EOG_IS_IMAGE_SAVE_INFO_CLASS
+EOG_IMAGE_SAVE_INFO_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-sidebar</FILE>
+EogSidebarPrivate
+<TITLE>EogSidebar</TITLE>
+EogSidebar
+eog_sidebar_new
+eog_sidebar_add_page
+eog_sidebar_remove_page
+eog_sidebar_set_page
+eog_sidebar_get_n_pages
+eog_sidebar_is_empty
+<SUBSECTION Standard>
+EOG_SIDEBAR
+EOG_IS_SIDEBAR
+EOG_TYPE_SIDEBAR
+eog_sidebar_get_type
+EOG_SIDEBAR_CLASS
+EOG_IS_SIDEBAR_CLASS
+EOG_SIDEBAR_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>eog-thumbnail</FILE>
+eog_thumbnail_init
+eog_thumbnail_fit_to_size
+eog_thumbnail_add_frame
+eog_thumbnail_load
+EOG_THUMBNAIL_ORIGINAL_WIDTH
+EOG_THUMBNAIL_ORIGINAL_HEIGHT
+</SECTION>
+
+<SECTION>
+<FILE>eog-debug</FILE>
+EogDebugSection
+DEBUG_WINDOW
+DEBUG_VIEW
+DEBUG_JOBS
+DEBUG_THUMBNAIL
+DEBUG_IMAGE_DATA
+DEBUG_IMAGE_LOAD
+DEBUG_IMAGE_SAVE
+DEBUG_LIST_STORE
+DEBUG_PREFERENCES
+DEBUG_PRINTING
+DEBUG_LCMS
+DEBUG_PLUGINS
+eog_debug_init
+eog_debug
+eog_debug_message
+</SECTION>
+
+<SECTION>
+<FILE>eog-job-queue</FILE>
+eog_job_queue_init
+eog_job_queue_add_job
+eog_job_queue_remove_job
+</SECTION>
+
+<SECTION>
+<FILE>eog-exif-util</FILE>
+eog_exif_util_format_date
+eog_exif_util_get_value
+</SECTION>
+
+<SECTION>
+<FILE>eog-save-as-dialog-helper</FILE>
+eog_save_as_dialog_new
+eog_save_as_dialog_get_converter
+</SECTION>
+
+<SECTION>
+<FILE>zoom</FILE>
+zoom_fit_size
+zoom_fit_scale
+</SECTION>
+
+<SECTION>
+<FILE>eog-python-plugin</FILE>
+<TITLE>EogPythonPlugin</TITLE>
+EogPythonPlugin
+eog_python_plugin_get_type
+</SECTION>
+
+<SECTION>
+<FILE>eog-pixbuf-cell-renderer</FILE>
+<TITLE>EogPixbufCellRenderer</TITLE>
+EogPixbufCellRenderer
+eog_pixbuf_cell_renderer_get_type
+eog_pixbuf_cell_renderer_new
+</SECTION>
+
+<SECTION>
+<FILE>eog-plugin-engine</FILE>
+EogPluginInfo
+eog_plugin_engine_init
+eog_plugin_engine_shutdown
+eog_plugin_engine_garbage_collect
+eog_plugin_engine_get_plugins_list
+eog_plugin_engine_activate_plugin
+eog_plugin_engine_deactivate_plugin
+eog_plugin_engine_plugin_is_active
+eog_plugin_engine_plugin_is_available
+eog_plugin_engine_plugin_is_configurable
+eog_plugin_engine_configure_plugin
+eog_plugin_engine_update_plugins_ui
+eog_plugin_engine_get_plugin_name
+eog_plugin_engine_get_plugin_description
+eog_plugin_engine_get_plugin_icon_name
+eog_plugin_engine_get_plugin_authors
+eog_plugin_engine_get_plugin_website
+eog_plugin_engine_get_plugin_copyright
+</SECTION>
+
+<SECTION>
+<FILE>eog-pixbuf-util</FILE>
+eog_pixbuf_get_savable_formats
+eog_pixbuf_get_format_by_suffix
+eog_pixbuf_get_format
+eog_pixbuf_get_common_suffix
+</SECTION>
+
+<SECTION>
+<FILE>eog-config-keys</FILE>
+EOG_CONF_DIR
+EOG_CONF_DESKTOP_WALLPAPER
+EOG_CONF_DESKTOP_CAN_SAVE
+EOG_CONF_DESKTOP_CAN_PRINT
+EOG_CONF_DESKTOP_CAN_SETUP_PAGE
+EOG_CONF_VIEW_INTERPOLATE
+EOG_CONF_VIEW_SCROLL_WHEEL_ZOOM
+EOG_CONF_VIEW_ZOOM_MULTIPLIER
+EOG_CONF_VIEW_AUTOROTATE
+EOG_CONF_VIEW_TRANSPARENCY
+EOG_CONF_VIEW_TRANS_COLOR
+EOG_CONF_FULLSCREEN_LOOP
+EOG_CONF_FULLSCREEN_UPSCALE
+EOG_CONF_FULLSCREEN_SECONDS
+EOG_CONF_UI_TOOLBAR
+EOG_CONF_UI_STATUSBAR
+EOG_CONF_UI_IMAGE_COLLECTION
+EOG_CONF_UI_IMAGE_COLLECTION_POSITION
+EOG_CONF_UI_IMAGE_COLLECTION_RESIZABLE
+EOG_CONF_UI_SIDEBAR
+EOG_CONF_UI_SCROLL_BUTTONS
+EOG_CONF_PLUGINS_ACTIVE_PLUGINS
+</SECTION>
+
+<SECTION>
+<FILE>eog-error-message-area</FILE>
+eog_image_load_error_message_area_new
+eog_no_images_error_message_area_new
+</SECTION>
+
+<SECTION>
+<FILE>uta</FILE>
+uta_ensure_size
+uta_add_rect
+uta_remove_rect
+uta_find_first_glom_rect
+uta_copy_area
+</SECTION>
+
+<SECTION>
+<FILE>eog-session</FILE>
+eog_session_init
+eog_session_is_restored
+eog_session_load
+</SECTION>
+
+<SECTION>
+<FILE>eog-print</FILE>
+eog_print_operation_new
+eog_print_get_page_setup
+eog_print_set_page_setup
+eog_print_get_print_settings
+eog_print_set_print_settings
+</SECTION>
+
+<SECTION>
+<FILE>eog-util</FILE>
+eog_util_show_help
+eog_util_make_valid_utf8
+eog_util_parse_uri_string_list_to_file_list
+eog_util_string_list_to_file_list
+eog_util_strings_to_file_list
+eog_util_string_array_to_list
+eog_util_string_array_make_absolute
+eog_util_launch_desktop_file
+eog_util_dot_dir
+</SECTION>
+

Added: trunk/doc/reference/eog.types
==============================================================================
--- (empty file)
+++ trunk/doc/reference/eog.types	Tue Apr 29 22:19:40 2008
@@ -0,0 +1,35 @@
+eog_image_get_type
+eog_preferences_dialog_get_type
+eog_python_module_get_type
+eog_list_store_get_type
+eog_print_preview_get_type
+eog_transform_get_type
+eog_file_chooser_get_type
+eog_metadata_reader_get_type
+eog_module_get_type
+eog_properties_dialog_get_type
+eog_job_get_type
+eog_job_thumbnail_get_type
+eog_job_load_get_type
+eog_job_model_get_type
+eog_job_transform_get_type
+eog_job_save_get_type
+eog_job_save_as_get_type
+eog_thumb_nav_get_type
+eog_metadata_reader_png_get_type
+eog_uri_converter_get_type
+eog_print_image_setup_get_type
+eog_pixbuf_cell_renderer_get_type
+eog_thumb_view_get_type
+eog_plugin_get_type
+eog_application_get_type
+eog_plugin_manager_get_type
+eog_scroll_view_get_type
+eog_window_get_type
+eog_statusbar_get_type
+eog_exif_details_get_type
+eog_message_area_get_type
+eog_metadata_reader_jpg_get_type
+eog_dialog_get_type
+eog_image_save_info_get_type
+eog_sidebar_get_type

Added: trunk/doc/reference/version.xml.in
==============================================================================
--- (empty file)
+++ trunk/doc/reference/version.xml.in	Tue Apr 29 22:19:40 2008
@@ -0,0 +1 @@
+ VERSION@



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]