diff options
| author | Perberos <[email protected]> | 2011-11-06 19:30:49 -0300 |
|---|---|---|
| committer | Perberos <[email protected]> | 2011-11-06 19:30:49 -0300 |
| commit | a8d28a6ce7e0c56dacba5d527d9134573a008902 (patch) | |
| tree | 8852602004b5a13cc5d1ce3ecd7a314be81d1198 /doc/reference | |
| download | eom-a8d28a6ce7e0c56dacba5d527d9134573a008902.tar.bz2 eom-a8d28a6ce7e0c56dacba5d527d9134573a008902.tar.xz | |
inicial
Diffstat (limited to 'doc/reference')
46 files changed, 6300 insertions, 0 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am new file mode 100644 index 0000000..a796954 --- /dev/null +++ b/doc/reference/Makefile.am @@ -0,0 +1,127 @@ +## 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=eom + +# 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=--rebuild-types + +# 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= \ + eom-python-plugin.h \ + eom-image-private.h \ + eom-image-jpeg.h \ + eom-marshal.h \ + eom-application-service.h \ + eom-enum-types.h \ + eom-module.h \ + eom-python-module.h + +if !HAVE_EXIF +if !HAVE_EXEMPI +IGNORE_HFILES += \ + eom-exif-util.h \ + eom-exif-details.h +endif +endif + +# 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. 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 \ + $(EOM_CFLAGS) + +if ENABLE_JPEG +jpeg_LIB = $(top_builddir)/jpegutils/libeom-jpegutils.la +endif + +GTKDOC_LIBS=\ + $(top_builddir)/src/libeom.la \ + $(top_builddir)/cut-n-paste/toolbar-editor/libtoolbareditor.la \ + $(top_builddir)/cut-n-paste/totem-screensaver/libtotemscrsaver.la \ + $(BINDING_LIBS) \ + $(LIBJPEG) \ + $(X_LIBS) \ + $(EOM_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 \ + $(DOC_MODULE)-docs.sgml.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 = $(DOC_MODULE).types + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + +-include $(top_srcdir)/git.mk diff --git a/doc/reference/Makefile.in b/doc/reference/Makefile.in new file mode 100644 index 0000000..4be3032 --- /dev/null +++ b/doc/reference/Makefile.in @@ -0,0 +1,837 @@ +# Makefile.in generated by automake 1.11.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, +# Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# -*- mode: makefile -*- + +#################################### +# Everything below here is generic # +#################################### +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +@HAVE_EXEMPI_FALSE@@HAVE_EXIF_FALSE@am__append_1 = \ +@HAVE_EXEMPI_FALSE@@HAVE_EXIF_FALSE@ eom-exif-util.h \ +@HAVE_EXEMPI_FALSE@@HAVE_EXIF_FALSE@ eom-exif-details.h + +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(srcdir)/eom-docs.sgml.in $(srcdir)/version.xml.in \ + $(top_srcdir)/gtk-doc.make +subdir = doc/reference +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = version.xml eom-docs.sgml +CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_$(V)) +am__v_GEN_ = $(am__v_GEN_$(AM_DEFAULT_VERBOSITY)) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_$(V)) +am__v_at_ = $(am__v_at_$(AM_DEFAULT_VERBOSITY)) +am__v_at_0 = @ +SOURCES = +DIST_SOURCES = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ +ALL_LINGUAS = @ALL_LINGUAS@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CATALOGS = @CATALOGS@ +CATOBJEXT = @CATOBJEXT@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DATADIRNAME = @DATADIRNAME@ +DBUS_BINDING_TOOL = @DBUS_BINDING_TOOL@ +DBUS_CFLAGS = @DBUS_CFLAGS@ +DBUS_LIBS = @DBUS_LIBS@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DISABLE_DEPRECATED = @DISABLE_DEPRECATED@ +DISTCHECK_CONFIGURE_FLAGS = @DISTCHECK_CONFIGURE_FLAGS@ +DLLTOOL = @DLLTOOL@ +DOC_USER_FORMATS = @DOC_USER_FORMATS@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EOM_API_VERSION = @EOM_API_VERSION@ +EOM_CFLAGS = @EOM_CFLAGS@ +EOM_DOC_EXIF_START = @EOM_DOC_EXIF_START@ +EOM_DOC_EXIF_STOP = @EOM_DOC_EXIF_STOP@ +EOM_LIBS = @EOM_LIBS@ +EOM_MAJOR_VERSION = @EOM_MAJOR_VERSION@ +EOM_MICRO_VERSION = @EOM_MICRO_VERSION@ +EOM_MINOR_VERSION = @EOM_MINOR_VERSION@ +EXEEXT = @EXEEXT@ +EXEMPI_CFLAGS = @EXEMPI_CFLAGS@ +EXEMPI_LIBS = @EXEMPI_LIBS@ +EXIF_CFLAGS = @EXIF_CFLAGS@ +EXIF_LIBS = @EXIF_LIBS@ +FGREP = @FGREP@ +GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GMOFILES = @GMOFILES@ +GMSGFMT = @GMSGFMT@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +HELP_DIR = @HELP_DIR@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INSTOBJEXT = @INSTOBJEXT@ +INTLLIBS = @INTLLIBS@ +INTLTOOL_EXTRACT = @INTLTOOL_EXTRACT@ +INTLTOOL_MERGE = @INTLTOOL_MERGE@ +INTLTOOL_PERL = @INTLTOOL_PERL@ +INTLTOOL_UPDATE = @INTLTOOL_UPDATE@ +LCMS_CFLAGS = @LCMS_CFLAGS@ +LCMS_LIBS = @LCMS_LIBS@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBJPEG = @LIBJPEG@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIBXML2_CFLAGS = @LIBXML2_CFLAGS@ +LIBXML2_LIBS = @LIBXML2_LIBS@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MATECONFTOOL = @MATECONFTOOL@ +MATECONF_SCHEMA_CONFIG_SOURCE = @MATECONF_SCHEMA_CONFIG_SOURCE@ +MATECONF_SCHEMA_FILE_DIR = @MATECONF_SCHEMA_FILE_DIR@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGFMT_OPTS = @MSGFMT_OPTS@ +MSGMERGE = @MSGMERGE@ +NM = @NM@ +NMEDIT = @NMEDIT@ +NO_STRICT_ALIASING_CFLAGS = @NO_STRICT_ALIASING_CFLAGS@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OMF_DIR = @OMF_DIR@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +POFILES = @POFILES@ +POSUB = @POSUB@ +PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@ +PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@ +PYGOBJECT_CODEGEN = @PYGOBJECT_CODEGEN@ +PYGOBJECT_DEFSDIR = @PYGOBJECT_DEFSDIR@ +PYGOBJECT_H2DEF = @PYGOBJECT_H2DEF@ +PYGTK_CFLAGS = @PYGTK_CFLAGS@ +PYGTK_DEFSDIR = @PYGTK_DEFSDIR@ +PYGTK_LIBS = @PYGTK_LIBS@ +PYTHON = @PYTHON@ +PYTHON_CFLAGS = @PYTHON_CFLAGS@ +PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@ +PYTHON_EXTRA_LIBS = @PYTHON_EXTRA_LIBS@ +PYTHON_LIBS = @PYTHON_LIBS@ +PYTHON_LIB_LOC = @PYTHON_LIB_LOC@ +PYTHON_PLATFORM = @PYTHON_PLATFORM@ +PYTHON_PREFIX = @PYTHON_PREFIX@ +PYTHON_VERSION = @PYTHON_VERSION@ +RANLIB = @RANLIB@ +RSVG_CFLAGS = @RSVG_CFLAGS@ +RSVG_LIBS = @RSVG_LIBS@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +WARN_CFLAGS = @WARN_CFLAGS@ +X11_CFLAGS = @X11_CFLAGS@ +X11_LIBS = @X11_LIBS@ +XGETTEXT = @XGETTEXT@ +XMKMF = @XMKMF@ +X_CFLAGS = @X_CFLAGS@ +X_EXTRA_LIBS = @X_EXTRA_LIBS@ +X_LIBS = @X_LIBS@ +X_PRE_LIBS = @X_PRE_LIBS@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +pkgpyexecdir = @pkgpyexecdir@ +pkgpythondir = @pkgpythondir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +pyexecdir = @pyexecdir@ +pythondir = @pythondir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ + +# 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 = eom + +# 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 = --rebuild-types + +# 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 = eom-python-plugin.h eom-image-private.h \ + eom-image-jpeg.h eom-marshal.h eom-application-service.h \ + eom-enum-types.h eom-module.h eom-python-module.h \ + $(am__append_1) + +# 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. 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 \ + $(EOM_CFLAGS) + +@ENABLE_JPEG_TRUE@jpeg_LIB = $(top_builddir)/jpegutils/libeom-jpegutils.la +GTKDOC_LIBS = \ + $(top_builddir)/src/libeom.la \ + $(top_builddir)/cut-n-paste/toolbar-editor/libtoolbareditor.la \ + $(top_builddir)/cut-n-paste/totem-screensaver/libtotemscrsaver.la \ + $(BINDING_LIBS) \ + $(LIBJPEG) \ + $(X_LIBS) \ + $(EOM_LIBS) \ + $(jpeg_LIB) \ + $(MORE_GTKDOC_LIBS) + +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_RUN = +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_RUN = $(LIBTOOL) --mode=execute + +# We set GPATH here; this gives us semantics for GNU make +# which are more like other make's VPATH, when it comes to +# whether a source that is a target of one rule is then +# searched for in VPATH/GPATH. +# +GPATH = $(srcdir) +TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE) +SETUP_FILES = \ + $(content_files) \ + $(DOC_MAIN_SGML_FILE) \ + $(DOC_MODULE)-sections.txt \ + $(DOC_MODULE)-overrides.txt + + +# This includes the standard gtk-doc make rules, copied by gtkdocize. + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) version.xml.in \ + $(DOC_MODULE)-docs.sgml.in +DOC_STAMPS = setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \ + html-build.stamp pdf-build.stamp \ + tmpl.stamp sgml.stamp html.stamp pdf.stamp + +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).interfaces \ + $(DOC_MODULE).prerequisites \ + $(DOC_MODULE).signals + +REPORT_FILES = \ + $(DOC_MODULE)-undocumented.txt \ + $(DOC_MODULE)-undeclared.txt \ + $(DOC_MODULE)-unused.txt + +CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_FALSE@HTML_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_TRUE@HTML_BUILD_STAMP = html-build.stamp +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_FALSE@PDF_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_TRUE@PDF_BUILD_STAMP = pdf-build.stamp + +# 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 = $(DOC_MODULE).types +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(top_srcdir)/gtk-doc.make $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign doc/reference/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign doc/reference/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +version.xml: $(top_builddir)/config.status $(srcdir)/version.xml.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ +eom-docs.sgml: $(top_builddir)/config.status $(srcdir)/eom-docs.sgml.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-hook +check-am: all-am +check: check-am +all-am: Makefile all-local +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + -test -z "$(DISTCLEANFILES)" || rm -f $(DISTCLEANFILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool clean-local mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-local + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-data-local + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic \ + maintainer-clean-local + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-local + +.MAKE: install-am install-strip + +.PHONY: all all-am all-local check check-am clean clean-generic \ + clean-libtool clean-local dist-hook distclean \ + distclean-generic distclean-libtool distclean-local distdir \ + dvi dvi-am html html-am info info-am install install-am \ + install-data install-data-am install-data-local install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic \ + maintainer-clean-local mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-local + + +@ENABLE_GTK_DOC_TRUE@all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) +@ENABLE_GTK_DOC_FALSE@all-local: + +docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) + +$(REPORT_FILES): sgml-build.stamp + +#### setup #### + +setup-build.stamp: + -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + echo ' DOC Preparing build'; \ + files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \ + if test "x$$files" != "x" ; then \ + for file in $$files ; do \ + test -f $(abs_srcdir)/$$file && \ + cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \ + done; \ + fi; \ + test -d $(abs_srcdir)/tmpl && \ + { cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \ + chmod -R u+w $(abs_builddir)/tmpl; } \ + fi + @touch setup-build.stamp + +#### scan #### + +scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) + @echo ' DOC Scanning header files' + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES) + @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \ + echo " DOC Introspecting gobjects"; \ + scanobj_options=""; \ + gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + scanobj_options="--verbose"; \ + fi; \ + fi; \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \ + gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \ + else \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi + @touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp + @true + +#### templates #### + +tmpl-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt + @echo ' DOC Rebuilding template files' + @gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS) + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + if test -w $(abs_srcdir) ; then \ + cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \ + fi \ + fi + @touch tmpl-build.stamp + +tmpl.stamp: tmpl-build.stamp + @true + +$(srcdir)/tmpl/*.sgml: + @true + +#### xml #### + +sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files) + @echo ' DOC Building XML' + @-chmod -R u+w $(srcdir) + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS) + @touch sgml-build.stamp + +sgml.stamp: sgml-build.stamp + @true + +#### html #### + +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo ' DOC Building HTML' + @rm -rf html + @mkdir html + @mkhtml_options=""; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkhtml_options="$$mkhtml_options --verbose"; \ + fi; \ + fi; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \ + if test "$(?)" = "0"; then \ + mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \ + fi; \ + cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + -@test "x$(HTML_IMAGES)" = "x" || \ + for file in $(HTML_IMAGES) ; do \ + if test -f $(abs_srcdir)/$$file ; then \ + cp $(abs_srcdir)/$$file $(abs_builddir)/html; \ + fi; \ + if test -f $(abs_builddir)/$$file ; then \ + cp $(abs_builddir)/$$file $(abs_builddir)/html; \ + fi; \ + done; + @echo ' DOC Fixing cross-references' + @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + @touch html-build.stamp + +#### pdf #### + +pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo ' DOC Building PDF' + @rm -f $(DOC_MODULE).pdf + @mkpdf_options=""; \ + gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkpdf_options="$$mkpdf_options --verbose"; \ + fi; \ + fi; \ + if test "x$(HTML_IMAGES)" != "x"; then \ + for img in $(HTML_IMAGES); do \ + part=`dirname $$img`; \ + echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \ + if test $$? != 0; then \ + mkpdf_options="$$mkpdf_options --imgdir=$$part"; \ + fi; \ + done; \ + fi; \ + gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS) + @touch pdf-build.stamp + +############## + +clean-local: + @rm -f *~ *.bak + @rm -rf .libs + +distclean-local: + @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \ + $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \ + rm -rf tmpl; \ + fi + +maintainer-clean-local: clean + @rm -rf xml html + +install-data-local: + @installfiles=`echo $(builddir)/html/*`; \ + if test "$$installfiles" = '$(builddir)/html/*'; \ + then echo 1>&2 'Nothing to install' ; \ + else \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + $(mkinstalldirs) $${installdir} ; \ + for i in $$installfiles; do \ + echo ' $(INSTALL_DATA) '$$i ; \ + $(INSTALL_DATA) $$i $${installdir}; \ + done; \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + mv -f $${installdir}/$(DOC_MODULE).devhelp2 \ + $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \ + fi; \ + $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \ + fi + +uninstall-local: + @if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + rm -rf $${installdir} + +# +# Require gtk-doc when making dist +# +@ENABLE_GTK_DOC_TRUE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@ @echo "*** gtk-doc must be installed and enabled in order to make dist" +@ENABLE_GTK_DOC_FALSE@ @false + +dist-hook: dist-check-gtkdoc dist-hook-local + @mkdir $(distdir)/tmpl + @mkdir $(distdir)/html + @-cp ./tmpl/*.sgml $(distdir)/tmpl + @cp ./html/* $(distdir)/html + @-cp ./$(DOC_MODULE).pdf $(distdir)/ + @-cp ./$(DOC_MODULE).types $(distdir)/ + @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/ + @cd $(distdir) && rm -f $(DISTCLEANFILES) + @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html + +.PHONY : dist-hook-local docs + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + +-include $(top_srcdir)/git.mk + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/doc/reference/eom-docs.sgml.in b/doc/reference/eom-docs.sgml.in new file mode 100644 index 0000000..a8ceb0b --- /dev/null +++ b/doc/reference/eom-docs.sgml.in @@ -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 MATE Reference Manual</title> + <releaseinfo> + for Eye of MATE &version; + </releaseinfo> + </bookinfo> + + <chapter> + <title>User Interface</title> + <xi:include href="xml/eom-properties-dialog.xml"/> + <xi:include href="xml/eom-list-store.xml"/> + <xi:include href="xml/eom-file-chooser.xml"/> + <xi:include href="xml/eom-thumb-nav.xml"/> + <xi:include href="xml/eom-thumb-view.xml"/> + <xi:include href="xml/eom-scroll-view.xml"/> + <xi:include href="xml/eom-window.xml"/> + <xi:include href="xml/eom-statusbar.xml"/> + @EOM_DOC_EXIF_START@ + <xi:include href="xml/eom-exif-details.xml"/> + @EOM_DOC_EXIF_STOP@ + <xi:include href="xml/eom-dialog.xml"/> + <xi:include href="xml/eom-sidebar.xml"/> + <xi:include href="xml/eom-thumbnail.xml"/> + <xi:include href="xml/eom-save-as-dialog-helper.xml"/> + <xi:include href="xml/eom-error-message-area.xml"/> + </chapter> + + <chapter> + <title>Image data and manipulation</title> + <xi:include href="xml/eom-image.xml"/> + <xi:include href="xml/eom-image-save-info.xml"/> + <xi:include href="xml/eom-transform.xml"/> + <xi:include href="xml/eom-metadata-reader.xml"/> + <xi:include href="xml/eom-metadata-reader-png.xml"/> + <xi:include href="xml/eom-metadata-reader-jpg.xml"/> + </chapter> + + <chapter> + <title>Printing</title> + <xi:include href="xml/eom-print-preview.xml"/> + <xi:include href="xml/eom-print-image-setup.xml"/> + <xi:include href="xml/eom-print.xml"/> + </chapter> + + <chapter> + <title>Application and configuration</title> + <xi:include href="xml/eom-preferences-dialog.xml"/> + <xi:include href="xml/eom-application.xml"/> + <xi:include href="xml/eom-session.xml"/> + <xi:include href="xml/eom-config-keys.xml"/> + </chapter> + + <chapter> + <title>Plugins</title> + <xi:include href="xml/eom-plugin.xml"/> + <xi:include href="xml/eom-plugin-manager.xml"/> + <xi:include href="xml/eom-plugin-engine.xml"/> + </chapter> + + <chapter> + <title>Utilities</title> + <xi:include href="xml/eom-debug.xml"/> + <xi:include href="xml/eom-uri-converter.xml"/> + <xi:include href="xml/eom-util.xml"/> + @EOM_DOC_EXIF_START@ + <xi:include href="xml/eom-exif-util.xml"/> + @EOM_DOC_EXIF_STOP@ + <xi:include href="xml/eom-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/eom-jobs.xml"/> + <xi:include href="xml/eom-job-queue.xml"/> + </chapter> +</book> diff --git a/doc/reference/eom-overrides.txt b/doc/reference/eom-overrides.txt new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/doc/reference/eom-overrides.txt diff --git a/doc/reference/eom-sections.txt b/doc/reference/eom-sections.txt new file mode 100644 index 0000000..ffdba98 --- /dev/null +++ b/doc/reference/eom-sections.txt @@ -0,0 +1,758 @@ +<SECTION> +<FILE>eom-image</FILE> +EomImageData +EOM_IMAGE_DATA_ALL +EomImageError +EOM_IMAGE_ERROR +EomImageStatus +<TITLE>EomImage</TITLE> +EomImage +eom_image_error_quark +eom_image_new +eom_image_new_file +eom_image_load +eom_image_cancel_load +eom_image_has_data +eom_image_data_ref +eom_image_data_unref +eom_image_set_thumbnail +eom_image_save_as_by_info +eom_image_save_by_info +eom_image_get_pixbuf +eom_image_get_thumbnail +eom_image_get_size +eom_image_get_bytes +eom_image_is_modified +eom_image_modified +eom_image_get_caption +eom_image_get_collate_key +eom_image_get_exif_info +eom_image_get_xmp_info +eom_image_get_file +eom_image_get_uri_for_display +eom_image_get_status +eom_image_transform +eom_image_autorotate +eom_image_get_profile +eom_image_apply_display_profile +eom_image_undo +eom_image_get_supported_mime_types +eom_image_is_supported_mime_type +eom_image_file_changed +<SUBSECTION Standard> +EOM_IMAGE +EOM_IS_IMAGE +EOM_TYPE_IMAGE +eom_image_get_type +EOM_IMAGE_CLASS +EOM_IS_IMAGE_CLASS +EOM_IMAGE_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-preferences-dialog</FILE> +<TITLE>EomPreferencesDialog</TITLE> +EomPreferencesDialog +eom_preferences_dialog_get_instance +<SUBSECTION Standard> +EOM_PREFERENCES_DIALOG +EOM_IS_PREFERENCES_DIALOG +EOM_TYPE_PREFERENCES_DIALOG +eom_preferences_dialog_get_type +EOM_PREFERENCES_DIALOG_CLASS +EOM_IS_PREFERENCES_DIALOG_CLASS +EOM_PREFERENCES_DIALOG_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-list-store</FILE> +EOM_LIST_STORE_THUMB_SIZE +EomListStoreColumn +<TITLE>EomListStore</TITLE> +EomListStore +eom_list_store_new +eom_list_store_new_from_glist +eom_list_store_append_image +eom_list_store_add_files +eom_list_store_remove_image +eom_list_store_get_pos_by_image +eom_list_store_get_image_by_pos +eom_list_store_get_pos_by_iter +eom_list_store_length +eom_list_store_get_initial_pos +eom_list_store_thumbnail_set +eom_list_store_thumbnail_unset +eom_list_store_thumbnail_refresh +<SUBSECTION Standard> +EOM_LIST_STORE +EOM_IS_LIST_STORE +EOM_TYPE_LIST_STORE +eom_list_store_get_type +EOM_LIST_STORE_CLASS +EOM_IS_LIST_STORE_CLASS +EOM_LIST_STORE_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-print-preview</FILE> +<TITLE>EomPrintPreview</TITLE> +EomPrintPreview +eom_print_preview_new +eom_print_preview_new_with_pixbuf +eom_print_preview_set_page_margins +eom_print_preview_set_from_page_setup +eom_print_preview_get_image_position +eom_print_preview_set_image_position +eom_print_preview_set_scale +<SUBSECTION Standard> +EOM_PRINT_PREVIEW +EOM_IS_PRINT_PREVIEW +EOM_TYPE_PRINT_PREVIEW +eom_print_preview_get_type +EOM_PRINT_PREVIEW_CLASS +EOM_IS_PRINT_PREVIEW_CLASS +</SECTION> + +<SECTION> +<FILE>eom-transform</FILE> +EomTransformType +<TITLE>EomTransform</TITLE> +EomTransform +eom_transform_apply +eom_transform_reverse +eom_transform_compose +eom_transform_is_identity +eom_transform_identity_new +eom_transform_rotate_new +eom_transform_flip_new +eom_transform_scale_new +eom_transform_new +eom_transform_get_transform_type +<SUBSECTION Standard> +EOM_TRANSFORM +EOM_IS_TRANSFORM +EOM_TYPE_TRANSFORM +eom_transform_get_type +EOM_TRANSFORM_CLASS +EOM_IS_TRANSFORM_CLASS +EOM_TRANSFORM_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-file-chooser</FILE> +<TITLE>EomFileChooser</TITLE> +EomFileChooser +eom_file_chooser_new +eom_file_chooser_get_format +<SUBSECTION Standard> +EOM_FILE_CHOOSER +EOM_IS_FILE_CHOOSER +EOM_TYPE_FILE_CHOOSER +eom_file_chooser_get_type +EOM_FILE_CHOOSER_CLASS +EOM_IS_FILE_CHOOSER_CLASS +EOM_FILE_CHOOSER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-metadata-reader</FILE> +EOM_METADATA_READER_GET_INTERFACE +EomMetadataReader +EomMetadataReaderInterface +EomMetadataFileType +eom_metadata_reader_new +eom_metadata_reader_consume +eom_metadata_reader_finished +eom_metadata_reader_get_exif_chunk +eom_metadata_reader_get_exif_data +eom_metadata_reader_get_xmp_data +eom_metadata_reader_get_iptc_chunk +eom_metadata_reader_get_iptc_data +eom_metadata_reader_get_icc_profile +<SUBSECTION Standard> +EOM_METADATA_READER +EOM_IS_METADATA_READER +EOM_TYPE_METADATA_READER +eom_metadata_reader_get_type +</SECTION> + +<SECTION> +<FILE>eom-properties-dialog</FILE> +EomPropertiesDialogPage +<TITLE>EomPropertiesDialog</TITLE> +EomPropertiesDialog +eom_properties_dialog_new +eom_properties_dialog_update +eom_properties_dialog_set_page +<SUBSECTION Standard> +EOM_PROPERTIES_DIALOG +EOM_IS_PROPERTIES_DIALOG +EOM_TYPE_PROPERTIES_DIALOG +eom_properties_dialog_get_type +EOM_PROPERTIES_DIALOG_CLASS +EOM_IS_PROPERTIES_DIALOG_CLASS +EOM_PROPERTIES_DIALOG_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-jobs</FILE> +EOM_TYPE_JOB_THUMBNAIL +EOM_JOB_THUMBNAIL +EOM_JOB_THUMBNAIL_CLASS +EOM_IS_JOB_THUMBNAIL +EOM_TYPE_JOB_LOAD +EOM_JOB_LOAD +EOM_JOB_LOAD_CLASS +EOM_IS_JOB_LOAD +EOM_TYPE_JOB_MODEL +EOM_JOB_MODEL +EOM_JOB_MODEL_CLASS +EOM_IS_JOB_MODEL +EOM_TYPE_JOB_TRANSFORM +EOM_JOB_TRANSFORM +EOM_JOB_TRANSFORM_CLASS +EOM_IS_JOB_TRANSFORM +EOM_TYPE_JOB_SAVE +EOM_JOB_SAVE +EOM_JOB_SAVE_CLASS +EOM_IS_JOB_SAVE +EOM_JOB_SAVE_GET_CLASS +EOM_TYPE_JOB_SAVE_AS +EOM_JOB_SAVE_AS +EOM_JOB_SAVE_AS_CLASS +EOM_IS_JOB_SAVE_AS +EOM_JOB_COPY +EOM_JOB_COPY_CLASS +<TITLE>EomJob</TITLE> +EomJob +<TITLE>EomJobThumbnail</TITLE> +EomJobThumbnail +<TITLE>EomJobLoad</TITLE> +EomJobLoad +<TITLE>EomJobModel</TITLE> +EomJobModel +<TITLE>EomJobTransform</TITLE> +EomJobTransform +EomJobSaveResponse +<TITLE>EomJobSave</TITLE> +EomJobSave +<TITLE>EomJobSaveAs</TITLE> +EomJobSaveAs +<TITLE>EomJobCopy</TITLE> +EomJobCopy +eom_job_finished +eom_job_run +eom_job_set_progress +eom_job_thumbnail_get_type +eom_job_thumbnail_new +eom_job_load_get_type +eom_job_load_new +eom_job_model_get_type +eom_job_model_new +eom_job_transform_get_type +eom_job_transform_new +eom_job_save_get_type +eom_job_save_new +eom_job_save_as_get_type +eom_job_save_as_new +eom_job_copy_get_type +eom_job_copy_new +<SUBSECTION Standard> +EOM_JOB +EOM_IS_JOB +EOM_TYPE_JOB +eom_job_get_type +EOM_JOB_CLASS +</SECTION> + +<SECTION> +<FILE>eom-thumb-nav</FILE> +EomThumbNavMode +<TITLE>EomThumbNav</TITLE> +EomThumbNav +eom_thumb_nav_new +eom_thumb_nav_get_show_buttons +eom_thumb_nav_set_show_buttons +eom_thumb_nav_get_mode +eom_thumb_nav_set_mode +<SUBSECTION Standard> +EOM_THUMB_NAV +EOM_IS_THUMB_NAV +EOM_TYPE_THUMB_NAV +eom_thumb_nav_get_type +EOM_THUMB_NAV_CLASS +EOM_IS_THUMB_NAV_CLASS +EOM_THUMB_NAV_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-metadata-reader-png</FILE> +<TITLE>EomMetadataReaderPng</TITLE> +EomMetadataReaderPng +<SUBSECTION Standard> +EOM_METADATA_READER_PNG +EOM_IS_METADATA_READER_PNG +EOM_TYPE_METADATA_READER_PNG +eom_metadata_reader_png_get_type +EOM_METADATA_READER_PNG_CLASS +EOM_IS_METADATA_READER_PNG_CLASS +EOM_METADATA_READER_PNG_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-uri-converter</FILE> +EomUCType +EomUCInfo +EomUCError +EOM_UC_ERROR +<TITLE>EomURIConverter</TITLE> +EomURIConverter +eom_uc_error_quark +eom_uri_converter_new +eom_uri_converter_check +eom_uri_converter_requires_exif +eom_uri_converter_do +eom_uri_converter_preview +eom_uri_converter_print_list +<SUBSECTION Standard> +EOM_URI_CONVERTER +EOM_IS_URI_CONVERTER +EOM_TYPE_URI_CONVERTER +eom_uri_converter_get_type +EOM_URI_CONVERTER_CLASS +EOM_IS_URI_CONVERTER_CLASS +EOM_URI_CONVERTER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-print-image-setup</FILE> +<TITLE>EomPrintImageSetup</TITLE> +EomPrintImageSetup +eom_print_image_setup_new +eom_print_image_setup_get_options +<SUBSECTION Standard> +EOM_PRINT_IMAGE_SETUP +EOM_IS_PRINT_IMAGE_SETUP +EOM_TYPE_PRINT_IMAGE_SETUP +eom_print_image_setup_get_type +EOM_PRINT_IMAGE_SETUP_CLASS +EOM_IS_PRINT_IMAGE_SETUP_CLASS +EOM_PRINT_IMAGE_SETUP_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-thumb-view</FILE> +EomThumbViewSelectionChange +<TITLE>EomThumbView</TITLE> +EomThumbView +eom_thumb_view_new +eom_thumb_view_set_model +eom_thumb_view_set_item_height +eom_thumb_view_get_n_selected +eom_thumb_view_get_first_selected_image +eom_thumb_view_get_selected_images +eom_thumb_view_select_single +eom_thumb_view_set_current_image +eom_thumb_view_set_thumbnail_popup +<SUBSECTION Standard> +EOM_THUMB_VIEW +EOM_IS_THUMB_VIEW +EOM_TYPE_THUMB_VIEW +eom_thumb_view_get_type +EOM_THUMB_VIEW_CLASS +EOM_IS_THUMB_VIEW_CLASS +EOM_THUMB_VIEW_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-plugin</FILE> +EOM_PLUGIN_CONST +<TITLE>EomPlugin</TITLE> +EomPlugin +eom_plugin_activate +eom_plugin_deactivate +eom_plugin_update_ui +eom_plugin_is_configurable +eom_plugin_create_configure_dialog +EOM_PLUGIN_REGISTER_TYPE_WITH_CODE +EOM_PLUGIN_REGISTER_TYPE +EOM_PLUGIN_DEFINE_TYPE_WITH_CODE +EOM_PLUGIN_DEFINE_TYPE +<SUBSECTION Standard> +EOM_PLUGIN +EOM_IS_PLUGIN +EOM_TYPE_PLUGIN +eom_plugin_get_type +EOM_PLUGIN_CLASS +EOM_IS_PLUGIN_CLASS +EOM_PLUGIN_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-application</FILE> +EOM_APP +<TITLE>EomApplication</TITLE> +EomApplication +eom_application_get_instance +eom_application_register_service +eom_application_shutdown +eom_application_open_window +eom_application_open_uri_list +eom_application_open_file_list +eom_application_open_uris +eom_application_get_windows +eom_application_get_toolbars_model +eom_application_save_toolbars_model +eom_application_reset_toolbars_model +eom_application_screensaver_enable +eom_application_screensaver_disable +<SUBSECTION Standard> +EOM_APPLICATION +EOM_IS_APPLICATION +EOM_TYPE_APPLICATION +eom_application_get_type +EOM_APPLICATION_CLASS +EOM_IS_APPLICATION_CLASS +EOM_APPLICATION_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-plugin-manager</FILE> +<TITLE>EomPluginManager</TITLE> +EomPluginManager +eom_plugin_manager_new +<SUBSECTION Standard> +EOM_PLUGIN_MANAGER +EOM_IS_PLUGIN_MANAGER +EOM_TYPE_PLUGIN_MANAGER +eom_plugin_manager_get_type +EOM_PLUGIN_MANAGER_CLASS +EOM_IS_PLUGIN_MANAGER_CLASS +EOM_PLUGIN_MANAGER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-scroll-view</FILE> +<TITLE>EomScrollView</TITLE> +EomScrollView +EomTransparencyStyle +eom_scroll_view_new +eom_scroll_view_set_image +eom_scroll_view_set_scroll_wheel_zoom +eom_scroll_view_set_zoom_upscale +eom_scroll_view_set_zoom_multiplier +eom_scroll_view_set_antialiasing_in +eom_scroll_view_set_antialiasing_out +eom_scroll_view_set_transparency +eom_scroll_view_scrollbars_visible +eom_scroll_view_set_popup +eom_scroll_view_zoom_in +eom_scroll_view_zoom_out +eom_scroll_view_zoom_fit +eom_scroll_view_set_zoom +eom_scroll_view_get_zoom +eom_scroll_view_get_zoom_is_min +eom_scroll_view_get_zoom_is_max +eom_scroll_view_show_cursor +eom_scroll_view_hide_cursor +<SUBSECTION Standard> +EOM_SCROLL_VIEW +EOM_IS_SCROLL_VIEW +EOM_TYPE_SCROLL_VIEW +eom_scroll_view_get_type +EOM_SCROLL_VIEW_CLASS +EOM_IS_SCROLL_VIEW_CLASS +</SECTION> + +<SECTION> +<FILE>eom-window</FILE> +EOM_WINDOW_ERROR +EomWindowMode +EomWindowError +EomStartupFlags +<TITLE>EomWindow</TITLE> +EomWindow +eom_window_new +eom_window_get_mode +eom_window_set_mode +eom_window_get_ui_manager +eom_window_get_store +eom_window_get_view +eom_window_get_sidebar +eom_window_get_thumb_view +eom_window_get_thumb_nav +eom_window_get_statusbar +eom_window_get_image +eom_window_open_file_list +eom_window_is_empty +<SUBSECTION Standard> +EOM_WINDOW +EOM_IS_WINDOW +EOM_TYPE_WINDOW +eom_window_get_type +EOM_WINDOW_CLASS +EOM_IS_WINDOW_CLASS +EOM_WINDOW_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-statusbar</FILE> +<TITLE>EomStatusbar</TITLE> +EomStatusbar +eom_statusbar_new +eom_statusbar_set_image_number +eom_statusbar_set_progress +eom_statusbar_set_has_resize_grip +<SUBSECTION Standard> +EOM_STATUSBAR +EOM_IS_STATUSBAR +EOM_TYPE_STATUSBAR +eom_statusbar_get_type +EOM_STATUSBAR_CLASS +EOM_IS_STATUSBAR_CLASS +EOM_STATUSBAR_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-exif-details</FILE> +<TITLE>EomExifDetails</TITLE> +EomExifDetails +eom_exif_details_new +eom_exif_details_update +eom_exif_details_xmp_update +<SUBSECTION Standard> +EOM_EXIF_DETAILS +EOM_IS_EXIF_DETAILS +EOM_TYPE_EXIF_DETAILS +eom_exif_details_get_type +EOM_EXIF_DETAILS_CLASS +EOM_IS_EXIF_DETAILS_CLASS +EOM_EXIF_DETAILS_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-metadata-reader-jpg</FILE> +<TITLE>EomMetadataReaderJpg</TITLE> +EomMetadataReaderJpg +<SUBSECTION Standard> +EOM_METADATA_READER_JPG +EOM_IS_METADATA_READER_JPG +EOM_TYPE_METADATA_READER_JPG +eom_metadata_reader_jpg_get_type +EOM_METADATA_READER_JPG_CLASS +EOM_IS_METADATA_READER_JPG_CLASS +EOM_METADATA_READER_JPG_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-dialog</FILE> +<TITLE>EomDialog</TITLE> +EomDialog +eom_dialog_construct +eom_dialog_show +eom_dialog_hide +eom_dialog_get_controls +<SUBSECTION Standard> +EOM_DIALOG +EOM_IS_DIALOG +EOM_TYPE_DIALOG +eom_dialog_get_type +EOM_DIALOG_CLASS +EOM_IS_DIALOG_CLASS +EOM_DIALOG_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-image-save-info</FILE> +<TITLE>EomImageSaveInfo</TITLE> +EomImageSaveInfo +EOM_FILE_FORMAT_JPEG +eom_image_save_info_from_image +eom_image_save_info_from_uri +eom_image_save_info_from_file +<SUBSECTION Standard> +EOM_IMAGE_SAVE_INFO +EOM_IS_IMAGE_SAVE_INFO +EOM_TYPE_IMAGE_SAVE_INFO +eom_image_save_info_get_type +EOM_IMAGE_SAVE_INFO_CLASS +EOM_IS_IMAGE_SAVE_INFO_CLASS +EOM_IMAGE_SAVE_INFO_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-sidebar</FILE> +<TITLE>EomSidebar</TITLE> +EomSidebar +eom_sidebar_new +eom_sidebar_add_page +eom_sidebar_remove_page +eom_sidebar_set_page +eom_sidebar_get_n_pages +eom_sidebar_is_empty +<SUBSECTION Standard> +EOM_SIDEBAR +EOM_IS_SIDEBAR +EOM_TYPE_SIDEBAR +eom_sidebar_get_type +EOM_SIDEBAR_CLASS +EOM_IS_SIDEBAR_CLASS +EOM_SIDEBAR_GET_CLASS +</SECTION> + +<SECTION> +<FILE>eom-thumbnail</FILE> +eom_thumbnail_init +eom_thumbnail_fit_to_size +eom_thumbnail_add_frame +eom_thumbnail_load +EOM_THUMBNAIL_ORIGINAL_WIDTH +EOM_THUMBNAIL_ORIGINAL_HEIGHT +</SECTION> + +<SECTION> +<FILE>eom-debug</FILE> +EomDebugSection +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 +eom_debug_init +eom_debug +eom_debug_message +</SECTION> + +<SECTION> +<FILE>eom-job-queue</FILE> +eom_job_queue_init +eom_job_queue_add_job +eom_job_queue_remove_job +</SECTION> + +<SECTION> +<FILE>eom-exif-util</FILE> +eom_exif_util_format_date +eom_exif_util_get_value +</SECTION> + +<SECTION> +<FILE>eom-save-as-dialog-helper</FILE> +eom_save_as_dialog_new +eom_save_as_dialog_get_converter +</SECTION> + +<SECTION> +<FILE>zoom</FILE> +zoom_fit_size +zoom_fit_scale +</SECTION> + +<SECTION> +<FILE>eom-plugin-engine</FILE> +EomPluginInfo +eom_plugin_engine_init +eom_plugin_engine_shutdown +eom_plugin_engine_garbage_collect +eom_plugin_engine_get_plugins_list +eom_plugin_engine_activate_plugin +eom_plugin_engine_deactivate_plugin +eom_plugin_engine_plugin_is_active +eom_plugin_engine_plugin_is_available +eom_plugin_engine_plugin_is_configurable +eom_plugin_engine_configure_plugin +eom_plugin_engine_update_plugins_ui +eom_plugin_engine_get_plugin_name +eom_plugin_engine_get_plugin_description +eom_plugin_engine_get_plugin_icon_name +eom_plugin_engine_get_plugin_authors +eom_plugin_engine_get_plugin_website +eom_plugin_engine_get_plugin_copyright +</SECTION> + +<SECTION> +<FILE>eom-pixbuf-util</FILE> +eom_pixbuf_get_savable_formats +eom_pixbuf_get_format_by_suffix +eom_pixbuf_get_format +eom_pixbuf_get_common_suffix +</SECTION> + +<SECTION> +<FILE>eom-config-keys</FILE> +EOM_CONF_DIR +EOM_CONF_DESKTOP_WALLPAPER +EOM_CONF_DESKTOP_CAN_SAVE +EOM_CONF_DESKTOP_CAN_PRINT +EOM_CONF_DESKTOP_CAN_SETUP_PAGE +EOM_CONF_VIEW_INTERPOLATE +EOM_CONF_VIEW_SCROLL_WHEEL_ZOOM +EOM_CONF_VIEW_ZOOM_MULTIPLIER +EOM_CONF_VIEW_AUTOROTATE +EOM_CONF_VIEW_TRANSPARENCY +EOM_CONF_VIEW_TRANS_COLOR +EOM_CONF_FULLSCREEN_LOOP +EOM_CONF_FULLSCREEN_UPSCALE +EOM_CONF_FULLSCREEN_SECONDS +EOM_CONF_UI_TOOLBAR +EOM_CONF_UI_STATUSBAR +EOM_CONF_UI_IMAGE_COLLECTION +EOM_CONF_UI_IMAGE_COLLECTION_POSITION +EOM_CONF_UI_IMAGE_COLLECTION_RESIZABLE +EOM_CONF_UI_SIDEBAR +EOM_CONF_UI_SCROLL_BUTTONS +EOM_CONF_PLUGINS_ACTIVE_PLUGINS +</SECTION> + +<SECTION> +<FILE>eom-error-message-area</FILE> +eom_image_load_error_message_area_new +eom_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>eom-session</FILE> +eom_session_init +eom_session_is_restored +eom_session_load +</SECTION> + +<SECTION> +<FILE>eom-print</FILE> +eom_print_operation_new +eom_print_get_page_setup +eom_print_set_page_setup +eom_print_get_print_settings +eom_print_set_print_settings +</SECTION> + +<SECTION> +<FILE>eom-util</FILE> +eom_util_show_help +eom_util_make_valid_utf8 +eom_util_parse_uri_string_list_to_file_list +eom_util_string_list_to_file_list +eom_util_strings_to_file_list +eom_util_string_array_to_list +eom_util_string_array_make_absolute +eom_util_launch_desktop_file +eom_util_dot_dir +eom_util_file_is_persistent +</SECTION> + diff --git a/doc/reference/tmpl/eom-application.sgml b/doc/reference/tmpl/eom-application.sgml new file mode 100644 index 0000000..3d020f7 --- /dev/null +++ b/doc/reference/tmpl/eom-application.sgml @@ -0,0 +1,162 @@ +<!-- ##### SECTION Title ##### --> +EomApplication + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_APP ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT EomApplication ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_application_get_instance ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_application_register_service ##### --> +<para> + +</para> + +@application: +@Returns: + + +<!-- ##### FUNCTION eom_application_shutdown ##### --> +<para> + +</para> + +@application: + + +<!-- ##### FUNCTION eom_application_open_window ##### --> +<para> + +</para> + +@application: +@timestamp: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_application_open_uri_list ##### --> +<para> + +</para> + +@application: +@uri_list: +@timestamp: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_application_open_file_list ##### --> +<para> + +</para> + +@application: +@file_list: +@timestamp: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_application_open_uris ##### --> +<para> + +</para> + +@application: +@uris: +@timestamp: +@flags: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_application_get_windows ##### --> +<para> + +</para> + +@application: +@Returns: + + +<!-- ##### FUNCTION eom_application_get_toolbars_model ##### --> +<para> + +</para> + +@application: +@Returns: + + +<!-- ##### FUNCTION eom_application_save_toolbars_model ##### --> +<para> + +</para> + +@application: + + +<!-- ##### FUNCTION eom_application_reset_toolbars_model ##### --> +<para> + +</para> + +@app: + + +<!-- ##### FUNCTION eom_application_screensaver_enable ##### --> +<para> + +</para> + +@application: + + +<!-- ##### FUNCTION eom_application_screensaver_disable ##### --> +<para> + +</para> + +@application: + + diff --git a/doc/reference/tmpl/eom-config-keys.sgml b/doc/reference/tmpl/eom-config-keys.sgml new file mode 100644 index 0000000..10db3ea --- /dev/null +++ b/doc/reference/tmpl/eom-config-keys.sgml @@ -0,0 +1,176 @@ +<!-- ##### SECTION Title ##### --> +eom-config-keys + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_CONF_DIR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_DESKTOP_WALLPAPER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_DESKTOP_CAN_SAVE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_DESKTOP_CAN_PRINT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_DESKTOP_CAN_SETUP_PAGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_INTERPOLATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_SCROLL_WHEEL_ZOOM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_ZOOM_MULTIPLIER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_AUTOROTATE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_TRANSPARENCY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_VIEW_TRANS_COLOR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_FULLSCREEN_LOOP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_FULLSCREEN_UPSCALE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_FULLSCREEN_SECONDS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_TOOLBAR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_STATUSBAR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_IMAGE_COLLECTION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_IMAGE_COLLECTION_POSITION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_IMAGE_COLLECTION_RESIZABLE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_SIDEBAR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_UI_SCROLL_BUTTONS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_CONF_PLUGINS_ACTIVE_PLUGINS ##### --> +<para> + +</para> + + + diff --git a/doc/reference/tmpl/eom-debug.sgml b/doc/reference/tmpl/eom-debug.sgml new file mode 100644 index 0000000..9a31c92 --- /dev/null +++ b/doc/reference/tmpl/eom-debug.sgml @@ -0,0 +1,157 @@ +<!-- ##### SECTION Title ##### --> +eom-debug + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomDebugSection ##### --> +<para> + +</para> + +@EOM_NO_DEBUG: +@EOM_DEBUG_WINDOW: +@EOM_DEBUG_VIEW: +@EOM_DEBUG_JOBS: +@EOM_DEBUG_THUMBNAIL: +@EOM_DEBUG_IMAGE_DATA: +@EOM_DEBUG_IMAGE_LOAD: +@EOM_DEBUG_IMAGE_SAVE: +@EOM_DEBUG_LIST_STORE: +@EOM_DEBUG_PREFERENCES: +@EOM_DEBUG_PRINTING: +@EOM_DEBUG_LCMS: +@EOM_DEBUG_PLUGINS: + +<!-- ##### MACRO DEBUG_WINDOW ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_VIEW ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_JOBS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_THUMBNAIL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_IMAGE_DATA ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_IMAGE_LOAD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_IMAGE_SAVE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_LIST_STORE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_PREFERENCES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_PRINTING ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_LCMS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DEBUG_PLUGINS ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION eom_debug_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_debug ##### --> +<para> + +</para> + +@section: +@file: +@line: +@function: + + +<!-- ##### FUNCTION eom_debug_message ##### --> +<para> + +</para> + +@section: +@file: +@line: +@function: +@format: +@Varargs: + + diff --git a/doc/reference/tmpl/eom-dialog.sgml b/doc/reference/tmpl/eom-dialog.sgml new file mode 100644 index 0000000..2f6253b --- /dev/null +++ b/doc/reference/tmpl/eom-dialog.sgml @@ -0,0 +1,69 @@ +<!-- ##### SECTION Title ##### --> +EomDialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomDialog ##### --> +<para> + +</para> + + +<!-- ##### ARG EomDialog:parent-window ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_dialog_construct ##### --> +<para> + +</para> + +@dialog: +@glade_file: +@dlg_node: + + +<!-- ##### FUNCTION eom_dialog_show ##### --> +<para> + +</para> + +@dialog: + + +<!-- ##### FUNCTION eom_dialog_hide ##### --> +<para> + +</para> + +@dialog: + + +<!-- ##### FUNCTION eom_dialog_get_controls ##### --> +<para> + +</para> + +@dialog: +@property_id: +@Varargs: + + diff --git a/doc/reference/tmpl/eom-error-message-area.sgml b/doc/reference/tmpl/eom-error-message-area.sgml new file mode 100644 index 0000000..e65986f --- /dev/null +++ b/doc/reference/tmpl/eom-error-message-area.sgml @@ -0,0 +1,41 @@ +<!-- ##### SECTION Title ##### --> +eom-error-message-area + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_image_load_error_message_area_new ##### --> +<para> + +</para> + +@caption: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_no_images_error_message_area_new ##### --> +<para> + +</para> + +@file: +@Returns: + + diff --git a/doc/reference/tmpl/eom-exif-details.sgml b/doc/reference/tmpl/eom-exif-details.sgml new file mode 100644 index 0000000..9575f03 --- /dev/null +++ b/doc/reference/tmpl/eom-exif-details.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +EomExifDetails + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomExifDetails ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_exif_details_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_exif_details_update ##### --> +<para> + +</para> + +@view: +@data: + + +<!-- ##### FUNCTION eom_exif_details_xmp_update ##### --> +<para> + +</para> + +@view: +@xmp_data: + + diff --git a/doc/reference/tmpl/eom-exif-util.sgml b/doc/reference/tmpl/eom-exif-util.sgml new file mode 100644 index 0000000..78f2414 --- /dev/null +++ b/doc/reference/tmpl/eom-exif-util.sgml @@ -0,0 +1,43 @@ +<!-- ##### SECTION Title ##### --> +eom-exif-util + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_exif_util_format_date ##### --> +<para> + +</para> + +@date: +@Returns: + + +<!-- ##### FUNCTION eom_exif_util_get_value ##### --> +<para> + +</para> + +@exif_data: +@tag_id: +@buffer: +@buf_size: +@Returns: + + diff --git a/doc/reference/tmpl/eom-file-chooser.sgml b/doc/reference/tmpl/eom-file-chooser.sgml new file mode 100644 index 0000000..5a12f2f --- /dev/null +++ b/doc/reference/tmpl/eom-file-chooser.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +EomFileChooser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomFileChooser ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_file_chooser_new ##### --> +<para> + +</para> + +@action: +@Returns: + + +<!-- ##### FUNCTION eom_file_chooser_get_format ##### --> +<para> + +</para> + +@chooser: +@Returns: + + diff --git a/doc/reference/tmpl/eom-image-save-info.sgml b/doc/reference/tmpl/eom-image-save-info.sgml new file mode 100644 index 0000000..d5ad488 --- /dev/null +++ b/doc/reference/tmpl/eom-image-save-info.sgml @@ -0,0 +1,64 @@ +<!-- ##### SECTION Title ##### --> +EomImageSaveInfo + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomImageSaveInfo ##### --> +<para> + +</para> + + +<!-- ##### MACRO EOM_FILE_FORMAT_JPEG ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION eom_image_save_info_from_image ##### --> +<para> + +</para> + +@data: +@Returns: + + +<!-- ##### FUNCTION eom_image_save_info_from_uri ##### --> +<para> + +</para> + +@uri: +@format: +@Returns: + + +<!-- ##### FUNCTION eom_image_save_info_from_file ##### --> +<para> + +</para> + +@file: +@format: +@Returns: + + diff --git a/doc/reference/tmpl/eom-image.sgml b/doc/reference/tmpl/eom-image.sgml new file mode 100644 index 0000000..ab270b4 --- /dev/null +++ b/doc/reference/tmpl/eom-image.sgml @@ -0,0 +1,414 @@ +<!-- ##### SECTION Title ##### --> +EomImage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomImageData ##### --> +<para> + +</para> + +@EOM_IMAGE_DATA_IMAGE: +@EOM_IMAGE_DATA_DIMENSION: +@EOM_IMAGE_DATA_EXIF: +@EOM_IMAGE_DATA_XMP: + +<!-- ##### MACRO EOM_IMAGE_DATA_ALL ##### --> +<para> + +</para> + + + +<!-- ##### ENUM EomImageError ##### --> +<para> + +</para> + +@EOM_IMAGE_ERROR_SAVE_NOT_LOCAL: +@EOM_IMAGE_ERROR_NOT_LOADED: +@EOM_IMAGE_ERROR_VFS: +@EOM_IMAGE_ERROR_FILE_EXISTS: +@EOM_IMAGE_ERROR_TMP_FILE_FAILED: +@EOM_IMAGE_ERROR_GENERIC: +@EOM_IMAGE_ERROR_UNKNOWN: + +<!-- ##### MACRO EOM_IMAGE_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM EomImageStatus ##### --> +<para> + +</para> + +@EOM_IMAGE_STATUS_UNKNOWN: +@EOM_IMAGE_STATUS_LOADING: +@EOM_IMAGE_STATUS_LOADED: +@EOM_IMAGE_STATUS_SAVING: +@EOM_IMAGE_STATUS_FAILED: + +<!-- ##### STRUCT EomImage ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomImage::changed ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. + +<!-- ##### SIGNAL EomImage::file-changed ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. + +<!-- ##### SIGNAL EomImage::next-frame ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EomImage::save-progress ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EomImage::size-prepared ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### SIGNAL EomImage::thumbnail-changed ##### --> +<para> + +</para> + +@eomimage: the object which received the signal. + +<!-- ##### FUNCTION eom_image_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_image_new ##### --> +<para> + +</para> + +@txt_uri: +@Returns: + + +<!-- ##### FUNCTION eom_image_new_file ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION eom_image_load ##### --> +<para> + +</para> + +@img: +@data2read: +@job: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_image_cancel_load ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_has_data ##### --> +<para> + +</para> + +@img: +@data: +@Returns: + + +<!-- ##### FUNCTION eom_image_data_ref ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_data_unref ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_set_thumbnail ##### --> +<para> + +</para> + +@img: +@pixbuf: + + +<!-- ##### FUNCTION eom_image_save_as_by_info ##### --> +<para> + +</para> + +@img: +@source: +@target: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_image_save_by_info ##### --> +<para> + +</para> + +@img: +@source: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_pixbuf ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_thumbnail ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_size ##### --> +<para> + +</para> + +@img: +@width: +@height: + + +<!-- ##### FUNCTION eom_image_get_bytes ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_is_modified ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_modified ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_get_caption ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_collate_key ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_exif_info ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_xmp_info ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_file ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_uri_for_display ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_get_status ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_transform ##### --> +<para> + +</para> + +@img: +@trans: +@job: + + +<!-- ##### FUNCTION eom_image_autorotate ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_get_profile ##### --> +<para> + +</para> + +@img: +@Returns: + + +<!-- ##### FUNCTION eom_image_apply_display_profile ##### --> +<para> + +</para> + +@img: +@display_profile: + + +<!-- ##### FUNCTION eom_image_undo ##### --> +<para> + +</para> + +@img: + + +<!-- ##### FUNCTION eom_image_get_supported_mime_types ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_image_is_supported_mime_type ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION eom_image_file_changed ##### --> +<para> + +</para> + +@img: + + diff --git a/doc/reference/tmpl/eom-job-queue.sgml b/doc/reference/tmpl/eom-job-queue.sgml new file mode 100644 index 0000000..118319b --- /dev/null +++ b/doc/reference/tmpl/eom-job-queue.sgml @@ -0,0 +1,47 @@ +<!-- ##### SECTION Title ##### --> +eom-job-queue + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_job_queue_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_job_queue_add_job ##### --> +<para> + +</para> + +@job: + + +<!-- ##### FUNCTION eom_job_queue_remove_job ##### --> +<para> + +</para> + +@job: +@Returns: + + diff --git a/doc/reference/tmpl/eom-jobs.sgml b/doc/reference/tmpl/eom-jobs.sgml new file mode 100644 index 0000000..bf820e2 --- /dev/null +++ b/doc/reference/tmpl/eom-jobs.sgml @@ -0,0 +1,463 @@ +<!-- ##### SECTION Title ##### --> +EomJobCopy + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_TYPE_JOB_THUMBNAIL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_THUMBNAIL ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_THUMBNAIL_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_THUMBNAIL ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_LOAD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_LOAD ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_LOAD_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_LOAD ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_MODEL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_MODEL ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_MODEL_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_MODEL ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_TRANSFORM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_TRANSFORM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_TRANSFORM_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_TRANSFORM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_SAVE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_SAVE ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_SAVE_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_SAVE ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_SAVE_GET_CLASS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_TYPE_JOB_SAVE_AS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_JOB_SAVE_AS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_SAVE_AS_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO EOM_IS_JOB_SAVE_AS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_COPY ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO EOM_JOB_COPY_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### STRUCT EomJob ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomJob::finished ##### --> +<para> + +</para> + +@eomjob: the object which received the signal. + +<!-- ##### SIGNAL EomJob::progress ##### --> +<para> + +</para> + +@eomjob: the object which received the signal. +@arg1: + +<!-- ##### STRUCT EomJobThumbnail ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobLoad ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobModel ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobTransform ##### --> +<para> + +</para> + + +<!-- ##### ENUM EomJobSaveResponse ##### --> +<para> + +</para> + +@EOM_SAVE_RESPONSE_NONE: +@EOM_SAVE_RESPONSE_RETRY: +@EOM_SAVE_RESPONSE_SKIP: +@EOM_SAVE_RESPONSE_OVERWRITE: +@EOM_SAVE_RESPONSE_CANCEL: +@EOM_SAVE_RESPONSE_LAST: + +<!-- ##### STRUCT EomJobSave ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobSaveAs ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomJobCopy ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_job_finished ##### --> +<para> + +</para> + +@job: + + +<!-- ##### FUNCTION eom_job_run ##### --> +<para> + +</para> + +@job: + + +<!-- ##### FUNCTION eom_job_set_progress ##### --> +<para> + +</para> + +@job: +@progress: + + +<!-- ##### FUNCTION eom_job_thumbnail_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_thumbnail_new ##### --> +<para> + +</para> + +@image: +@Returns: + + +<!-- ##### FUNCTION eom_job_load_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_load_new ##### --> +<para> + +</para> + +@image: +@data: +@Returns: + + +<!-- ##### FUNCTION eom_job_model_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_model_new ##### --> +<para> + +</para> + +@file_list: +@Returns: + + +<!-- ##### FUNCTION eom_job_transform_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_transform_new ##### --> +<para> + +</para> + +@images: +@trans: +@Returns: + + +<!-- ##### FUNCTION eom_job_save_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_save_new ##### --> +<para> + +</para> + +@images: +@Returns: + + +<!-- ##### FUNCTION eom_job_save_as_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_save_as_new ##### --> +<para> + +</para> + +@images: +@converter: +@file: +@Returns: + + +<!-- ##### FUNCTION eom_job_copy_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_job_copy_new ##### --> +<para> + +</para> + +@images: +@dest: +@Returns: + + diff --git a/doc/reference/tmpl/eom-list-store.sgml b/doc/reference/tmpl/eom-list-store.sgml new file mode 100644 index 0000000..6241cd4 --- /dev/null +++ b/doc/reference/tmpl/eom-list-store.sgml @@ -0,0 +1,166 @@ +<!-- ##### SECTION Title ##### --> +EomListStore + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_LIST_STORE_THUMB_SIZE ##### --> +<para> + +</para> + + + +<!-- ##### ENUM EomListStoreColumn ##### --> +<para> + +</para> + +@EOM_LIST_STORE_THUMBNAIL: +@EOM_LIST_STORE_THUMB_SET: +@EOM_LIST_STORE_EOM_IMAGE: +@EOM_LIST_STORE_EOM_JOB: +@EOM_LIST_STORE_NUM_COLUMNS: + +<!-- ##### STRUCT EomListStore ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_list_store_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_new_from_glist ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_append_image ##### --> +<para> + +</para> + +@store: +@image: + + +<!-- ##### FUNCTION eom_list_store_add_files ##### --> +<para> + +</para> + +@store: +@file_list: + + +<!-- ##### FUNCTION eom_list_store_remove_image ##### --> +<para> + +</para> + +@store: +@image: + + +<!-- ##### FUNCTION eom_list_store_get_pos_by_image ##### --> +<para> + +</para> + +@store: +@image: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_get_image_by_pos ##### --> +<para> + +</para> + +@store: +@pos: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_get_pos_by_iter ##### --> +<para> + +</para> + +@store: +@iter: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_length ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_get_initial_pos ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION eom_list_store_thumbnail_set ##### --> +<para> + +</para> + +@store: +@iter: + + +<!-- ##### FUNCTION eom_list_store_thumbnail_unset ##### --> +<para> + +</para> + +@store: +@iter: + + +<!-- ##### FUNCTION eom_list_store_thumbnail_refresh ##### --> +<para> + +</para> + +@store: +@iter: + + diff --git a/doc/reference/tmpl/eom-metadata-reader-jpg.sgml b/doc/reference/tmpl/eom-metadata-reader-jpg.sgml new file mode 100644 index 0000000..124e54e --- /dev/null +++ b/doc/reference/tmpl/eom-metadata-reader-jpg.sgml @@ -0,0 +1,28 @@ +<!-- ##### SECTION Title ##### --> +EomMetadataReaderJpg + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomMetadataReaderJpg ##### --> +<para> + +</para> + + diff --git a/doc/reference/tmpl/eom-metadata-reader-png.sgml b/doc/reference/tmpl/eom-metadata-reader-png.sgml new file mode 100644 index 0000000..74d2df3 --- /dev/null +++ b/doc/reference/tmpl/eom-metadata-reader-png.sgml @@ -0,0 +1,28 @@ +<!-- ##### SECTION Title ##### --> +EomMetadataReaderPng + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomMetadataReaderPng ##### --> +<para> + +</para> + + diff --git a/doc/reference/tmpl/eom-metadata-reader.sgml b/doc/reference/tmpl/eom-metadata-reader.sgml new file mode 100644 index 0000000..d44ad0a --- /dev/null +++ b/doc/reference/tmpl/eom-metadata-reader.sgml @@ -0,0 +1,140 @@ +<!-- ##### SECTION Title ##### --> +eom-metadata-reader + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_METADATA_READER_GET_INTERFACE ##### --> +<para> + +</para> + +@o: + + +<!-- ##### STRUCT EomMetadataReader ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EomMetadataReaderInterface ##### --> +<para> + +</para> + +@parent: +@consume: +@finished: +@get_raw_exif: +@get_exif_data: +@get_icc_profile: +@get_xmp_ptr: + +<!-- ##### ENUM EomMetadataFileType ##### --> +<para> + +</para> + +@EOM_METADATA_JPEG: +@EOM_METADATA_PNG: + +<!-- ##### FUNCTION eom_metadata_reader_new ##### --> +<para> + +</para> + +@type: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_consume ##### --> +<para> + +</para> + +@emr: +@buf: +@len: + + +<!-- ##### FUNCTION eom_metadata_reader_finished ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_exif_chunk ##### --> +<para> + +</para> + +@emr: +@data: +@len: + + +<!-- ##### FUNCTION eom_metadata_reader_get_exif_data ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_xmp_data ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_iptc_chunk ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_iptc_data ##### --> +<para> + +</para> + +@emr: +@Returns: + + +<!-- ##### FUNCTION eom_metadata_reader_get_icc_profile ##### --> +<para> + +</para> + +@emr: +@Returns: + + diff --git a/doc/reference/tmpl/eom-pixbuf-util.sgml b/doc/reference/tmpl/eom-pixbuf-util.sgml new file mode 100644 index 0000000..4ea3683 --- /dev/null +++ b/doc/reference/tmpl/eom-pixbuf-util.sgml @@ -0,0 +1,58 @@ +<!-- ##### SECTION Title ##### --> +eom-pixbuf-util + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_pixbuf_get_savable_formats ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_pixbuf_get_format_by_suffix ##### --> +<para> + +</para> + +@suffix: +@Returns: + + +<!-- ##### FUNCTION eom_pixbuf_get_format ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION eom_pixbuf_get_common_suffix ##### --> +<para> + +</para> + +@format: +@Returns: + + diff --git a/doc/reference/tmpl/eom-plugin-engine.sgml b/doc/reference/tmpl/eom-plugin-engine.sgml new file mode 100644 index 0000000..fbc88cf --- /dev/null +++ b/doc/reference/tmpl/eom-plugin-engine.sgml @@ -0,0 +1,179 @@ +<!-- ##### SECTION Title ##### --> +eom-plugin-engine + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPluginInfo ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_plugin_engine_init ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_plugin_engine_garbage_collect ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugins_list ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_activate_plugin ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_deactivate_plugin ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_plugin_is_active ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_plugin_is_available ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_plugin_is_configurable ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_configure_plugin ##### --> +<para> + +</para> + +@info: +@parent: + + +<!-- ##### FUNCTION eom_plugin_engine_update_plugins_ui ##### --> +<para> + +</para> + +@window: +@new_window: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_name ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_description ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_icon_name ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_authors ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_website ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_engine_get_plugin_copyright ##### --> +<para> + +</para> + +@info: +@Returns: + + diff --git a/doc/reference/tmpl/eom-plugin-manager.sgml b/doc/reference/tmpl/eom-plugin-manager.sgml new file mode 100644 index 0000000..c6331f5 --- /dev/null +++ b/doc/reference/tmpl/eom-plugin-manager.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +EomPluginManager + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPluginManager ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_plugin_manager_new ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/doc/reference/tmpl/eom-plugin.sgml b/doc/reference/tmpl/eom-plugin.sgml new file mode 100644 index 0000000..ece85ef --- /dev/null +++ b/doc/reference/tmpl/eom-plugin.sgml @@ -0,0 +1,121 @@ +<!-- ##### SECTION Title ##### --> +EomPlugin + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_PLUGIN_CONST ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### STRUCT EomPlugin ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_plugin_activate ##### --> +<para> + +</para> + +@plugin: +@window: + + +<!-- ##### FUNCTION eom_plugin_deactivate ##### --> +<para> + +</para> + +@plugin: +@window: + + +<!-- ##### FUNCTION eom_plugin_update_ui ##### --> +<para> + +</para> + +@plugin: +@window: + + +<!-- ##### FUNCTION eom_plugin_is_configurable ##### --> +<para> + +</para> + +@plugin: +@Returns: + + +<!-- ##### FUNCTION eom_plugin_create_configure_dialog ##### --> +<para> + +</para> + +@plugin: +@Returns: + + +<!-- ##### MACRO EOM_PLUGIN_REGISTER_TYPE_WITH_CODE ##### --> +<para> + +</para> + +@PluginName: +@plugin_name: +@CODE: + + +<!-- ##### MACRO EOM_PLUGIN_REGISTER_TYPE ##### --> +<para> + +</para> + +@PluginName: +@plugin_name: + + +<!-- ##### MACRO EOM_PLUGIN_DEFINE_TYPE_WITH_CODE ##### --> +<para> + +</para> + +@ObjectName: +@object_name: +@PARENT_TYPE: +@CODE: + + +<!-- ##### MACRO EOM_PLUGIN_DEFINE_TYPE ##### --> +<para> + +</para> + +@ObjectName: +@object_name: +@PARENT_TYPE: + + diff --git a/doc/reference/tmpl/eom-preferences-dialog.sgml b/doc/reference/tmpl/eom-preferences-dialog.sgml new file mode 100644 index 0000000..1199d1a --- /dev/null +++ b/doc/reference/tmpl/eom-preferences-dialog.sgml @@ -0,0 +1,43 @@ +<!-- ##### SECTION Title ##### --> +EomPreferencesDialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPreferencesDialog ##### --> +<para> + +</para> + + +<!-- ##### ARG EomPreferencesDialog:mateconf-client ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_preferences_dialog_get_instance ##### --> +<para> + +</para> + +@parent: +@client: +@Returns: + + diff --git a/doc/reference/tmpl/eom-print-image-setup.sgml b/doc/reference/tmpl/eom-print-image-setup.sgml new file mode 100644 index 0000000..3f938ca --- /dev/null +++ b/doc/reference/tmpl/eom-print-image-setup.sgml @@ -0,0 +1,60 @@ +<!-- ##### SECTION Title ##### --> +EomPrintImageSetup + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPrintImageSetup ##### --> +<para> + +</para> + + +<!-- ##### ARG EomPrintImageSetup:image ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintImageSetup:page-setup ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_print_image_setup_new ##### --> +<para> + +</para> + +@image: +@page_setup: +@Returns: + + +<!-- ##### FUNCTION eom_print_image_setup_get_options ##### --> +<para> + +</para> + +@setup: +@left: +@top: +@scale: +@unit: + + diff --git a/doc/reference/tmpl/eom-print-preview.sgml b/doc/reference/tmpl/eom-print-preview.sgml new file mode 100644 index 0000000..1dbb584 --- /dev/null +++ b/doc/reference/tmpl/eom-print-preview.sgml @@ -0,0 +1,153 @@ +<!-- ##### SECTION Title ##### --> +EomPrintPreview + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomPrintPreview ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomPrintPreview::image-moved ##### --> +<para> + +</para> + +@eomprintpreview: the object which received the signal. + +<!-- ##### ARG EomPrintPreview:image ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:image-scale ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:image-x-align ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:image-y-align ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:page-bottom-margin ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:page-left-margin ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:page-right-margin ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:page-top-margin ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:paper-height ##### --> +<para> + +</para> + +<!-- ##### ARG EomPrintPreview:paper-width ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_print_preview_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_print_preview_new_with_pixbuf ##### --> +<para> + +</para> + +@pixbuf: +@Returns: + + +<!-- ##### FUNCTION eom_print_preview_set_page_margins ##### --> +<para> + +</para> + +@preview: +@l_margin: +@r_margin: +@t_margin: +@b_margin: + + +<!-- ##### FUNCTION eom_print_preview_set_from_page_setup ##### --> +<para> + +</para> + +@preview: +@setup: + + +<!-- ##### FUNCTION eom_print_preview_get_image_position ##### --> +<para> + +</para> + +@preview: +@x: +@y: + + +<!-- ##### FUNCTION eom_print_preview_set_image_position ##### --> +<para> + +</para> + +@preview: +@x: +@y: + + +<!-- ##### FUNCTION eom_print_preview_set_scale ##### --> +<para> + +</para> + +@preview: +@scale: + + diff --git a/doc/reference/tmpl/eom-print.sgml b/doc/reference/tmpl/eom-print.sgml new file mode 100644 index 0000000..c717c75 --- /dev/null +++ b/doc/reference/tmpl/eom-print.sgml @@ -0,0 +1,67 @@ +<!-- ##### SECTION Title ##### --> +eom-print + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_print_operation_new ##### --> +<para> + +</para> + +@image: +@print_settings: +@page_setup: +@Returns: + + +<!-- ##### FUNCTION eom_print_get_page_setup ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_print_set_page_setup ##### --> +<para> + +</para> + +@page_setup: + + +<!-- ##### FUNCTION eom_print_get_print_settings ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_print_set_print_settings ##### --> +<para> + +</para> + +@print_settings: + + diff --git a/doc/reference/tmpl/eom-properties-dialog.sgml b/doc/reference/tmpl/eom-properties-dialog.sgml new file mode 100644 index 0000000..b6b4d23 --- /dev/null +++ b/doc/reference/tmpl/eom-properties-dialog.sgml @@ -0,0 +1,78 @@ +<!-- ##### SECTION Title ##### --> +EomPropertiesDialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomPropertiesDialogPage ##### --> +<para> + +</para> + +@EOM_PROPERTIES_DIALOG_PAGE_GENERAL: +@EOM_PROPERTIES_DIALOG_PAGE_EXIF: +@EOM_PROPERTIES_DIALOG_PAGE_DETAILS: +@EOM_PROPERTIES_DIALOG_N_PAGES: + +<!-- ##### STRUCT EomPropertiesDialog ##### --> +<para> + +</para> + + +<!-- ##### ARG EomPropertiesDialog:netbook-mode ##### --> +<para> + +</para> + +<!-- ##### ARG EomPropertiesDialog:thumbview ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_properties_dialog_new ##### --> +<para> + +</para> + +@parent: +@thumbview: +@next_image_action: +@previous_image_action: +@Returns: + + +<!-- ##### FUNCTION eom_properties_dialog_update ##### --> +<para> + +</para> + +@prop: +@image: + + +<!-- ##### FUNCTION eom_properties_dialog_set_page ##### --> +<para> + +</para> + +@prop: +@page: + + diff --git a/doc/reference/tmpl/eom-save-as-dialog-helper.sgml b/doc/reference/tmpl/eom-save-as-dialog-helper.sgml new file mode 100644 index 0000000..72a2e79 --- /dev/null +++ b/doc/reference/tmpl/eom-save-as-dialog-helper.sgml @@ -0,0 +1,42 @@ +<!-- ##### SECTION Title ##### --> +eom-save-as-dialog-helper + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_save_as_dialog_new ##### --> +<para> + +</para> + +@main: +@images: +@base_file: +@Returns: + + +<!-- ##### FUNCTION eom_save_as_dialog_get_converter ##### --> +<para> + +</para> + +@dlg: +@Returns: + + diff --git a/doc/reference/tmpl/eom-scroll-view.sgml b/doc/reference/tmpl/eom-scroll-view.sgml new file mode 100644 index 0000000..c832585 --- /dev/null +++ b/doc/reference/tmpl/eom-scroll-view.sgml @@ -0,0 +1,224 @@ +<!-- ##### SECTION Title ##### --> +EomScrollView + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomScrollView ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomScrollView::zoom-changed ##### --> +<para> + +</para> + +@eomscrollview: the object which received the signal. +@arg1: + +<!-- ##### ARG EomScrollView:background-color ##### --> +<para> + +</para> + +<!-- ##### ARG EomScrollView:use-background-color ##### --> +<para> + +</para> + +<!-- ##### ENUM EomTransparencyStyle ##### --> +<para> + +</para> + +@EOM_TRANSP_BACKGROUND: +@EOM_TRANSP_CHECKED: +@EOM_TRANSP_COLOR: + +<!-- ##### FUNCTION eom_scroll_view_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_set_image ##### --> +<para> + +</para> + +@view: +@image: + + +<!-- ##### FUNCTION eom_scroll_view_set_scroll_wheel_zoom ##### --> +<para> + +</para> + +@view: +@scroll_wheel_zoom: + + +<!-- ##### FUNCTION eom_scroll_view_set_zoom_upscale ##### --> +<para> + +</para> + +@view: +@upscale: + + +<!-- ##### FUNCTION eom_scroll_view_set_zoom_multiplier ##### --> +<para> + +</para> + +@view: +@multiplier: + + +<!-- ##### FUNCTION eom_scroll_view_set_antialiasing_in ##### --> +<para> + +</para> + +@view: +@state: + + +<!-- ##### FUNCTION eom_scroll_view_set_antialiasing_out ##### --> +<para> + +</para> + +@view: +@state: + + +<!-- ##### FUNCTION eom_scroll_view_set_transparency ##### --> +<para> + +</para> + +@view: +@style: +@color: + + +<!-- ##### FUNCTION eom_scroll_view_scrollbars_visible ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_set_popup ##### --> +<para> + +</para> + +@view: +@menu: + + +<!-- ##### FUNCTION eom_scroll_view_zoom_in ##### --> +<para> + +</para> + +@view: +@smooth: + + +<!-- ##### FUNCTION eom_scroll_view_zoom_out ##### --> +<para> + +</para> + +@view: +@smooth: + + +<!-- ##### FUNCTION eom_scroll_view_zoom_fit ##### --> +<para> + +</para> + +@view: + + +<!-- ##### FUNCTION eom_scroll_view_set_zoom ##### --> +<para> + +</para> + +@view: +@zoom: + + +<!-- ##### FUNCTION eom_scroll_view_get_zoom ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_get_zoom_is_min ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_get_zoom_is_max ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION eom_scroll_view_show_cursor ##### --> +<para> + +</para> + +@view: + + +<!-- ##### FUNCTION eom_scroll_view_hide_cursor ##### --> +<para> + +</para> + +@view: + + diff --git a/doc/reference/tmpl/eom-session.sgml b/doc/reference/tmpl/eom-session.sgml new file mode 100644 index 0000000..3c785c2 --- /dev/null +++ b/doc/reference/tmpl/eom-session.sgml @@ -0,0 +1,48 @@ +<!-- ##### SECTION Title ##### --> +eom-session + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_session_init ##### --> +<para> + +</para> + +@application: + + +<!-- ##### FUNCTION eom_session_is_restored ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_session_load ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/doc/reference/tmpl/eom-sidebar.sgml b/doc/reference/tmpl/eom-sidebar.sgml new file mode 100644 index 0000000..ff8fa46 --- /dev/null +++ b/doc/reference/tmpl/eom-sidebar.sgml @@ -0,0 +1,104 @@ +<!-- ##### SECTION Title ##### --> +EomSidebar + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomSidebar ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomSidebar::page-added ##### --> +<para> + +</para> + +@eomsidebar: the object which received the signal. +@widget: + +<!-- ##### SIGNAL EomSidebar::page-removed ##### --> +<para> + +</para> + +@eomsidebar: the object which received the signal. +@widget: + +<!-- ##### ARG EomSidebar:current-page ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_sidebar_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_sidebar_add_page ##### --> +<para> + +</para> + +@eom_sidebar: +@title: +@main_widget: + + +<!-- ##### FUNCTION eom_sidebar_remove_page ##### --> +<para> + +</para> + +@eom_sidebar: +@main_widget: + + +<!-- ##### FUNCTION eom_sidebar_set_page ##### --> +<para> + +</para> + +@eom_sidebar: +@main_widget: + + +<!-- ##### FUNCTION eom_sidebar_get_n_pages ##### --> +<para> + +</para> + +@eom_sidebar: +@Returns: + + +<!-- ##### FUNCTION eom_sidebar_is_empty ##### --> +<para> + +</para> + +@eom_sidebar: +@Returns: + + diff --git a/doc/reference/tmpl/eom-statusbar.sgml b/doc/reference/tmpl/eom-statusbar.sgml new file mode 100644 index 0000000..b5b6fe9 --- /dev/null +++ b/doc/reference/tmpl/eom-statusbar.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +EomStatusbar + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT EomStatusbar ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_statusbar_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_statusbar_set_image_number ##### --> +<para> + +</para> + +@statusbar: +@num: +@tot: + + +<!-- ##### FUNCTION eom_statusbar_set_progress ##### --> +<para> + +</para> + +@statusbar: +@progress: + + +<!-- ##### FUNCTION eom_statusbar_set_has_resize_grip ##### --> +<para> + +</para> + +@statusbar: +@has_resize_grip: + + diff --git a/doc/reference/tmpl/eom-thumb-nav.sgml b/doc/reference/tmpl/eom-thumb-nav.sgml new file mode 100644 index 0000000..f08c5cb --- /dev/null +++ b/doc/reference/tmpl/eom-thumb-nav.sgml @@ -0,0 +1,100 @@ +<!-- ##### SECTION Title ##### --> +EomThumbNav + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomThumbNavMode ##### --> +<para> + +</para> + +@EOM_THUMB_NAV_MODE_ONE_ROW: +@EOM_THUMB_NAV_MODE_ONE_COLUMN: +@EOM_THUMB_NAV_MODE_MULTIPLE_ROWS: +@EOM_THUMB_NAV_MODE_MULTIPLE_COLUMNS: + +<!-- ##### STRUCT EomThumbNav ##### --> +<para> + +</para> + + +<!-- ##### ARG EomThumbNav:mode ##### --> +<para> + +</para> + +<!-- ##### ARG EomThumbNav:show-buttons ##### --> +<para> + +</para> + +<!-- ##### ARG EomThumbNav:thumbview ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_thumb_nav_new ##### --> +<para> + +</para> + +@thumbview: +@mode: +@show_buttons: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_nav_get_show_buttons ##### --> +<para> + +</para> + +@nav: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_nav_set_show_buttons ##### --> +<para> + +</para> + +@nav: +@show_buttons: + + +<!-- ##### FUNCTION eom_thumb_nav_get_mode ##### --> +<para> + +</para> + +@nav: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_nav_set_mode ##### --> +<para> + +</para> + +@nav: +@mode: + + diff --git a/doc/reference/tmpl/eom-thumb-view.sgml b/doc/reference/tmpl/eom-thumb-view.sgml new file mode 100644 index 0000000..c63d124 --- /dev/null +++ b/doc/reference/tmpl/eom-thumb-view.sgml @@ -0,0 +1,122 @@ +<!-- ##### SECTION Title ##### --> +EomThumbView + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomThumbViewSelectionChange ##### --> +<para> + +</para> + +@EOM_THUMB_VIEW_SELECT_CURRENT: +@EOM_THUMB_VIEW_SELECT_LEFT: +@EOM_THUMB_VIEW_SELECT_RIGHT: +@EOM_THUMB_VIEW_SELECT_FIRST: +@EOM_THUMB_VIEW_SELECT_LAST: +@EOM_THUMB_VIEW_SELECT_RANDOM: + +<!-- ##### STRUCT EomThumbView ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_thumb_view_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_view_set_model ##### --> +<para> + +</para> + +@thumbview: +@store: + + +<!-- ##### FUNCTION eom_thumb_view_set_item_height ##### --> +<para> + +</para> + +@thumbview: +@height: + + +<!-- ##### FUNCTION eom_thumb_view_get_n_selected ##### --> +<para> + +</para> + +@thumbview: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_view_get_first_selected_image ##### --> +<para> + +</para> + +@thumbview: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_view_get_selected_images ##### --> +<para> + +</para> + +@thumbview: +@Returns: + + +<!-- ##### FUNCTION eom_thumb_view_select_single ##### --> +<para> + +</para> + +@thumbview: +@change: + + +<!-- ##### FUNCTION eom_thumb_view_set_current_image ##### --> +<para> + +</para> + +@thumbview: +@image: +@deselect_other: + + +<!-- ##### FUNCTION eom_thumb_view_set_thumbnail_popup ##### --> +<para> + +</para> + +@thumbview: +@menu: + + diff --git a/doc/reference/tmpl/eom-thumbnail.sgml b/doc/reference/tmpl/eom-thumbnail.sgml new file mode 100644 index 0000000..2de9aea --- /dev/null +++ b/doc/reference/tmpl/eom-thumbnail.sgml @@ -0,0 +1,73 @@ +<!-- ##### SECTION Title ##### --> +eom-thumbnail + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_thumbnail_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION eom_thumbnail_fit_to_size ##### --> +<para> + +</para> + +@thumbnail: +@dimension: +@Returns: + + +<!-- ##### FUNCTION eom_thumbnail_add_frame ##### --> +<para> + +</para> + +@thumbnail: +@Returns: + + +<!-- ##### FUNCTION eom_thumbnail_load ##### --> +<para> + +</para> + +@image: +@error: +@Returns: + + +<!-- ##### MACRO EOM_THUMBNAIL_ORIGINAL_WIDTH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EOM_THUMBNAIL_ORIGINAL_HEIGHT ##### --> +<para> + +</para> + + + diff --git a/doc/reference/tmpl/eom-transform.sgml b/doc/reference/tmpl/eom-transform.sgml new file mode 100644 index 0000000..effa3a2 --- /dev/null +++ b/doc/reference/tmpl/eom-transform.sgml @@ -0,0 +1,136 @@ +<!-- ##### SECTION Title ##### --> +EomTransform + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomTransformType ##### --> +<para> + +</para> + +@EOM_TRANSFORM_NONE: +@EOM_TRANSFORM_ROT_90: +@EOM_TRANSFORM_ROT_180: +@EOM_TRANSFORM_ROT_270: +@EOM_TRANSFORM_FLIP_HORIZONTAL: +@EOM_TRANSFORM_FLIP_VERTICAL: +@EOM_TRANSFORM_TRANSPOSE: +@EOM_TRANSFORM_TRANSVERSE: + +<!-- ##### STRUCT EomTransform ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION eom_transform_apply ##### --> +<para> + +</para> + +@trans: +@pixbuf: +@job: +@Returns: + + +<!-- ##### FUNCTION eom_transform_reverse ##### --> +<para> + +</para> + +@trans: +@Returns: + + +<!-- ##### FUNCTION eom_transform_compose ##### --> +<para> + +</para> + +@trans: +@compose: +@Returns: + + +<!-- ##### FUNCTION eom_transform_is_identity ##### --> +<para> + +</para> + +@trans: +@Returns: + + +<!-- ##### FUNCTION eom_transform_identity_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_transform_rotate_new ##### --> +<para> + +</para> + +@degree: +@Returns: + + +<!-- ##### FUNCTION eom_transform_flip_new ##### --> +<para> + +</para> + +@type: +@Returns: + + +<!-- ##### FUNCTION eom_transform_scale_new ##### --> +<para> + +</para> + +@sx: +@sy: +@Returns: + + +<!-- ##### FUNCTION eom_transform_new ##### --> +<para> + +</para> + +@trans: +@Returns: + + +<!-- ##### FUNCTION eom_transform_get_transform_type ##### --> +<para> + +</para> + +@trans: +@Returns: + + diff --git a/doc/reference/tmpl/eom-unused.sgml b/doc/reference/tmpl/eom-unused.sgml new file mode 100644 index 0000000..43a0f33 --- /dev/null +++ b/doc/reference/tmpl/eom-unused.sgml @@ -0,0 +1,66 @@ +<!-- ##### ARG EomScrollView:antialiasing-in ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:antialiasing-out ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:default-bg-color ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:maximum-image-scale ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:scrollwheel-zoom ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:transparency ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:transparency-color ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:transparency-style ##### --> +<para> + +</para> + + +<!-- ##### ARG EomScrollView:zoom-multiplier ##### --> +<para> + +</para> + + +<!-- ##### ARG EomWindow:gallery-position ##### --> +<para> + +</para> + + +<!-- ##### ARG EomWindow:gallery-resizable ##### --> +<para> + +</para> + + diff --git a/doc/reference/tmpl/eom-uri-converter.sgml b/doc/reference/tmpl/eom-uri-converter.sgml new file mode 100644 index 0000000..2333152 --- /dev/null +++ b/doc/reference/tmpl/eom-uri-converter.sgml @@ -0,0 +1,174 @@ +<!-- ##### SECTION Title ##### --> +EomURIConverter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM EomUCType ##### --> +<para> + +</para> + +@EOM_UC_STRING: +@EOM_UC_FILENAME: +@EOM_UC_COUNTER: +@EOM_UC_COMMENT: +@EOM_UC_DATE: +@EOM_UC_TIME: +@EOM_UC_DAY: +@EOM_UC_MONTH: +@EOM_UC_YEAR: +@EOM_UC_HOUR: +@EOM_UC_MINUTE: +@EOM_UC_SECOND: +@EOM_UC_END: + +<!-- ##### STRUCT EomUCInfo ##### --> +<para> + +</para> + +@description: +@rep: +@req_exif: + +<!-- ##### ENUM EomUCError ##### --> +<para> + +</para> + +@EOM_UC_ERROR_INVALID_UNICODE: +@EOM_UC_ERROR_INVALID_CHARACTER: +@EOM_UC_ERROR_EQUAL_FILENAMES: +@EOM_UC_ERROR_UNKNOWN: + +<!-- ##### MACRO EOM_UC_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT EomURIConverter ##### --> +<para> + +</para> + + +<!-- ##### ARG EomURIConverter:convert-spaces ##### --> +<para> + +</para> + +<!-- ##### ARG EomURIConverter:counter-n-digits ##### --> +<para> + +</para> + +<!-- ##### ARG EomURIConverter:counter-start ##### --> +<para> + +</para> + +<!-- ##### ARG EomURIConverter:n-images ##### --> +<para> + +</para> + +<!-- ##### ARG EomURIConverter:space-character ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_uc_error_quark ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_new ##### --> +<para> + +</para> + +@base_file: +@img_format: +@format_string: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_check ##### --> +<para> + +</para> + +@converter: +@img_list: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_requires_exif ##### --> +<para> + +</para> + +@converter: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_do ##### --> +<para> + +</para> + +@converter: +@image: +@file: +@format: +@error: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_preview ##### --> +<para> + +</para> + +@format_str: +@img: +@format: +@counter: +@n_images: +@convert_spaces: +@space_char: +@Returns: + + +<!-- ##### FUNCTION eom_uri_converter_print_list ##### --> +<para> + +</para> + +@conv: + + diff --git a/doc/reference/tmpl/eom-util.sgml b/doc/reference/tmpl/eom-util.sgml new file mode 100644 index 0000000..4907cb4 --- /dev/null +++ b/doc/reference/tmpl/eom-util.sgml @@ -0,0 +1,114 @@ +<!-- ##### SECTION Title ##### --> +eom-util + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION eom_util_show_help ##### --> +<para> + +</para> + +@section: +@parent: + + +<!-- ##### FUNCTION eom_util_make_valid_utf8 ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION eom_util_parse_uri_string_list_to_file_list ##### --> +<para> + +</para> + +@uri_list: +@Returns: + + +<!-- ##### FUNCTION eom_util_string_list_to_file_list ##### --> +<para> + +</para> + +@string_list: +@Returns: + + +<!-- ##### FUNCTION eom_util_strings_to_file_list ##### --> +<para> + +</para> + +@strings: +@Returns: + + +<!-- ##### FUNCTION eom_util_string_array_to_list ##### --> +<para> + +</para> + +@files: +@create_uri: +@Returns: + + +<!-- ##### FUNCTION eom_util_string_array_make_absolute ##### --> +<para> + +</para> + +@files: +@Returns: + + +<!-- ##### FUNCTION eom_util_launch_desktop_file ##### --> +<para> + +</para> + +@filename: +@user_time: +@Returns: + + +<!-- ##### FUNCTION eom_util_dot_dir ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION eom_util_file_is_persistent ##### --> +<para> + +</para> + +@file: +@Returns: + + diff --git a/doc/reference/tmpl/eom-window.sgml b/doc/reference/tmpl/eom-window.sgml new file mode 100644 index 0000000..387c641 --- /dev/null +++ b/doc/reference/tmpl/eom-window.sgml @@ -0,0 +1,196 @@ +<!-- ##### SECTION Title ##### --> +EomWindow + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO EOM_WINDOW_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### ENUM EomWindowMode ##### --> +<para> + +</para> + +@EOM_WINDOW_MODE_UNKNOWN: +@EOM_WINDOW_MODE_NORMAL: +@EOM_WINDOW_MODE_FULLSCREEN: +@EOM_WINDOW_MODE_SLIDESHOW: + +<!-- ##### ENUM EomWindowError ##### --> +<para> + +</para> + +@EOM_WINDOW_ERROR_CONTROL_NOT_FOUND: +@EOM_WINDOW_ERROR_UI_NOT_FOUND: +@EOM_WINDOW_ERROR_NO_PERSIST_FILE_INTERFACE: +@EOM_WINDOW_ERROR_IO: +@EOM_WINDOW_ERROR_TRASH_NOT_FOUND: +@EOM_WINDOW_ERROR_GENERIC: +@EOM_WINDOW_ERROR_UNKNOWN: + +<!-- ##### ENUM EomStartupFlags ##### --> +<para> + +</para> + +@EOM_STARTUP_FULLSCREEN: +@EOM_STARTUP_SLIDE_SHOW: +@EOM_STARTUP_DISABLE_COLLECTION: + +<!-- ##### STRUCT EomWindow ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EomWindow::prepared ##### --> +<para> + +</para> + +@eomwindow: the object which received the signal. + +<!-- ##### ARG EomWindow:startup-flags ##### --> +<para> + +</para> + +<!-- ##### FUNCTION eom_window_new ##### --> +<para> + +</para> + +@flags: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_mode ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_set_mode ##### --> +<para> + +</para> + +@window: +@mode: + + +<!-- ##### FUNCTION eom_window_get_ui_manager ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_store ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_view ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_sidebar ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_thumb_view ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_thumb_nav ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_statusbar ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_get_image ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION eom_window_open_file_list ##### --> +<para> + +</para> + +@window: +@file_list: + + +<!-- ##### FUNCTION eom_window_is_empty ##### --> +<para> + +</para> + +@window: +@Returns: + + diff --git a/doc/reference/tmpl/uta.sgml b/doc/reference/tmpl/uta.sgml new file mode 100644 index 0000000..4ae79aa --- /dev/null +++ b/doc/reference/tmpl/uta.sgml @@ -0,0 +1,85 @@ +<!-- ##### SECTION Title ##### --> +uta + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION uta_ensure_size ##### --> +<para> + +</para> + +@uta: +@x1: +@y1: +@x2: +@y2: +@Returns: + + +<!-- ##### FUNCTION uta_add_rect ##### --> +<para> + +</para> + +@uta: +@x1: +@y1: +@x2: +@y2: +@Returns: + + +<!-- ##### FUNCTION uta_remove_rect ##### --> +<para> + +</para> + +@uta: +@x1: +@y1: +@x2: +@y2: + + +<!-- ##### FUNCTION uta_find_first_glom_rect ##### --> +<para> + +</para> + +@uta: +@rect: +@max_width: +@max_height: + + +<!-- ##### FUNCTION uta_copy_area ##### --> +<para> + +</para> + +@uta: +@src_x: +@src_y: +@dest_x: +@dest_y: +@width: +@height: + + diff --git a/doc/reference/tmpl/zoom.sgml b/doc/reference/tmpl/zoom.sgml new file mode 100644 index 0000000..b26005f --- /dev/null +++ b/doc/reference/tmpl/zoom.sgml @@ -0,0 +1,49 @@ +<!-- ##### SECTION Title ##### --> +zoom + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION zoom_fit_size ##### --> +<para> + +</para> + +@dest_width: +@dest_height: +@src_width: +@src_height: +@upscale_smaller: +@width: +@height: + + +<!-- ##### FUNCTION zoom_fit_scale ##### --> +<para> + +</para> + +@dest_width: +@dest_height: +@src_width: +@src_height: +@upscale_smaller: +@Returns: + + diff --git a/doc/reference/version.xml.in b/doc/reference/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/doc/reference/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |