callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.3.6

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:18:19 -04:00
parent 7802c3a9cb
commit de5dc4f4c2
3129 changed files with 762016 additions and 525609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
devel-docs/libgimpbase/Makefile.am
View File

@ -1,7 +1,5 @@
## Process this file with automake to produce Makefile.in
AUTOMAKE_OPTIONS = 1.6
# The name of the module.
DOC_MODULE = libgimpbase
@ -31,6 +29,9 @@ CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c
IGNORE_HFILES = \
gimpbase.h \
gimpbase-private.h \
gimpprotocol.h \
gimpreloc.h \
gimpwire.h \
gimpwin32-io.h
# Images to copy into HTML directory

155
devel-docs/libgimpbase/Makefile.in
View File

@ -46,7 +46,12 @@ DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \
subdir = devel-docs/libgimpbase
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \
$(top_srcdir)/configure.in
$(top_srcdir)/m4macros/detectcflags.m4 \
$(top_srcdir)/m4macros/pythondev.m4 \
$(top_srcdir)/m4macros/gimpprint.m4 \
$(top_srcdir)/m4macros/alsa.m4 \
$(top_srcdir)/m4macros/gtk-doc.m4 \
$(top_srcdir)/m4macros/binreloc.m4 $(top_srcdir)/configure.in
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
@ -58,9 +63,9 @@ DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
AA = @AA@
ACLOCAL = @ACLOCAL@
ALLOCA = @ALLOCA@
ALL_LINGUAS = @ALL_LINGUAS@
ALSA_CFLAGS = @ALSA_CFLAGS@
ALSA_LIBS = @ALSA_LIBS@
ALTIVEC_EXTRA_CFLAGS = @ALTIVEC_EXTRA_CFLAGS@
AMDEP_FALSE = @AMDEP_FALSE@
AMDEP_TRUE = @AMDEP_TRUE@
AMTAR = @AMTAR@
@ -70,6 +75,8 @@ AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
AWK = @AWK@
BINRELOC_CFLAGS = @BINRELOC_CFLAGS@
BINRELOC_LIBS = @BINRELOC_LIBS@
BUILD_HELPBROWSER_FALSE = @BUILD_HELPBROWSER_FALSE@
BUILD_HELPBROWSER_TRUE = @BUILD_HELPBROWSER_TRUE@
BUILD_PRINT_FALSE = @BUILD_PRINT_FALSE@
@ -101,6 +108,7 @@ DESKTOP_DATADIR = @DESKTOP_DATADIR@
DESKTOP_DATADIR_FALSE = @DESKTOP_DATADIR_FALSE@
DESKTOP_DATADIR_TRUE = @DESKTOP_DATADIR_TRUE@
DLLTOOL = @DLLTOOL@
DOC_SHOOTER = @DOC_SHOOTER@
ECHO = @ECHO@
ECHO_C = @ECHO_C@
ECHO_N = @ECHO_N@
@ -135,7 +143,6 @@ GIMP_API_VERSION = @GIMP_API_VERSION@
GIMP_APP_VERSION = @GIMP_APP_VERSION@
GIMP_BINARY_AGE = @GIMP_BINARY_AGE@
GIMP_DATA_VERSION = @GIMP_DATA_VERSION@
GIMP_DESKTOP_ICON = @GIMP_DESKTOP_ICON@
GIMP_FULL_NAME = @GIMP_FULL_NAME@
GIMP_INTERFACE_AGE = @GIMP_INTERFACE_AGE@
GIMP_MAJOR_VERSION = @GIMP_MAJOR_VERSION@
@ -143,18 +150,16 @@ GIMP_MICRO_VERSION = @GIMP_MICRO_VERSION@
GIMP_MINOR_VERSION = @GIMP_MINOR_VERSION@
GIMP_MKENUMS = @GIMP_MKENUMS@
GIMP_MODULES = @GIMP_MODULES@
GIMP_MP_FLAGS = @GIMP_MP_FLAGS@
GIMP_MP_LIBS = @GIMP_MP_LIBS@
GIMP_PKGCONFIG_VERSION = @GIMP_PKGCONFIG_VERSION@
GIMP_PLUGINS = @GIMP_PLUGINS@
GIMP_PLUGIN_VERSION = @GIMP_PLUGIN_VERSION@
GIMP_REAL_VERSION = @GIMP_REAL_VERSION@
GIMP_REMOTE = @GIMP_REMOTE@
GIMP_SYSCONF_VERSION = @GIMP_SYSCONF_VERSION@
GIMP_THREAD_FLAGS = @GIMP_THREAD_FLAGS@
GIMP_THREAD_LIBS = @GIMP_THREAD_LIBS@
GIMP_TOOL_VERSION = @GIMP_TOOL_VERSION@
GIMP_UNSTABLE = @GIMP_UNSTABLE@
GIMP_UNSTABLE_FALSE = @GIMP_UNSTABLE_FALSE@
GIMP_UNSTABLE_TRUE = @GIMP_UNSTABLE_TRUE@
GIMP_USER_VERSION = @GIMP_USER_VERSION@
GIMP_VERSION = @GIMP_VERSION@
GLIB_CFLAGS = @GLIB_CFLAGS@
@ -166,8 +171,12 @@ GMODULE_CFLAGS = @GMODULE_CFLAGS@
GMODULE_LIBS = @GMODULE_LIBS@
GMOFILES = @GMOFILES@
GMSGFMT = @GMSGFMT@
GNOMEPRINT = @GNOMEPRINT@
GNOMEPRINT_CFLAGS = @GNOMEPRINT_CFLAGS@
GNOMEPRINT_LIBS = @GNOMEPRINT_LIBS@
GOBJECT_QUERY = @GOBJECT_QUERY@
GREP = @GREP@
GTHREAD_CFLAGS = @GTHREAD_CFLAGS@
GTHREAD_LIBS = @GTHREAD_LIBS@
GTKDOC_REQUIRED_VERSION = @GTKDOC_REQUIRED_VERSION@
GTKHTML2_CFLAGS = @GTKHTML2_CFLAGS@
GTKHTML2_LIBS = @GTKHTML2_LIBS@
@ -181,6 +190,10 @@ HAVE_FINITE = @HAVE_FINITE@
HAVE_GLIBC_REGEX = @HAVE_GLIBC_REGEX@
HAVE_GLIBC_REGEX_FALSE = @HAVE_GLIBC_REGEX_FALSE@
HAVE_GLIBC_REGEX_TRUE = @HAVE_GLIBC_REGEX_TRUE@
HAVE_GNOMEPRINT_FALSE = @HAVE_GNOMEPRINT_FALSE@
HAVE_GNOMEPRINT_TRUE = @HAVE_GNOMEPRINT_TRUE@
HAVE_GNOMEVFS_FALSE = @HAVE_GNOMEVFS_FALSE@
HAVE_GNOMEVFS_TRUE = @HAVE_GNOMEVFS_TRUE@
HAVE_ISFINITE = @HAVE_ISFINITE@
HAVE_LCMS_FALSE = @HAVE_LCMS_FALSE@
HAVE_LCMS_TRUE = @HAVE_LCMS_TRUE@
@ -217,7 +230,6 @@ INTLTOOL_PONG_RULE = @INTLTOOL_PONG_RULE@
INTLTOOL_PROP_RULE = @INTLTOOL_PROP_RULE@
INTLTOOL_SCHEMAS_RULE = @INTLTOOL_SCHEMAS_RULE@
INTLTOOL_SERVER_RULE = @INTLTOOL_SERVER_RULE@
INTLTOOL_SERVICE_RULE = @INTLTOOL_SERVICE_RULE@
INTLTOOL_SHEET_RULE = @INTLTOOL_SHEET_RULE@
INTLTOOL_SOUNDLIST_RULE = @INTLTOOL_SOUNDLIST_RULE@
INTLTOOL_THEME_RULE = @INTLTOOL_THEME_RULE@
@ -233,10 +245,12 @@ LDFLAGS = @LDFLAGS@
LIBAA = @LIBAA@
LIBART_CFLAGS = @LIBART_CFLAGS@
LIBART_LIBS = @LIBART_LIBS@
LIBGNOMEPRINT = @LIBGNOMEPRINT@
LIBJPEG = @LIBJPEG@
LIBMNG = @LIBMNG@
LIBOBJS = @LIBOBJS@
LIBPNG = @LIBPNG@
LIBPOPPLER = @LIBPOPPLER@
LIBS = @LIBS@
LIBSCREENSHOT = @LIBSCREENSHOT@
LIBSVG = @LIBSVG@
@ -259,7 +273,6 @@ MKINSTALLDIRS = @MKINSTALLDIRS@
MMX_EXTRA_CFLAGS = @MMX_EXTRA_CFLAGS@
MNG = @MNG@
MSGFMT = @MSGFMT@
MSGFMT_OPTS = @MSGFMT_OPTS@
MS_LIB_AVAILABLE_FALSE = @MS_LIB_AVAILABLE_FALSE@
MS_LIB_AVAILABLE_TRUE = @MS_LIB_AVAILABLE_TRUE@
OBJDUMP = @OBJDUMP@
@ -285,15 +298,22 @@ PLATFORM_WIN32_FALSE = @PLATFORM_WIN32_FALSE@
PLATFORM_WIN32_TRUE = @PLATFORM_WIN32_TRUE@
PNG = @PNG@
POFILES = @POFILES@
POPPLER = @POPPLER@
POPPLER_CFLAGS = @POPPLER_CFLAGS@
POPPLER_LIBS = @POPPLER_LIBS@
POSUB = @POSUB@
PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@
PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@
PRINT_CFLAGS = @PRINT_CFLAGS@
PRINT_LIBS = @PRINT_LIBS@
PSP = @PSP@
PYBIN_PATH = @PYBIN_PATH@
PYGIMP_EXTRA_CFLAGS = @PYGIMP_EXTRA_CFLAGS@
PYGTK_CFLAGS = @PYGTK_CFLAGS@
PYGTK_CODEGEN = @PYGTK_CODEGEN@
PYGTK_DEFSDIR = @PYGTK_DEFSDIR@
PYGTK_LIBS = @PYGTK_LIBS@
PYLINK_LIBS = @PYLINK_LIBS@
PYTHON = @PYTHON@
PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@
PYTHON_INCLUDES = @PYTHON_INCLUDES@
@ -317,10 +337,10 @@ SVG_CFLAGS = @SVG_CFLAGS@
SVG_LIBS = @SVG_LIBS@
SYMPREFIX = @SYMPREFIX@
TIFF = @TIFF@
URL = @URL@
URI_CFLAGS = @URI_CFLAGS@
URI_LIBS = @URI_LIBS@
USE_NLS = @USE_NLS@
VERSION = @VERSION@
WINCLIPBOARD = @WINCLIPBOARD@
WINDRES = @WINDRES@
WINPRINT = @WINPRINT@
WITH_PDBGEN_FALSE = @WITH_PDBGEN_FALSE@
@ -330,7 +350,6 @@ WMF_CFLAGS = @WMF_CFLAGS@
WMF_CONFIG = @WMF_CONFIG@
WMF_REQUIRED_VERSION = @WMF_REQUIRED_VERSION@
XGETTEXT = @XGETTEXT@
XMKMF = @XMKMF@
XMLLINT = @XMLLINT@
XPM = @XPM@
XSLTPROC = @XSLTPROC@
@ -338,9 +357,17 @@ X_CFLAGS = @X_CFLAGS@
X_EXTRA_LIBS = @X_EXTRA_LIBS@
X_LIBS = @X_LIBS@
X_PRE_LIBS = @X_PRE_LIBS@
ac_ct_AR = @ac_ct_AR@
ac_ct_AS = @ac_ct_AS@
ac_ct_CC = @ac_ct_CC@
ac_ct_CXX = @ac_ct_CXX@
ac_ct_DLLTOOL = @ac_ct_DLLTOOL@
ac_ct_F77 = @ac_ct_F77@
ac_ct_OBJDUMP = @ac_ct_OBJDUMP@
ac_ct_RANLIB = @ac_ct_RANLIB@
ac_ct_STRIP = @ac_ct_STRIP@
ac_ct_WINDRES = @ac_ct_WINDRES@
ac_pt_PKG_CONFIG = @ac_pt_PKG_CONFIG@
am__fastdepCC_FALSE = @am__fastdepCC_FALSE@
am__fastdepCC_TRUE = @am__fastdepCC_TRUE@
am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@
@ -357,12 +384,10 @@ build_cpu = @build_cpu@
build_os = @build_os@
build_vendor = @build_vendor@
datadir = @datadir@
datarootdir = @datarootdir@
docdir = @docdir@
dvidir = @dvidir@
exec_prefix = @exec_prefix@
gimpdatadir = @gimpdatadir@
gimpdir = @gimpdir@
gimplocaledir = @gimplocaledir@
gimpplugindir = @gimpplugindir@
gimpsysconfdir = @gimpsysconfdir@
host = @host@
@ -370,31 +395,26 @@ 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@
ms_librarian = @ms_librarian@
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@
sysconfdir = @sysconfdir@
target_alias = @target_alias@
AUTOMAKE_OPTIONS = 1.6
# The name of the module.
DOC_MODULE = libgimpbase
@ -425,6 +445,9 @@ CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c
IGNORE_HFILES = \
gimpbase.h \
gimpbase-private.h \
gimpprotocol.h \
gimpreloc.h \
gimpwire.h \
gimpwin32-io.h
@ -641,65 +664,63 @@ uninstall-am: uninstall-info-am uninstall-local
@ENABLE_GTK_DOC_TRUE@all-local: html-build.stamp
@ENABLE_GTK_DOC_FALSE@all-local:
docs: html-build.stamp
#### scan ####
scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
@echo 'gtk-doc: Scanning header files'
@-chmod -R u+w $(srcdir)
cd $(srcdir) && \
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
else \
cd $(srcdir) ; \
for i in $(SCANOBJ_FILES) ; do \
test -f $$i || touch $$i ; \
done \
fi
touch scan-build.stamp
@ENABLE_GTK_DOC_TRUE@scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
@ENABLE_GTK_DOC_TRUE@ @echo '*** Scanning header files ***'
@ENABLE_GTK_DOC_TRUE@ @-chmod -R u+w $(srcdir)
@ENABLE_GTK_DOC_TRUE@ if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
@ENABLE_GTK_DOC_TRUE@ CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
@ENABLE_GTK_DOC_TRUE@ else \
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) ; \
@ENABLE_GTK_DOC_TRUE@ for i in $(SCANOBJ_FILES) ; do \
@ENABLE_GTK_DOC_TRUE@ test -f $$i || touch $$i ; \
@ENABLE_GTK_DOC_TRUE@ done \
@ENABLE_GTK_DOC_TRUE@ fi
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && \
@ENABLE_GTK_DOC_TRUE@ gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
@ENABLE_GTK_DOC_TRUE@ touch scan-build.stamp
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
@true
@ENABLE_GTK_DOC_TRUE@$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
@ENABLE_GTK_DOC_TRUE@ @true
#### templates ####
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
@echo 'gtk-doc: Rebuilding template files'
@-chmod -R u+w $(srcdir)
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
touch tmpl-build.stamp
@ENABLE_GTK_DOC_TRUE@tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
@ENABLE_GTK_DOC_TRUE@ @echo '*** Rebuilding template files ***'
@ENABLE_GTK_DOC_TRUE@ @-chmod -R u+w $(srcdir)
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
@ENABLE_GTK_DOC_TRUE@ touch tmpl-build.stamp
tmpl.stamp: tmpl-build.stamp
@true
@ENABLE_GTK_DOC_TRUE@tmpl.stamp: tmpl-build.stamp
@ENABLE_GTK_DOC_TRUE@ @true
#### xml ####
sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
@echo 'gtk-doc: Building XML'
@-chmod -R u+w $(srcdir)
cd $(srcdir) && \
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
touch sgml-build.stamp
@ENABLE_GTK_DOC_TRUE@sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml $(expand_content_files)
@ENABLE_GTK_DOC_TRUE@ @echo '*** Building XML ***'
@ENABLE_GTK_DOC_TRUE@ @-chmod -R u+w $(srcdir)
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && \
@ENABLE_GTK_DOC_TRUE@ gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --expand-content-files="$(expand_content_files)" $(MKDB_OPTIONS)
@ENABLE_GTK_DOC_TRUE@ touch sgml-build.stamp
sgml.stamp: sgml-build.stamp
@true
@ENABLE_GTK_DOC_TRUE@sgml.stamp: sgml-build.stamp
@ENABLE_GTK_DOC_TRUE@ @true
#### html ####
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
@echo 'gtk-doc: Building HTML'
@-chmod -R u+w $(srcdir)
rm -rf $(srcdir)/html
mkdir $(srcdir)/html
cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
@echo 'gtk-doc: Fixing cross-references'
cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
touch html-build.stamp
@ENABLE_GTK_DOC_TRUE@html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
@ENABLE_GTK_DOC_TRUE@ @echo '*** Building HTML ***'
@ENABLE_GTK_DOC_TRUE@ @-chmod -R u+w $(srcdir)
@ENABLE_GTK_DOC_TRUE@ rm -rf $(srcdir)/html
@ENABLE_GTK_DOC_TRUE@ mkdir $(srcdir)/html
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
@ENABLE_GTK_DOC_TRUE@ test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
@ENABLE_GTK_DOC_TRUE@ @echo '-- Fixing Crossreferences'
@ENABLE_GTK_DOC_TRUE@ cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
@ENABLE_GTK_DOC_TRUE@ touch html-build.stamp
@ENABLE_GTK_DOC_FALSE@all-local:
##############
@ -741,12 +762,12 @@ dist-hook: dist-check-gtkdoc dist-hook-local
mkdir $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/xml/*.xml $(distdir)/xml
cp $(srcdir)/html/* $(distdir)/html
-cp $(srcdir)/html/* $(distdir)/html
if test -f $(srcdir)/$(DOC_MODULE).types; then \
cp $(srcdir)/$(DOC_MODULE).types $(distdir)/$(DOC_MODULE).types; \
fi
.PHONY : dist-hook-local docs
.PHONY : dist-hook-local
# 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:

67
devel-docs/libgimpbase/html/index.html
View File

@ -1,78 +1,87 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GIMP Base Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="next" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="book" lang="en">
<div class="titlepage">
<div>
<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">GIMP Base Library Reference Manual</p></th></tr></table></div>
<div><table class="navigation" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">GIMP Base Library Reference Manual</p></th></tr></table></div>
<div><p class="releaseinfo">
for GIMP 2.2.17
for GIMP 2.3.6
</p></div>
</div>
<hr>
</div>
<div class="toc"><dl>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="part"><a href="libgimpbase.html">I. GIMP Base Library</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpbaseenums.html">gimpbaseenums</a></span><span class="refpurpose"> &#8212; Basic GIMP enumeration data types.</span>
<span class="refentrytitle"><a href="libgimpbase-gimpbaseenums.html">gimpbaseenums</a></span><span class="refpurpose"> - Basic GIMP enumeration data types.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpbasetypes.html">gimpbasetypes</a></span><span class="refpurpose"> &#8212; Translation between gettext translation domain identifier and GType.</span>
<span class="refentrytitle"><a href="libgimpbase-gimpbasetypes.html">gimpbasetypes</a></span><span class="refpurpose"> - Translation between gettext translation domain identifier and GType.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpversion.html">gimpversion</a></span><span class="refpurpose"> &#8212; Macros and constants useful for determining GIMP's version number and
<span class="refentrytitle"><a href="libgimpbase-gimpversion.html">gimpversion</a></span><span class="refpurpose"> - Macros and constants useful for determining GIMP's version number and
capabilities.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimplimits.html">gimplimits</a></span><span class="refpurpose"> &#8212; Boundaries of some GIMP data types and some global constants.</span>
<span class="refentrytitle"><a href="libgimpbase-gimplimits.html">gimplimits</a></span><span class="refpurpose"> - Boundaries of some GIMP data types and some global constants.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpchecks.html">gimpchecks</a></span><span class="refpurpose"> &#8212; Constants and functions related to rendering checkerboards.</span>
<span class="refentrytitle"><a href="libgimpbase-gimpchecks.html">gimpchecks</a></span><span class="refpurpose"> - Constants and functions related to rendering checkerboards.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpdatafiles.html">gimpdatafiles</a></span><span class="refpurpose"> &#8212; Functions to handle GIMP data files.</span>
<span class="refentrytitle"><a href="libgimpbase-gimpdatafiles.html">gimpdatafiles</a></span><span class="refpurpose"> - Functions to handle GIMP data files.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpenv.html">gimpenv</a></span><span class="refpurpose"> &#8212; Functions to access the GIMP environment.</span>
<span class="refentrytitle"><a href="libgimpbase-gimpenv.html">gimpenv</a></span><span class="refpurpose"> - Functions to access the GIMP environment.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpmemsize.html">gimpmemsize</a></span><span class="refpurpose"> &#8212; Functions to (de)serialize a given memory size.</span>
<span class="refentrytitle"><a href="libgimpbase-gimpmemsize.html">gimpmemsize</a></span><span class="refpurpose"> - Functions to (de)serialize a given memory size.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpparasite.html">gimpparasite</a></span><span class="refpurpose"> &#8212; Arbitrary pieces of data which can be attached to various GIMP objects.</span>
<span class="refentrytitle"><a href="libgimpbase-gimpparasite.html">gimpparasite</a></span><span class="refpurpose"> - Arbitrary pieces of data which can be attached to various GIMP objects.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpparasiteio.html">gimpparasiteio</a></span><span class="refpurpose"> &#8212; Utility functions to (de)serialize certain C structures to/from <a href="libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a>'s.</span>
<span class="refentrytitle"><a href="libgimpbase-gimpparasiteio.html">gimpparasiteio</a></span><span class="refpurpose"> - Utility functions to (de)serialize certain C structures to/from GimpParasite's.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpsignal.html">gimpsignal</a></span><span class="refpurpose"> &#8212; Portable signal handling.</span>
<span class="refentrytitle"><a href="libgimpbase-gimpsignal.html">gimpsignal</a></span><span class="refpurpose"> - Portable signal handling.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpunit.html">gimpunit</a></span><span class="refpurpose"> &#8212; Provides a collection of predefined units and functions for creating
<span class="refentrytitle"><a href="libgimpbase-gimpunit.html">gimpunit</a></span><span class="refpurpose"> - Provides a collection of predefined units and functions for creating
user-defined units.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimputils.html">gimputils</a></span><span class="refpurpose"> &#8212; Utilities of general interest</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpprotocol.html">gimpprotocol</a></span><span class="refpurpose"> &#8212; The communication protocol between GIMP and it's plug-ins.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="libgimpbase-gimpwire.html">gimpwire</a></span><span class="refpurpose"> &#8212; The lowlevel I/O protocol used for communication between GIMP and
it's plug-ins.</span>
<span class="refentrytitle"><a href="libgimpbase-gimputils.html">gimputils</a></span><span class="refpurpose"> - Utilities of general interest</span>
</dt>
</dl></dd>
</dl></div>
</div></body>
<dt><span class="index"><a href="ix01.html">Index</a></span></dt>
<dt><span class="index"><a href="ix02.html">Index of new symbols in GIMP 2.2</a></span></dt>
<dt><span class="index"><a href="ix03.html">Index of new symbols in GIMP 2.4</a></span></dt>
<dt><span class="index"><a href="ix04.html">Index of deprecated symbols</a></span></dt>
</dl>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"></td>
<td align="right"><a accesskey="n" href="libgimpbase.html"><b>Part&#160;I.&#160;GIMP Base Library&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

81
devel-docs/libgimpbase/html/index.sgml
View File

@ -1,14 +1,32 @@
<ANCHOR id="libgimpbase-gimpbaseenums" href="libgimpbase/libgimpbase-gimpbaseenums.html">
<ANCHOR id="GimpAddMaskType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpAddMaskType">
<ANCHOR id="GimpBlendMode" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpBlendMode">
<ANCHOR id="GimpBucketFillMode" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpBucketFillMode">
<ANCHOR id="GimpChannelOps" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelOps">
<ANCHOR id="GimpChannelType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType">
<ANCHOR id="GimpCheckSize" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize">
<ANCHOR id="GimpCheckType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType">
<ANCHOR id="GimpCloneType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpCloneType">
<ANCHOR id="GimpDesaturateMode" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpDesaturateMode">
<ANCHOR id="GimpDodgeBurnType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpDodgeBurnType">
<ANCHOR id="GimpForegroundExtractMode" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpForegroundExtractMode">
<ANCHOR id="GimpGradientType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpGradientType">
<ANCHOR id="GimpGridStyle" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpGridStyle">
<ANCHOR id="GimpIconType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpIconType">
<ANCHOR id="GimpImageBaseType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType">
<ANCHOR id="GimpImageType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType">
<ANCHOR id="GimpInterpolationType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpInterpolationType">
<ANCHOR id="GimpMessageHandlerType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpMessageHandlerType">
<ANCHOR id="GimpPaintApplicationMode" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpPaintApplicationMode">
<ANCHOR id="GimpPDBArgType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBArgType">
<ANCHOR id="GimpPDBProcType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBProcType">
<ANCHOR id="GimpPDBStatusType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBStatusType">
<ANCHOR id="GimpProgressCommand" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpProgressCommand">
<ANCHOR id="GimpRepeatMode" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpRepeatMode">
<ANCHOR id="GimpSizeType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpSizeType">
<ANCHOR id="GimpStackTraceMode" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpStackTraceMode">
<ANCHOR id="GimpTransferMode" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpTransferMode">
<ANCHOR id="GimpTransformDirection" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpTransformDirection">
<ANCHOR id="libgimpbase-gimpbasetypes" href="libgimpbase/libgimpbase-gimpbasetypes.html">
<ANCHOR id="GimpEnumDesc" href="libgimpbase/libgimpbase-gimpbasetypes.html#GimpEnumDesc">
<ANCHOR id="GimpFlagsDesc" href="libgimpbase/libgimpbase-gimpbasetypes.html#GimpFlagsDesc">
@ -43,6 +61,7 @@
<ANCHOR id="gimp-datafiles-check-extension" href="libgimpbase/libgimpbase-gimpdatafiles.html#gimp-datafiles-check-extension">
<ANCHOR id="gimp-datafiles-read-directories" href="libgimpbase/libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories">
<ANCHOR id="libgimpbase-gimpenv" href="libgimpbase/libgimpbase-gimpenv.html">
<ANCHOR id="gimp-env-init" href="libgimpbase/libgimpbase-gimpenv.html#gimp-env-init">
<ANCHOR id="gimp-directory" href="libgimpbase/libgimpbase-gimpenv.html#gimp-directory">
<ANCHOR id="gimp-personal-rc-file" href="libgimpbase/libgimpbase-gimpenv.html#gimp-personal-rc-file">
<ANCHOR id="gimp-data-directory" href="libgimpbase/libgimpbase-gimpenv.html#gimp-data-directory">
@ -59,6 +78,9 @@
<ANCHOR id="gimp-memsize-deserialize" href="libgimpbase/libgimpbase-gimpmemsize.html#gimp-memsize-deserialize">
<ANCHOR id="gimp-memsize-to-string" href="libgimpbase/libgimpbase-gimpmemsize.html#gimp-memsize-to-string">
<ANCHOR id="GIMP-TYPE-MEMSIZE:CAPS" href="libgimpbase/libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS">
<ANCHOR id="GIMP-TYPE-PARAM-MEMSIZE:CAPS" href="libgimpbase/libgimpbase-gimpmemsize.html#GIMP-TYPE-PARAM-MEMSIZE:CAPS">
<ANCHOR id="GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS" href="libgimpbase/libgimpbase-gimpmemsize.html#GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS">
<ANCHOR id="gimp-param-spec-memsize" href="libgimpbase/libgimpbase-gimpmemsize.html#gimp-param-spec-memsize">
<ANCHOR id="GIMP-VALUE-HOLDS-MEMSIZE:CAPS" href="libgimpbase/libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS">
<ANCHOR id="libgimpbase-gimpparasite" href="libgimpbase/libgimpbase-gimpparasite.html">
<ANCHOR id="GimpParasite" href="libgimpbase/libgimpbase-gimpparasite.html#GimpParasite">
@ -105,6 +127,9 @@
<ANCHOR id="gimp-unit-get-singular" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-singular">
<ANCHOR id="gimp-unit-get-plural" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-plural">
<ANCHOR id="GIMP-TYPE-UNIT:CAPS" href="libgimpbase/libgimpbase-gimpunit.html#GIMP-TYPE-UNIT:CAPS">
<ANCHOR id="GIMP-TYPE-PARAM-UNIT:CAPS" href="libgimpbase/libgimpbase-gimpunit.html#GIMP-TYPE-PARAM-UNIT:CAPS">
<ANCHOR id="GIMP-IS-PARAM-SPEC-UNIT:CAPS" href="libgimpbase/libgimpbase-gimpunit.html#GIMP-IS-PARAM-SPEC-UNIT:CAPS">
<ANCHOR id="gimp-param-spec-unit" href="libgimpbase/libgimpbase-gimpunit.html#gimp-param-spec-unit">
<ANCHOR id="GIMP-VALUE-HOLDS-UNIT:CAPS" href="libgimpbase/libgimpbase-gimpunit.html#GIMP-VALUE-HOLDS-UNIT:CAPS">
<ANCHOR id="libgimpbase-gimputils" href="libgimpbase/libgimpbase-gimputils.html">
<ANCHOR id="gimp-any-to-utf8" href="libgimpbase/libgimpbase-gimputils.html#gimp-any-to-utf8">
@ -112,6 +137,7 @@
<ANCHOR id="gimp-utf8-strtrim" href="libgimpbase/libgimpbase-gimputils.html#gimp-utf8-strtrim">
<ANCHOR id="gimp-escape-uline" href="libgimpbase/libgimpbase-gimputils.html#gimp-escape-uline">
<ANCHOR id="gimp-strip-uline" href="libgimpbase/libgimpbase-gimputils.html#gimp-strip-uline">
<ANCHOR id="gimp-canonicalize-identifier" href="libgimpbase/libgimpbase-gimputils.html#gimp-canonicalize-identifier">
<ANCHOR id="gimp-enum-get-desc" href="libgimpbase/libgimpbase-gimputils.html#gimp-enum-get-desc">
<ANCHOR id="gimp-enum-get-value" href="libgimpbase/libgimpbase-gimputils.html#gimp-enum-get-value">
<ANCHOR id="gimp-enum-value-get-desc" href="libgimpbase/libgimpbase-gimputils.html#gimp-enum-value-get-desc">
@ -120,58 +146,3 @@
<ANCHOR id="gimp-flags-get-first-value" href="libgimpbase/libgimpbase-gimputils.html#gimp-flags-get-first-value">
<ANCHOR id="gimp-flags-value-get-desc" href="libgimpbase/libgimpbase-gimputils.html#gimp-flags-value-get-desc">
<ANCHOR id="gimp-flags-value-get-help" href="libgimpbase/libgimpbase-gimputils.html#gimp-flags-value-get-help">
<ANCHOR id="libgimpbase-gimpprotocol" href="libgimpbase/libgimpbase-gimpprotocol.html">
<ANCHOR id="GIMP-PROTOCOL-VERSION:CAPS" href="libgimpbase/libgimpbase-gimpprotocol.html#GIMP-PROTOCOL-VERSION:CAPS">
<ANCHOR id="GPConfig" href="libgimpbase/libgimpbase-gimpprotocol.html#GPConfig">
<ANCHOR id="GPTileReq" href="libgimpbase/libgimpbase-gimpprotocol.html#GPTileReq">
<ANCHOR id="GPTileAck" href="libgimpbase/libgimpbase-gimpprotocol.html#GPTileAck">
<ANCHOR id="GPTileData" href="libgimpbase/libgimpbase-gimpprotocol.html#GPTileData">
<ANCHOR id="GPParam" href="libgimpbase/libgimpbase-gimpprotocol.html#GPParam">
<ANCHOR id="GPParamDef" href="libgimpbase/libgimpbase-gimpprotocol.html#GPParamDef">
<ANCHOR id="GPProcRun" href="libgimpbase/libgimpbase-gimpprotocol.html#GPProcRun">
<ANCHOR id="GPProcReturn" href="libgimpbase/libgimpbase-gimpprotocol.html#GPProcReturn">
<ANCHOR id="GPProcInstall" href="libgimpbase/libgimpbase-gimpprotocol.html#GPProcInstall">
<ANCHOR id="GPProcUninstall" href="libgimpbase/libgimpbase-gimpprotocol.html#GPProcUninstall">
<ANCHOR id="gp-init" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-init">
<ANCHOR id="gp-has-init-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-has-init-write">
<ANCHOR id="gp-quit-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-quit-write">
<ANCHOR id="gp-config-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-config-write">
<ANCHOR id="gp-tile-req-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-tile-req-write">
<ANCHOR id="gp-tile-ack-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-tile-ack-write">
<ANCHOR id="gp-tile-data-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-tile-data-write">
<ANCHOR id="gp-proc-run-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-proc-run-write">
<ANCHOR id="gp-proc-return-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-proc-return-write">
<ANCHOR id="gp-temp-proc-run-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-temp-proc-run-write">
<ANCHOR id="gp-temp-proc-return-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-temp-proc-return-write">
<ANCHOR id="gp-proc-install-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-proc-install-write">
<ANCHOR id="gp-proc-uninstall-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-proc-uninstall-write">
<ANCHOR id="gp-extension-ack-write" href="libgimpbase/libgimpbase-gimpprotocol.html#gp-extension-ack-write">
<ANCHOR id="libgimpbase-gimpwire" href="libgimpbase/libgimpbase-gimpwire.html">
<ANCHOR id="WireMessage" href="libgimpbase/libgimpbase-gimpwire.html#WireMessage">
<ANCHOR id="WireReadFunc" href="libgimpbase/libgimpbase-gimpwire.html#WireReadFunc">
<ANCHOR id="WireWriteFunc" href="libgimpbase/libgimpbase-gimpwire.html#WireWriteFunc">
<ANCHOR id="WireDestroyFunc" href="libgimpbase/libgimpbase-gimpwire.html#WireDestroyFunc">
<ANCHOR id="WireIOFunc" href="libgimpbase/libgimpbase-gimpwire.html#WireIOFunc">
<ANCHOR id="WireFlushFunc" href="libgimpbase/libgimpbase-gimpwire.html#WireFlushFunc">
<ANCHOR id="wire-register" href="libgimpbase/libgimpbase-gimpwire.html#wire-register">
<ANCHOR id="wire-set-reader" href="libgimpbase/libgimpbase-gimpwire.html#wire-set-reader">
<ANCHOR id="wire-set-writer" href="libgimpbase/libgimpbase-gimpwire.html#wire-set-writer">
<ANCHOR id="wire-set-flusher" href="libgimpbase/libgimpbase-gimpwire.html#wire-set-flusher">
<ANCHOR id="wire-read" href="libgimpbase/libgimpbase-gimpwire.html#wire-read">
<ANCHOR id="wire-write" href="libgimpbase/libgimpbase-gimpwire.html#wire-write">
<ANCHOR id="wire-flush" href="libgimpbase/libgimpbase-gimpwire.html#wire-flush">
<ANCHOR id="wire-error" href="libgimpbase/libgimpbase-gimpwire.html#wire-error">
<ANCHOR id="wire-clear-error" href="libgimpbase/libgimpbase-gimpwire.html#wire-clear-error">
<ANCHOR id="wire-read-msg" href="libgimpbase/libgimpbase-gimpwire.html#wire-read-msg">
<ANCHOR id="wire-write-msg" href="libgimpbase/libgimpbase-gimpwire.html#wire-write-msg">
<ANCHOR id="wire-destroy" href="libgimpbase/libgimpbase-gimpwire.html#wire-destroy">
<ANCHOR id="wire-read-int32" href="libgimpbase/libgimpbase-gimpwire.html#wire-read-int32">
<ANCHOR id="wire-read-int16" href="libgimpbase/libgimpbase-gimpwire.html#wire-read-int16">
<ANCHOR id="wire-read-int8" href="libgimpbase/libgimpbase-gimpwire.html#wire-read-int8">
<ANCHOR id="wire-read-double" href="libgimpbase/libgimpbase-gimpwire.html#wire-read-double">
<ANCHOR id="wire-read-string" href="libgimpbase/libgimpbase-gimpwire.html#wire-read-string">
<ANCHOR id="wire-write-int32" href="libgimpbase/libgimpbase-gimpwire.html#wire-write-int32">
<ANCHOR id="wire-write-int16" href="libgimpbase/libgimpbase-gimpwire.html#wire-write-int16">
<ANCHOR id="wire-write-int8" href="libgimpbase/libgimpbase-gimpwire.html#wire-write-int8">
<ANCHOR id="wire-write-double" href="libgimpbase/libgimpbase-gimpwire.html#wire-write-double">
<ANCHOR id="wire-write-string" href="libgimpbase/libgimpbase-gimpwire.html#wire-write-string">

309
devel-docs/libgimpbase/html/ix01.html Normal file
View File

@ -0,0 +1,309 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Index</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="prev" href="libgimpbase-gimputils.html" title="gimputils">
<link rel="next" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimputils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="ix02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="index">
<div class="titlepage"><div><div><h2 class="title">
<a name="id2506049"></a>Index</h2></div></div></div>
<div class="index"><div class="indexdiv">
<h3>G</h3>
<dl>
<dt>GimpAddMaskType, <a href="libgimpbase-gimpbaseenums.html#id2492108">enum GimpAddMaskType</a>
</dt>
<dt>GimpBlendMode, <a href="libgimpbase-gimpbaseenums.html#id2546778">enum GimpBlendMode</a>
</dt>
<dt>GimpBucketFillMode, <a href="libgimpbase-gimpbaseenums.html#id2492147">enum GimpBucketFillMode</a>
</dt>
<dt>GimpChannelOps, <a href="libgimpbase-gimpbaseenums.html#id2492175">enum GimpChannelOps</a>
</dt>
<dt>GimpChannelType, <a href="libgimpbase-gimpbaseenums.html#id2492207">enum GimpChannelType</a>
</dt>
<dt>GimpCheckSize, <a href="libgimpbase-gimpbaseenums.html#id2492238">enum GimpCheckSize</a>
</dt>
<dt>GimpCheckType, <a href="libgimpbase-gimpbaseenums.html#id2534136">enum GimpCheckType</a>
</dt>
<dt>GimpCloneType, <a href="libgimpbase-gimpbaseenums.html#id2534169">enum GimpCloneType</a>
</dt>
<dt>GimpDatafileData, <a href="libgimpbase-gimpdatafiles.html#id2534588">GimpDatafileData</a>
</dt>
<dt>GimpDatafileLoaderFunc, <a href="libgimpbase-gimpdatafiles.html#id2534616">GimpDatafileLoaderFunc ()</a>
</dt>
<dt>GimpDesaturateMode, <a href="libgimpbase-gimpbaseenums.html#id2534197">enum GimpDesaturateMode</a>
</dt>
<dt>GimpDodgeBurnType, <a href="libgimpbase-gimpbaseenums.html#id2534226">enum GimpDodgeBurnType</a>
</dt>
<dt>GimpEnumDesc, <a href="libgimpbase-gimpbasetypes.html#id2550044">GimpEnumDesc</a>
</dt>
<dt>GimpFlagsDesc, <a href="libgimpbase-gimpbasetypes.html#id2540553">GimpFlagsDesc</a>
</dt>
<dt>GimpForegroundExtractMode, <a href="libgimpbase-gimpbaseenums.html#id2534253">enum GimpForegroundExtractMode</a>
</dt>
<dt>GimpGradientType, <a href="libgimpbase-gimpbaseenums.html#id2534279">enum GimpGradientType</a>
</dt>
<dt>GimpGridStyle, <a href="libgimpbase-gimpbaseenums.html#id2534316">enum GimpGridStyle</a>
</dt>
<dt>GimpIconType, <a href="libgimpbase-gimpbaseenums.html#id2534348">enum GimpIconType</a>
</dt>
<dt>GimpImageBaseType, <a href="libgimpbase-gimpbaseenums.html#id2534378">enum GimpImageBaseType</a>
</dt>
<dt>GimpImageType, <a href="libgimpbase-gimpbaseenums.html#id2474124">enum GimpImageType</a>
</dt>
<dt>GimpInterpolationType, <a href="libgimpbase-gimpbaseenums.html#id2474156">enum GimpInterpolationType</a>
</dt>
<dt>GimpMessageHandlerType, <a href="libgimpbase-gimpbaseenums.html#id2474185">enum GimpMessageHandlerType</a>
</dt>
<dt>GimpPaintApplicationMode, <a href="libgimpbase-gimpbaseenums.html#id2474210">enum GimpPaintApplicationMode</a>
</dt>
<dt>GimpParasite, <a href="libgimpbase-gimpparasite.html#id2547626">GimpParasite</a>
</dt>
<dt>GimpPDBArgType, <a href="libgimpbase-gimpbaseenums.html#id2474237">enum GimpPDBArgType</a>
</dt>
<dt>GimpPDBProcType, <a href="libgimpbase-gimpbaseenums.html#id2474271">enum GimpPDBProcType</a>
</dt>
<dt>GimpPDBStatusType, <a href="libgimpbase-gimpbaseenums.html#id2474300">enum GimpPDBStatusType</a>
</dt>
<dt>GimpProgressCommand, <a href="libgimpbase-gimpbaseenums.html#id2474328">enum GimpProgressCommand</a>
</dt>
<dt>GimpRepeatMode, <a href="libgimpbase-gimpbaseenums.html#id2474357">enum GimpRepeatMode</a>
</dt>
<dt>GimpSignalHandlerFunc, <a href="libgimpbase-gimpsignal.html#id2521600">GimpSignalHandlerFunc ()</a>
</dt>
<dt>GimpSizeType, <a href="libgimpbase-gimpbaseenums.html#id2556865">enum GimpSizeType</a>
</dt>
<dt>GimpStackTraceMode, <a href="libgimpbase-gimpbaseenums.html#id2556888">enum GimpStackTraceMode</a>
</dt>
<dt>GimpTransferMode, <a href="libgimpbase-gimpbaseenums.html#id2556912">enum GimpTransferMode</a>
</dt>
<dt>GimpTransformDirection, <a href="libgimpbase-gimpbaseenums.html#id2556938">enum GimpTransformDirection</a>
</dt>
<dt>GimpUnit, <a href="libgimpbase-gimpunit.html#id2520827">enum GimpUnit</a>
</dt>
<dt>gimp_any_to_utf8, <a href="libgimpbase-gimputils.html#id2523751">gimp_any_to_utf8 ()</a>
</dt>
<dt>GIMP_API_VERSION, <a href="libgimpbase-gimpversion.html#id2545773">GIMP_API_VERSION</a>
</dt>
<dt>gimp_canonicalize_identifier, <a href="libgimpbase-gimputils.html#id2568726">gimp_canonicalize_identifier ()</a>
</dt>
<dt>gimp_checks_get_shades, <a href="libgimpbase-gimpchecks.html#id2545265">gimp_checks_get_shades ()</a>
</dt>
<dt>GIMP_CHECK_DARK, <a href="libgimpbase-gimpchecks.html#id2536606">GIMP_CHECK_DARK</a>
</dt>
<dt>GIMP_CHECK_LIGHT, <a href="libgimpbase-gimpchecks.html#id2536631">GIMP_CHECK_LIGHT</a>
</dt>
<dt>GIMP_CHECK_SIZE, <a href="libgimpbase-gimpchecks.html#id2536553">GIMP_CHECK_SIZE</a>
</dt>
<dt>GIMP_CHECK_SIZE_SM, <a href="libgimpbase-gimpchecks.html#id2536580">GIMP_CHECK_SIZE_SM</a>
</dt>
<dt>GIMP_CHECK_VERSION, <a href="libgimpbase-gimpversion.html#id2545799">GIMP_CHECK_VERSION()</a>
</dt>
<dt>gimp_datafiles_check_extension, <a href="libgimpbase-gimpdatafiles.html#id2536427">gimp_datafiles_check_extension ()</a>
</dt>
<dt>gimp_datafiles_read_directories, <a href="libgimpbase-gimpdatafiles.html#id2536511">gimp_datafiles_read_directories ()</a>
</dt>
<dt>gimp_data_directory, <a href="libgimpbase-gimpenv.html#id2560109">gimp_data_directory ()</a>
</dt>
<dt>gimp_directory, <a href="libgimpbase-gimpenv.html#id2545529">gimp_directory ()</a>
</dt>
<dt>gimp_enum_get_desc, <a href="libgimpbase-gimputils.html#id2568821">gimp_enum_get_desc ()</a>
</dt>
<dt>gimp_enum_get_value, <a href="libgimpbase-gimputils.html#id2568952">gimp_enum_get_value ()</a>
</dt>
<dt>gimp_enum_get_value_descriptions, <a href="libgimpbase-gimpbasetypes.html#id2533687">gimp_enum_get_value_descriptions ()</a>
</dt>
<dt>gimp_enum_set_value_descriptions, <a href="libgimpbase-gimpbasetypes.html#id2533577">gimp_enum_set_value_descriptions ()</a>
</dt>
<dt>gimp_enum_value_get_desc, <a href="libgimpbase-gimputils.html#id2569234">gimp_enum_value_get_desc ()</a>
</dt>
<dt>gimp_enum_value_get_help, <a href="libgimpbase-gimputils.html#id2569357">gimp_enum_value_get_help ()</a>
</dt>
<dt>gimp_env_init, <a href="libgimpbase-gimpenv.html#id2545447">gimp_env_init ()</a>
</dt>
<dt>gimp_escape_uline, <a href="libgimpbase-gimputils.html#id2562573">gimp_escape_uline ()</a>
</dt>
<dt>gimp_filename_to_utf8, <a href="libgimpbase-gimputils.html#id2523939">gimp_filename_to_utf8 ()</a>
</dt>
<dt>gimp_flags_get_first_desc, <a href="libgimpbase-gimputils.html#id2569480">gimp_flags_get_first_desc ()</a>
</dt>
<dt>gimp_flags_get_first_value, <a href="libgimpbase-gimputils.html#id2569610">gimp_flags_get_first_value ()</a>
</dt>
<dt>gimp_flags_get_value_descriptions, <a href="libgimpbase-gimpbasetypes.html#id2556652">gimp_flags_get_value_descriptions ()</a>
</dt>
<dt>gimp_flags_set_value_descriptions, <a href="libgimpbase-gimpbasetypes.html#id2556753">gimp_flags_set_value_descriptions ()</a>
</dt>
<dt>gimp_flags_value_get_desc, <a href="libgimpbase-gimputils.html#id2569892">gimp_flags_value_get_desc ()</a>
</dt>
<dt>gimp_flags_value_get_help, <a href="libgimpbase-gimputils.html#id2569993">gimp_flags_value_get_help ()</a>
</dt>
<dt>gimp_gtkrc, <a href="libgimpbase-gimpenv.html#id2560358">gimp_gtkrc ()</a>
</dt>
<dt>GIMP_IS_PARAM_SPEC_MEMSIZE, <a href="libgimpbase-gimpmemsize.html#id2559011">GIMP_IS_PARAM_SPEC_MEMSIZE()</a>
</dt>
<dt>GIMP_IS_PARAM_SPEC_UNIT, <a href="libgimpbase-gimpunit.html#id2566716">GIMP_IS_PARAM_SPEC_UNIT()</a>
</dt>
<dt>gimp_locale_directory, <a href="libgimpbase-gimpenv.html#id2560171">gimp_locale_directory ()</a>
</dt>
<dt>GIMP_MAJOR_VERSION, <a href="libgimpbase-gimpversion.html#id2524881">GIMP_MAJOR_VERSION</a>
</dt>
<dt>GIMP_MAX_IMAGE_SIZE, <a href="libgimpbase-gimplimits.html#id2518521">GIMP_MAX_IMAGE_SIZE</a>
</dt>
<dt>GIMP_MAX_MEMSIZE, <a href="libgimpbase-gimplimits.html#id2525947">GIMP_MAX_MEMSIZE</a>
</dt>
<dt>GIMP_MAX_RESOLUTION, <a href="libgimpbase-gimplimits.html#id2518580">GIMP_MAX_RESOLUTION</a>
</dt>
<dt>gimp_memsize_deserialize, <a href="libgimpbase-gimpmemsize.html#id2516733">gimp_memsize_deserialize ()</a>
</dt>
<dt>gimp_memsize_serialize, <a href="libgimpbase-gimpmemsize.html#id2534498">gimp_memsize_serialize ()</a>
</dt>
<dt>gimp_memsize_to_string, <a href="libgimpbase-gimpmemsize.html#id2558860">gimp_memsize_to_string ()</a>
</dt>
<dt>GIMP_MICRO_VERSION, <a href="libgimpbase-gimpversion.html#id2545720">GIMP_MICRO_VERSION</a>
</dt>
<dt>GIMP_MINOR_VERSION, <a href="libgimpbase-gimpversion.html#id2524906">GIMP_MINOR_VERSION</a>
</dt>
<dt>GIMP_MIN_IMAGE_SIZE, <a href="libgimpbase-gimplimits.html#id2518496">GIMP_MIN_IMAGE_SIZE</a>
</dt>
<dt>GIMP_MIN_RESOLUTION, <a href="libgimpbase-gimplimits.html#id2518551">GIMP_MIN_RESOLUTION</a>
</dt>
<dt>gimp_param_spec_memsize, <a href="libgimpbase-gimpmemsize.html#id2559056">gimp_param_spec_memsize ()</a>
</dt>
<dt>gimp_param_spec_unit, <a href="libgimpbase-gimpunit.html#id2566762">gimp_param_spec_unit ()</a>
</dt>
<dt>GIMP_PARASITE_ATTACH_GRANDPARENT, <a href="libgimpbase-gimpparasite.html#id2563594">GIMP_PARASITE_ATTACH_GRANDPARENT</a>
</dt>
<dt>GIMP_PARASITE_ATTACH_PARENT, <a href="libgimpbase-gimpparasite.html#id2563517">GIMP_PARASITE_ATTACH_PARENT</a>
</dt>
<dt>gimp_parasite_compare, <a href="libgimpbase-gimpparasite.html#id2527405">gimp_parasite_compare ()</a>
</dt>
<dt>gimp_parasite_copy, <a href="libgimpbase-gimpparasite.html#id2516515">gimp_parasite_copy ()</a>
</dt>
<dt>gimp_parasite_data, <a href="libgimpbase-gimpparasite.html#id2563355">gimp_parasite_data ()</a>
</dt>
<dt>gimp_parasite_data_size, <a href="libgimpbase-gimpparasite.html#id2563414">gimp_parasite_data_size ()</a>
</dt>
<dt>gimp_parasite_flags, <a href="libgimpbase-gimpparasite.html#id2563238">gimp_parasite_flags ()</a>
</dt>
<dt>gimp_parasite_free, <a href="libgimpbase-gimpparasite.html#id2516459">gimp_parasite_free ()</a>
</dt>
<dt>GIMP_PARASITE_GRANDPARENT_PERSISTENT, <a href="libgimpbase-gimpparasite.html#id2563620">GIMP_PARASITE_GRANDPARENT_PERSISTENT</a>
</dt>
<dt>GIMP_PARASITE_GRANDPARENT_UNDOABLE, <a href="libgimpbase-gimpparasite.html#id2563646">GIMP_PARASITE_GRANDPARENT_UNDOABLE</a>
</dt>
<dt>gimp_parasite_has_flag, <a href="libgimpbase-gimpparasite.html#id2563184">gimp_parasite_has_flag ()</a>
</dt>
<dt>gimp_parasite_is_persistent, <a href="libgimpbase-gimpparasite.html#id2527577">gimp_parasite_is_persistent ()</a>
</dt>
<dt>gimp_parasite_is_type, <a href="libgimpbase-gimpparasite.html#id2527492">gimp_parasite_is_type ()</a>
</dt>
<dt>gimp_parasite_is_undoable, <a href="libgimpbase-gimpparasite.html#id2527642">gimp_parasite_is_undoable ()</a>
</dt>
<dt>gimp_parasite_name, <a href="libgimpbase-gimpparasite.html#id2563296">gimp_parasite_name ()</a>
</dt>
<dt>gimp_parasite_new, <a href="libgimpbase-gimpparasite.html#id2516330">gimp_parasite_new ()</a>
</dt>
<dt>GIMP_PARASITE_PARENT_PERSISTENT, <a href="libgimpbase-gimpparasite.html#id2563542">GIMP_PARASITE_PARENT_PERSISTENT</a>
</dt>
<dt>GIMP_PARASITE_PARENT_UNDOABLE, <a href="libgimpbase-gimpparasite.html#id2563568">GIMP_PARASITE_PARENT_UNDOABLE</a>
</dt>
<dt>GIMP_PARASITE_PERSISTENT, <a href="libgimpbase-gimpparasite.html#id2563472">GIMP_PARASITE_PERSISTENT</a>
</dt>
<dt>GIMP_PARASITE_UNDOABLE, <a href="libgimpbase-gimpparasite.html#id2563494">GIMP_PARASITE_UNDOABLE</a>
</dt>
<dt>gimp_path_free, <a href="libgimpbase-gimpenv.html#id2560683">gimp_path_free ()</a>
</dt>
<dt>gimp_path_get_user_writable_dir, <a href="libgimpbase-gimpenv.html#id2560746">gimp_path_get_user_writable_dir ()</a>
</dt>
<dt>gimp_path_parse, <a href="libgimpbase-gimpenv.html#id2554430">gimp_path_parse ()</a>
</dt>
<dt>gimp_path_to_str, <a href="libgimpbase-gimpenv.html#id2554599">gimp_path_to_str ()</a>
</dt>
<dt>gimp_personal_rc_file, <a href="libgimpbase-gimpenv.html#id2545620">gimp_personal_rc_file ()</a>
</dt>
<dt>GIMP_PIXPIPE_MAXDIM, <a href="libgimpbase-gimpparasiteio.html#id2562233">GIMP_PIXPIPE_MAXDIM</a>
</dt>
<dt>gimp_pixpipe_params_build, <a href="libgimpbase-gimpparasiteio.html#id2542393">gimp_pixpipe_params_build ()</a>
</dt>
<dt>gimp_pixpipe_params_init, <a href="libgimpbase-gimpparasiteio.html#id2562258">gimp_pixpipe_params_init ()</a>
</dt>
<dt>gimp_pixpipe_params_parse, <a href="libgimpbase-gimpparasiteio.html#id2562312">gimp_pixpipe_params_parse ()</a>
</dt>
<dt>gimp_plug_in_directory, <a href="libgimpbase-gimpenv.html#id2560234">gimp_plug_in_directory ()</a>
</dt>
<dt>gimp_signal_private, <a href="libgimpbase-gimpsignal.html#id2521670">gimp_signal_private ()</a>
</dt>
<dt>gimp_strip_uline, <a href="libgimpbase-gimputils.html#id2568622">gimp_strip_uline ()</a>
</dt>
<dt>gimp_sysconf_directory, <a href="libgimpbase-gimpenv.html#id2560296">gimp_sysconf_directory ()</a>
</dt>
<dt>gimp_type_get_translation_domain, <a href="libgimpbase-gimpbasetypes.html#id2540698">gimp_type_get_translation_domain ()</a>
</dt>
<dt>GIMP_TYPE_MEMSIZE, <a href="libgimpbase-gimpmemsize.html#id2558938">GIMP_TYPE_MEMSIZE</a>
</dt>
<dt>GIMP_TYPE_PARAM_MEMSIZE, <a href="libgimpbase-gimpmemsize.html#id2558986">GIMP_TYPE_PARAM_MEMSIZE</a>
</dt>
<dt>GIMP_TYPE_PARAM_UNIT, <a href="libgimpbase-gimpunit.html#id2566690">GIMP_TYPE_PARAM_UNIT</a>
</dt>
<dt>gimp_type_set_translation_domain, <a href="libgimpbase-gimpbasetypes.html#id2540580">gimp_type_set_translation_domain ()</a>
</dt>
<dt>GIMP_TYPE_UNIT, <a href="libgimpbase-gimpunit.html#id2566642">GIMP_TYPE_UNIT</a>
</dt>
<dt>gimp_unit_get_abbreviation, <a href="libgimpbase-gimpunit.html#id2566413">gimp_unit_get_abbreviation ()</a>
</dt>
<dt>gimp_unit_get_deletion_flag, <a href="libgimpbase-gimpunit.html#id2529125">gimp_unit_get_deletion_flag ()</a>
</dt>
<dt>gimp_unit_get_digits, <a href="libgimpbase-gimpunit.html#id2566185">gimp_unit_get_digits ()</a>
</dt>
<dt>gimp_unit_get_factor, <a href="libgimpbase-gimpunit.html#id2566090">gimp_unit_get_factor ()</a>
</dt>
<dt>gimp_unit_get_identifier, <a href="libgimpbase-gimpunit.html#id2566266">gimp_unit_get_identifier ()</a>
</dt>
<dt>gimp_unit_get_number_of_built_in_units, <a href="libgimpbase-gimpunit.html#id2520912">gimp_unit_get_number_of_built_in_units ()</a>
</dt>
<dt>gimp_unit_get_number_of_units, <a href="libgimpbase-gimpunit.html#id2520856">gimp_unit_get_number_of_units ()</a>
</dt>
<dt>gimp_unit_get_plural, <a href="libgimpbase-gimpunit.html#id2566566">gimp_unit_get_plural ()</a>
</dt>
<dt>gimp_unit_get_singular, <a href="libgimpbase-gimpunit.html#id2566489">gimp_unit_get_singular ()</a>
</dt>
<dt>gimp_unit_get_symbol, <a href="libgimpbase-gimpunit.html#id2566338">gimp_unit_get_symbol ()</a>
</dt>
<dt>gimp_unit_new, <a href="libgimpbase-gimpunit.html#id2520971">gimp_unit_new ()</a>
</dt>
<dt>gimp_unit_set_deletion_flag, <a href="libgimpbase-gimpunit.html#id2529207">gimp_unit_set_deletion_flag ()</a>
</dt>
<dt>gimp_utf8_strtrim, <a href="libgimpbase-gimputils.html#id2562448">gimp_utf8_strtrim ()</a>
</dt>
<dt>GIMP_VALUE_HOLDS_MEMSIZE, <a href="libgimpbase-gimpmemsize.html#id2560585">GIMP_VALUE_HOLDS_MEMSIZE()</a>
</dt>
<dt>GIMP_VALUE_HOLDS_UNIT, <a href="libgimpbase-gimpunit.html#id2566989">GIMP_VALUE_HOLDS_UNIT()</a>
</dt>
<dt>GIMP_VERSION, <a href="libgimpbase-gimpversion.html#id2545746">GIMP_VERSION</a>
</dt>
</dl>
</div></div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimputils.html"><b>&lt;&lt;&#160;gimputils</b></a></td>
<td align="right"><a accesskey="n" href="ix02.html"><b>Index of new symbols in GIMP 2.2&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

75
devel-docs/libgimpbase/html/ix02.html Normal file
View File

@ -0,0 +1,75 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Index of new symbols in GIMP 2.2</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="prev" href="ix01.html" title="Index">
<link rel="next" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="ix01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="ix03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="index">
<div class="titlepage"><div><div><h2 class="title">
<a name="id2506056"></a>Index of new symbols in GIMP 2.2</h2></div></div></div>
<div class="index"><div class="indexdiv">
<h3>G</h3>
<dl>
<dt>gimp_checks_get_shades, <a href="libgimpbase-gimpchecks.html#id2545265">gimp_checks_get_shades ()</a>
</dt>
<dt>gimp_enum_get_desc, <a href="libgimpbase-gimputils.html#id2568821">gimp_enum_get_desc ()</a>
</dt>
<dt>gimp_enum_get_value, <a href="libgimpbase-gimputils.html#id2568952">gimp_enum_get_value ()</a>
</dt>
<dt>gimp_enum_get_value_descriptions, <a href="libgimpbase-gimpbasetypes.html#id2533687">gimp_enum_get_value_descriptions ()</a>
</dt>
<dt>gimp_enum_set_value_descriptions, <a href="libgimpbase-gimpbasetypes.html#id2533577">gimp_enum_set_value_descriptions ()</a>
</dt>
<dt>gimp_enum_value_get_desc, <a href="libgimpbase-gimputils.html#id2569234">gimp_enum_value_get_desc ()</a>
</dt>
<dt>gimp_enum_value_get_help, <a href="libgimpbase-gimputils.html#id2569357">gimp_enum_value_get_help ()</a>
</dt>
<dt>gimp_escape_uline, <a href="libgimpbase-gimputils.html#id2562573">gimp_escape_uline ()</a>
</dt>
<dt>gimp_flags_get_first_desc, <a href="libgimpbase-gimputils.html#id2569480">gimp_flags_get_first_desc ()</a>
</dt>
<dt>gimp_flags_get_first_value, <a href="libgimpbase-gimputils.html#id2569610">gimp_flags_get_first_value ()</a>
</dt>
<dt>gimp_flags_get_value_descriptions, <a href="libgimpbase-gimpbasetypes.html#id2556652">gimp_flags_get_value_descriptions ()</a>
</dt>
<dt>gimp_flags_set_value_descriptions, <a href="libgimpbase-gimpbasetypes.html#id2556753">gimp_flags_set_value_descriptions ()</a>
</dt>
<dt>gimp_flags_value_get_desc, <a href="libgimpbase-gimputils.html#id2569892">gimp_flags_value_get_desc ()</a>
</dt>
<dt>gimp_flags_value_get_help, <a href="libgimpbase-gimputils.html#id2569993">gimp_flags_value_get_help ()</a>
</dt>
<dt>gimp_memsize_deserialize, <a href="libgimpbase-gimpmemsize.html#id2516733">gimp_memsize_deserialize ()</a>
</dt>
<dt>gimp_memsize_serialize, <a href="libgimpbase-gimpmemsize.html#id2534498">gimp_memsize_serialize ()</a>
</dt>
<dt>gimp_type_get_translation_domain, <a href="libgimpbase-gimpbasetypes.html#id2540698">gimp_type_get_translation_domain ()</a>
</dt>
<dt>gimp_type_set_translation_domain, <a href="libgimpbase-gimpbasetypes.html#id2540580">gimp_type_set_translation_domain ()</a>
</dt>
</dl>
</div></div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="ix01.html"><b>&lt;&lt;&#160;Index</b></a></td>
<td align="right"><a accesskey="n" href="ix03.html"><b>Index of new symbols in GIMP 2.4&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

47
devel-docs/libgimpbase/html/ix03.html Normal file
View File

@ -0,0 +1,47 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Index of new symbols in GIMP 2.4</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="prev" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="next" href="ix04.html" title="Index of deprecated symbols">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="ix02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="ix04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="index">
<div class="titlepage"><div><div><h2 class="title">
<a name="id2506064"></a>Index of new symbols in GIMP 2.4</h2></div></div></div>
<div class="index"><div class="indexdiv">
<h3>G</h3>
<dl>
<dt>gimp_canonicalize_identifier, <a href="libgimpbase-gimputils.html#id2568726">gimp_canonicalize_identifier ()</a>
</dt>
<dt>gimp_env_init, <a href="libgimpbase-gimpenv.html#id2545447">gimp_env_init ()</a>
</dt>
<dt>gimp_param_spec_memsize, <a href="libgimpbase-gimpmemsize.html#id2559056">gimp_param_spec_memsize ()</a>
</dt>
<dt>gimp_param_spec_unit, <a href="libgimpbase-gimpunit.html#id2566762">gimp_param_spec_unit ()</a>
</dt>
</dl>
</div></div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="ix02.html"><b>&lt;&lt;&#160;Index of new symbols in GIMP 2.2</b></a></td>
<td align="right"><a accesskey="n" href="ix04.html"><b>Index of deprecated symbols&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

33
devel-docs/libgimpbase/html/ix04.html Normal file
View File

@ -0,0 +1,33 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Index of deprecated symbols</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="prev" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="ix03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
</tr></table>
<div class="index">
<div class="titlepage"><div><div><h2 class="title">
<a name="id2506073"></a>Index of deprecated symbols</h2></div></div></div>
<div class="index"></div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="ix03.html"><b>&lt;&lt;&#160;Index of new symbols in GIMP 2.4</b></a></td>
<td align="right"></td>
</tr></table>
</body>
</html>

414
devel-docs/libgimpbase/html/libgimpbase-gimpbaseenums.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpbaseenums</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="next" href="libgimpbase-gimpbasetypes.html" title="gimpbasetypes">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpbasetypes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2583872" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2515039" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpbaseenums"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2583872"></a><span class="refentrytitle">gimpbaseenums</span>
</h2>
<h2><span class="refentrytitle">gimpbaseenums</span></h2>
<p>gimpbaseenums &#8212; Basic GIMP enumeration data types.</p>
</td>
<td valign="top" align="right"></td>
@ -42,31 +38,132 @@
enum <a href="libgimpbase-gimpbaseenums.html#GimpCheckSize">GimpCheckSize</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpImageBaseType">GimpImageBaseType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpImageType">GimpImageType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpMessageHandlerType">GimpMessageHandlerType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpPDBArgType">GimpPDBArgType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpPDBProcType">GimpPDBProcType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpPDBStatusType">GimpPDBStatusType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpProgressCommand">GimpProgressCommand</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpStackTraceMode">GimpStackTraceMode</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpAddMaskType">GimpAddMaskType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpBlendMode">GimpBlendMode</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpBucketFillMode">GimpBucketFillMode</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpChannelOps">GimpChannelOps</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpChannelType">GimpChannelType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpCheckSize">GimpCheckSize</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpCloneType">GimpCloneType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpDesaturateMode">GimpDesaturateMode</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpDodgeBurnType">GimpDodgeBurnType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpForegroundExtractMode">GimpForegroundExtractMode</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpGradientType">GimpGradientType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpGridStyle">GimpGridStyle</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpIconType">GimpIconType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpImageBaseType">GimpImageBaseType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpImageType">GimpImageType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpInterpolationType">GimpInterpolationType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpMessageHandlerType">GimpMessageHandlerType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpPaintApplicationMode">GimpPaintApplicationMode</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpPDBArgType">GimpPDBArgType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpPDBProcType">GimpPDBProcType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpPDBStatusType">GimpPDBStatusType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpProgressCommand">GimpProgressCommand</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpRepeatMode">GimpRepeatMode</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpSizeType">GimpSizeType</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpStackTraceMode">GimpStackTraceMode</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpTransferMode">GimpTransferMode</a>;
enum <a href="libgimpbase-gimpbaseenums.html#GimpTransformDirection">GimpTransformDirection</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2515039"></a><h2>Description</h2>
<a name="id2492091"></a><h2>Description</h2>
<p>
Basic GIMP enumeration data types.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2515054"></a><h2>Details</h2>
<a name="id2492102"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2515065"></a><h3>
<a name="id2492108"></a><h3>
<a name="GimpAddMaskType"></a>enum GimpAddMaskType</h3>
<a class="indexterm" name="id2492118"></a><pre class="programlisting">typedef enum
{
GIMP_ADD_WHITE_MASK, /*&lt; desc="_White (full opacity)" &gt;*/
GIMP_ADD_BLACK_MASK, /*&lt; desc="_Black (full transparency)" &gt;*/
GIMP_ADD_ALPHA_MASK, /*&lt; desc="Layer's _alpha channel" &gt;*/
GIMP_ADD_ALPHA_TRANSFER_MASK, /*&lt; desc="_Transfer layer's alpha channel" &gt;*/
GIMP_ADD_SELECTION_MASK, /*&lt; desc="_Selection" &gt;*/
GIMP_ADD_COPY_MASK /*&lt; desc="_Grayscale copy of layer" &gt;*/
} GimpAddMaskType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2546778"></a><h3>
<a name="GimpBlendMode"></a>enum GimpBlendMode</h3>
<a class="indexterm" name="id2534122"></a><pre class="programlisting">typedef enum
{
GIMP_FG_BG_RGB_MODE, /*&lt; desc="FG to BG (RGB)" &gt;*/
GIMP_FG_BG_HSV_MODE, /*&lt; desc="FG to BG (HSV)" &gt;*/
GIMP_FG_TRANSPARENT_MODE, /*&lt; desc="FG to transparent" &gt;*/
GIMP_CUSTOM_MODE /*&lt; desc="Custom gradient" &gt;*/
} GimpBlendMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2492147"></a><h3>
<a name="GimpBucketFillMode"></a>enum GimpBucketFillMode</h3>
<a class="indexterm" name="id2492157"></a><pre class="programlisting">typedef enum
{
GIMP_FG_BUCKET_FILL, /*&lt; desc="FG color fill" &gt;*/
GIMP_BG_BUCKET_FILL, /*&lt; desc="BG color fill" &gt;*/
GIMP_PATTERN_BUCKET_FILL /*&lt; desc="Pattern fill" &gt;*/
} GimpBucketFillMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2492175"></a><h3>
<a name="GimpChannelOps"></a>enum GimpChannelOps</h3>
<a class="indexterm" name="id2492186"></a><pre class="programlisting">typedef enum
{
GIMP_CHANNEL_OP_ADD, /*&lt; desc="Add to the current selection" &gt;*/
GIMP_CHANNEL_OP_SUBTRACT, /*&lt; desc="Subtract from the current selection" &gt;*/
GIMP_CHANNEL_OP_REPLACE, /*&lt; desc="Replace the current selection" &gt;*/
GIMP_CHANNEL_OP_INTERSECT /*&lt; desc="Intersect with the current selection" &gt;*/
} GimpChannelOps;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2492207"></a><h3>
<a name="GimpChannelType"></a>enum GimpChannelType</h3>
<a class="indexterm" name="id2492217"></a><pre class="programlisting">typedef enum
{
GIMP_RED_CHANNEL, /*&lt; desc="Red" &gt;*/
GIMP_GREEN_CHANNEL, /*&lt; desc="Green" &gt;*/
GIMP_BLUE_CHANNEL, /*&lt; desc="Blue" &gt;*/
GIMP_GRAY_CHANNEL, /*&lt; desc="Gray" &gt;*/
GIMP_INDEXED_CHANNEL, /*&lt; desc="Indexed" &gt;*/
GIMP_ALPHA_CHANNEL /*&lt; desc="Alpha" &gt;*/
} GimpChannelType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2492238"></a><h3>
<a name="GimpCheckSize"></a>enum GimpCheckSize</h3>
<a class="indexterm" name="id2515077"></a><pre class="programlisting">typedef enum /*&lt; pdb-skip &gt;*/
<a class="indexterm" name="id2492248"></a><pre class="programlisting">typedef enum /*&lt; pdb-skip &gt;*/
{
GIMP_CHECK_SIZE_SMALL_CHECKS = 0, /*&lt; desc="Small" &gt;*/
GIMP_CHECK_SIZE_MEDIUM_CHECKS = 1, /*&lt; desc="Medium" &gt;*/
@ -79,16 +176,16 @@ Basic GIMP enumeration data types.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2515097"></a><h3>
<a name="id2534136"></a><h3>
<a name="GimpCheckType"></a>enum GimpCheckType</h3>
<a class="indexterm" name="id2515109"></a><pre class="programlisting">typedef enum /*&lt; pdb-skip &gt;*/
<a class="indexterm" name="id2534146"></a><pre class="programlisting">typedef enum /*&lt; pdb-skip &gt;*/
{
GIMP_CHECK_TYPE_LIGHT_CHECKS = 0, /*&lt; desc="Light Checks" &gt;*/
GIMP_CHECK_TYPE_GRAY_CHECKS = 1, /*&lt; desc="Mid-Tone Checks" &gt;*/
GIMP_CHECK_TYPE_DARK_CHECKS = 2, /*&lt; desc="Dark Checks" &gt;*/
GIMP_CHECK_TYPE_WHITE_ONLY = 3, /*&lt; desc="White Only" &gt;*/
GIMP_CHECK_TYPE_GRAY_ONLY = 4, /*&lt; desc="Gray Only" &gt;*/
GIMP_CHECK_TYPE_BLACK_ONLY = 5 /*&lt; desc="Black Only" &gt;*/
GIMP_CHECK_TYPE_LIGHT_CHECKS = 0, /*&lt; desc="Light checks" &gt;*/
GIMP_CHECK_TYPE_GRAY_CHECKS = 1, /*&lt; desc="Mid-tone checks" &gt;*/
GIMP_CHECK_TYPE_DARK_CHECKS = 2, /*&lt; desc="Dark checks" &gt;*/
GIMP_CHECK_TYPE_WHITE_ONLY = 3, /*&lt; desc="White only" &gt;*/
GIMP_CHECK_TYPE_GRAY_ONLY = 4, /*&lt; desc="Gray only" &gt;*/
GIMP_CHECK_TYPE_BLACK_ONLY = 5 /*&lt; desc="Black only" &gt;*/
} GimpCheckType;
</pre>
<p>
@ -97,9 +194,120 @@ Basic GIMP enumeration data types.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2515132"></a><h3>
<a name="id2534169"></a><h3>
<a name="GimpCloneType"></a>enum GimpCloneType</h3>
<a class="indexterm" name="id2534180"></a><pre class="programlisting">typedef enum
{
GIMP_IMAGE_CLONE, /*&lt; desc="Image source" &gt;*/
GIMP_PATTERN_CLONE /*&lt; desc="Pattern source" &gt;*/
} GimpCloneType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534197"></a><h3>
<a name="GimpDesaturateMode"></a>enum GimpDesaturateMode</h3>
<a class="indexterm" name="id2534208"></a><pre class="programlisting">typedef enum
{
GIMP_DESATURATE_LIGHTNESS, /*&lt; desc="Lightness" &gt;*/
GIMP_DESATURATE_LUMINOSITY, /*&lt; desc="Luminosity" &gt;*/
GIMP_DESATURATE_AVERAGE /*&lt; desc="Average" &gt;*/
} GimpDesaturateMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534226"></a><h3>
<a name="GimpDodgeBurnType"></a>enum GimpDodgeBurnType</h3>
<a class="indexterm" name="id2534236"></a><pre class="programlisting">typedef enum
{
GIMP_DODGE, /*&lt; desc="Dodge" &gt;*/
GIMP_BURN /*&lt; desc="Burn" &gt;*/
} GimpDodgeBurnType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534253"></a><h3>
<a name="GimpForegroundExtractMode"></a>enum GimpForegroundExtractMode</h3>
<a class="indexterm" name="id2534262"></a><pre class="programlisting">typedef enum
{
GIMP_FOREGROUND_EXTRACT_SIOX
} GimpForegroundExtractMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534279"></a><h3>
<a name="GimpGradientType"></a>enum GimpGradientType</h3>
<a class="indexterm" name="id2534289"></a><pre class="programlisting">typedef enum
{
GIMP_GRADIENT_LINEAR, /*&lt; desc="Linear" &gt;*/
GIMP_GRADIENT_BILINEAR, /*&lt; desc="Bi-linear" &gt;*/
GIMP_GRADIENT_RADIAL, /*&lt; desc="Radial" &gt;*/
GIMP_GRADIENT_SQUARE, /*&lt; desc="Square" &gt;*/
GIMP_GRADIENT_CONICAL_SYMMETRIC, /*&lt; desc="Conical (sym)" &gt;*/
GIMP_GRADIENT_CONICAL_ASYMMETRIC, /*&lt; desc="Conical (asym)" &gt;*/
GIMP_GRADIENT_SHAPEBURST_ANGULAR, /*&lt; desc="Shaped (angular)" &gt;*/
GIMP_GRADIENT_SHAPEBURST_SPHERICAL, /*&lt; desc="Shaped (spherical)"&gt;*/
GIMP_GRADIENT_SHAPEBURST_DIMPLED, /*&lt; desc="Shaped (dimpled)" &gt;*/
GIMP_GRADIENT_SPIRAL_CLOCKWISE, /*&lt; desc="Spiral (cw)" &gt;*/
GIMP_GRADIENT_SPIRAL_ANTICLOCKWISE /*&lt; desc="Spiral (ccw)" &gt;*/
} GimpGradientType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534316"></a><h3>
<a name="GimpGridStyle"></a>enum GimpGridStyle</h3>
<a class="indexterm" name="id2534326"></a><pre class="programlisting">typedef enum
{
GIMP_GRID_DOTS, /*&lt; desc="Intersections (dots)" &gt;*/
GIMP_GRID_INTERSECTIONS, /*&lt; desc="Intersections (crosshairs)" &gt;*/
GIMP_GRID_ON_OFF_DASH, /*&lt; desc="Dashed" &gt;*/
GIMP_GRID_DOUBLE_DASH, /*&lt; desc="Double dashed" &gt;*/
GIMP_GRID_SOLID /*&lt; desc="Solid" &gt;*/
} GimpGridStyle;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534348"></a><h3>
<a name="GimpIconType"></a>enum GimpIconType</h3>
<a class="indexterm" name="id2534358"></a><pre class="programlisting">typedef enum
{
GIMP_ICON_TYPE_STOCK_ID, /*&lt; desc="Stock ID" &gt;*/
GIMP_ICON_TYPE_INLINE_PIXBUF, /*&lt; desc="Inline pixbuf" &gt;*/
GIMP_ICON_TYPE_IMAGE_FILE /*&lt; desc="Image file" &gt;*/
} GimpIconType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2534378"></a><h3>
<a name="GimpImageBaseType"></a>enum GimpImageBaseType</h3>
<a class="indexterm" name="id2515145"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2474107"></a><pre class="programlisting">typedef enum
{
GIMP_RGB, /*&lt; desc="RGB color" &gt;*/
GIMP_GRAY, /*&lt; desc="Grayscale" &gt;*/
@ -112,9 +320,9 @@ Basic GIMP enumeration data types.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2509965"></a><h3>
<a name="id2474124"></a><h3>
<a name="GimpImageType"></a>enum GimpImageType</h3>
<a class="indexterm" name="id2509978"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2474134"></a><pre class="programlisting">typedef enum
{
GIMP_RGB_IMAGE, /*&lt; desc="RGB" &gt;*/
GIMP_RGBA_IMAGE, /*&lt; desc="RGB-alpha" &gt;*/
@ -130,9 +338,25 @@ Basic GIMP enumeration data types.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2509999"></a><h3>
<a name="id2474156"></a><h3>
<a name="GimpInterpolationType"></a>enum GimpInterpolationType</h3>
<a class="indexterm" name="id2474165"></a><pre class="programlisting">typedef enum
{
GIMP_INTERPOLATION_NONE, /*&lt; desc="None (Fastest)" &gt;*/
GIMP_INTERPOLATION_LINEAR, /*&lt; desc="Linear" &gt;*/
GIMP_INTERPOLATION_CUBIC, /*&lt; desc="Cubic" &gt;*/
GIMP_INTERPOLATION_LANCZOS /*&lt; desc="Lanczos (Best)" &gt;*/
} GimpInterpolationType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2474185"></a><h3>
<a name="GimpMessageHandlerType"></a>enum GimpMessageHandlerType</h3>
<a class="indexterm" name="id2510010"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2474194"></a><pre class="programlisting">typedef enum
{
GIMP_MESSAGE_BOX,
GIMP_CONSOLE,
@ -145,9 +369,23 @@ Basic GIMP enumeration data types.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2510027"></a><h3>
<a name="id2474210"></a><h3>
<a name="GimpPaintApplicationMode"></a>enum GimpPaintApplicationMode</h3>
<a class="indexterm" name="id2474219"></a><pre class="programlisting">typedef enum
{
GIMP_PAINT_CONSTANT, /*&lt; desc="Constant" &gt;*/
GIMP_PAINT_INCREMENTAL /*&lt; desc="Incremental" &gt;*/
} GimpPaintApplicationMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2474237"></a><h3>
<a name="GimpPDBArgType"></a>enum GimpPDBArgType</h3>
<a class="indexterm" name="id2510040"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2474247"></a><pre class="programlisting">typedef enum
{
GIMP_PDB_INT32,
GIMP_PDB_INT16,
@ -180,14 +418,14 @@ Basic GIMP enumeration data types.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2510063"></a><h3>
<a name="id2474271"></a><h3>
<a name="GimpPDBProcType"></a>enum GimpPDBProcType</h3>
<a class="indexterm" name="id2510076"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2474281"></a><pre class="programlisting">typedef enum
{
GIMP_INTERNAL,
GIMP_PLUGIN,
GIMP_EXTENSION,
GIMP_TEMPORARY
GIMP_INTERNAL, /*&lt; desc="Internal GIMP procedure" &gt;*/
GIMP_PLUGIN, /*&lt; desc="GIMP Plug-In" &gt;*/
GIMP_EXTENSION, /*&lt; desc="GIMP Extension" &gt;*/
GIMP_TEMPORARY /*&lt; desc="Temporary Procedure" &gt;*/
} GimpPDBProcType;
</pre>
<p>
@ -196,9 +434,9 @@ Basic GIMP enumeration data types.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2532965"></a><h3>
<a name="id2474300"></a><h3>
<a name="GimpPDBStatusType"></a>enum GimpPDBStatusType</h3>
<a class="indexterm" name="id2532978"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2474310"></a><pre class="programlisting">typedef enum
{
GIMP_PDB_EXECUTION_ERROR,
GIMP_PDB_CALLING_ERROR,
@ -213,14 +451,16 @@ Basic GIMP enumeration data types.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2532995"></a><h3>
<a name="id2474328"></a><h3>
<a name="GimpProgressCommand"></a>enum GimpProgressCommand</h3>
<a class="indexterm" name="id2533008"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2474338"></a><pre class="programlisting">typedef enum
{
GIMP_PROGRESS_COMMAND_START,
GIMP_PROGRESS_COMMAND_END,
GIMP_PROGRESS_COMMAND_SET_TEXT,
GIMP_PROGRESS_COMMAND_SET_VALUE
GIMP_PROGRESS_COMMAND_SET_VALUE,
GIMP_PROGRESS_COMMAND_PULSE,
GIMP_PROGRESS_COMMAND_GET_WINDOW
} GimpProgressCommand;
</pre>
<p>
@ -229,9 +469,38 @@ Basic GIMP enumeration data types.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2533026"></a><h3>
<a name="id2474357"></a><h3>
<a name="GimpRepeatMode"></a>enum GimpRepeatMode</h3>
<a class="indexterm" name="id2474368"></a><pre class="programlisting">typedef enum
{
GIMP_REPEAT_NONE, /*&lt; desc="None" &gt;*/
GIMP_REPEAT_SAWTOOTH, /*&lt; desc="Sawtooth wave" &gt;*/
GIMP_REPEAT_TRIANGULAR /*&lt; desc="Triangular wave" &gt;*/
} GimpRepeatMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556865"></a><h3>
<a name="GimpSizeType"></a>enum GimpSizeType</h3>
<a class="indexterm" name="id2556873"></a><pre class="programlisting">typedef enum
{
GIMP_PIXELS, /*&lt; desc="Pixels" &gt;*/
GIMP_POINTS /*&lt; desc="Points" &gt;*/
} GimpSizeType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556888"></a><h3>
<a name="GimpStackTraceMode"></a>enum GimpStackTraceMode</h3>
<a class="indexterm" name="id2533038"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2556897"></a><pre class="programlisting">typedef enum
{
GIMP_STACK_TRACE_NEVER,
GIMP_STACK_TRACE_QUERY,
@ -242,7 +511,40 @@ Basic GIMP enumeration data types.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556912"></a><h3>
<a name="GimpTransferMode"></a>enum GimpTransferMode</h3>
<a class="indexterm" name="id2556921"></a><pre class="programlisting">typedef enum
{
GIMP_SHADOWS, /*&lt; desc="Shadows" &gt;*/
GIMP_MIDTONES, /*&lt; desc="Midtones" &gt;*/
GIMP_HIGHLIGHTS /*&lt; desc="Highlights" &gt;*/
} GimpTransferMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556938"></a><h3>
<a name="GimpTransformDirection"></a>enum GimpTransformDirection</h3>
<a class="indexterm" name="id2556946"></a><pre class="programlisting">typedef enum
{
GIMP_TRANSFORM_FORWARD, /*&lt; desc="Forward" &gt;*/
GIMP_TRANSFORM_BACKWARD /*&lt; desc="Backward" &gt;*/
} GimpTransformDirection;
</pre>
<p>
</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase.html"><b>&lt;&lt;&#160;Part&#160;I.&#160;GIMP Base Library</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpbasetypes.html"><b>gimpbasetypes&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

150
devel-docs/libgimpbase/html/libgimpbase-gimpbasetypes.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpbasetypes</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpbaseenums.html" title="gimpbaseenums">
<link rel="next" href="libgimpbase-gimpversion.html" title="gimpversion">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpbaseenums.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpversion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2572201" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2584526" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpbasetypes"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2572201"></a><span class="refentrytitle">gimpbasetypes</span>
</h2>
<h2><span class="refentrytitle">gimpbasetypes</span></h2>
<p>gimpbasetypes &#8212; Translation between gettext translation domain identifier and GType.</p>
</td>
<td valign="top" align="right"></td>
@ -42,31 +38,37 @@
<a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>;
<a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>;
void <a href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain">gimp_type_set_translation_domain</a> (GType type,
const gchar *domain);
const gchar* <a href="libgimpbase-gimpbasetypes.html#gimp-type-get-translation-domain">gimp_type_get_translation_domain</a> (GType type);
void <a href="libgimpbase-gimpbasetypes.html#gimp-enum-set-value-descriptions">gimp_enum_set_value_descriptions</a> (GType enum_type,
const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a> *descriptions);
const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a href="libgimpbase-gimpbasetypes.html#gimp-enum-get-value-descriptions">gimp_enum_get_value_descriptions</a> (GType enum_type);
const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a href="libgimpbase-gimpbasetypes.html#gimp-flags-get-value-descriptions">gimp_flags_get_value_descriptions</a> (GType flags_type);
void <a href="libgimpbase-gimpbasetypes.html#gimp-flags-set-value-descriptions">gimp_flags_set_value_descriptions</a> (GType flags_type,
const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a> *descriptions);
<a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>;
<a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>;
void <a href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain">gimp_type_set_translation_domain</a>
(GType type,
const gchar *domain);
const gchar* <a href="libgimpbase-gimpbasetypes.html#gimp-type-get-translation-domain">gimp_type_get_translation_domain</a>
(GType type);
void <a href="libgimpbase-gimpbasetypes.html#gimp-enum-set-value-descriptions">gimp_enum_set_value_descriptions</a>
(GType enum_type,
const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a> *descriptions);
const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a href="libgimpbase-gimpbasetypes.html#gimp-enum-get-value-descriptions">gimp_enum_get_value_descriptions</a>
(GType enum_type);
const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a href="libgimpbase-gimpbasetypes.html#gimp-flags-get-value-descriptions">gimp_flags_get_value_descriptions</a>
(GType flags_type);
void <a href="libgimpbase-gimpbasetypes.html#gimp-flags-set-value-descriptions">gimp_flags_set_value_descriptions</a>
(GType flags_type,
const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a> *descriptions);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2584526"></a><h2>Description</h2>
<a name="id2550026"></a><h2>Description</h2>
<p>
Translation between gettext translation domain identifier and GType.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2584543"></a><h2>Details</h2>
<a name="id2550038"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2581386"></a><h3>
<a name="id2550044"></a><h3>
<a name="GimpEnumDesc"></a>GimpEnumDesc</h3>
<a class="indexterm" name="id2581398"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2550054"></a><pre class="programlisting">typedef struct {
gint value;
gchar *value_desc;
gchar *value_help;
@ -78,9 +80,9 @@ Translation between gettext translation domain identifier and GType.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581415"></a><h3>
<a name="id2540553"></a><h3>
<a name="GimpFlagsDesc"></a>GimpFlagsDesc</h3>
<a class="indexterm" name="id2581428"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2540563"></a><pre class="programlisting">typedef struct {
guint value;
gchar *value_desc;
gchar *value_help;
@ -92,10 +94,11 @@ Translation between gettext translation domain identifier and GType.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581445"></a><h3>
<a name="id2540580"></a><h3>
<a name="gimp-type-set-translation-domain"></a>gimp_type_set_translation_domain ()</h3>
<a class="indexterm" name="id2581460"></a><pre class="programlisting">void gimp_type_set_translation_domain (GType type,
const gchar *domain);</pre>
<a class="indexterm" name="id2540591"></a><pre class="programlisting">void gimp_type_set_translation_domain
(GType type,
const gchar *domain);</pre>
<p>
This function attaches a constant string as a gettext translation
domain identifier to a <span class="type">GType</span>. The only purpose of this function is
@ -108,25 +111,28 @@ names.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td> a <span class="type">GType</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>domain</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>domain</code></em>&#160;:</span></td>
<td> a constant string that identifies a translation domain or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592564"></a><h3>
<a name="id2540698"></a><h3>
<a name="gimp-type-get-translation-domain"></a>gimp_type_get_translation_domain ()</h3>
<a class="indexterm" name="id2592580"></a><pre class="programlisting">const gchar* gimp_type_get_translation_domain (GType type);</pre>
<a class="indexterm" name="id2533461"></a><pre class="programlisting">const gchar* gimp_type_get_translation_domain
(GType type);</pre>
<p>
Retrieves the gettext translation domain identifier that has been
previously set using <a href="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain"><code class="function">gimp_type_set_translation_domain()</code></a>. You should
@ -139,12 +145,14 @@ or <code class="function">gimp_enum_value_get_name()</code> instead.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td> a <span class="type">GType</span>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the translation domain associated with <em class="parameter"><code>type</code></em>
or <code class="literal">NULL</code> if no domain was set
@ -152,15 +160,16 @@ or <code class="function">gimp_enum_value_get_name()</code> instead.</p>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592701"></a><h3>
<a name="id2533577"></a><h3>
<a name="gimp-enum-set-value-descriptions"></a>gimp_enum_set_value_descriptions ()</h3>
<a class="indexterm" name="id2592717"></a><pre class="programlisting">void gimp_enum_set_value_descriptions (GType enum_type,
const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a> *descriptions);</pre>
<a class="indexterm" name="id2533588"></a><pre class="programlisting">void gimp_enum_set_value_descriptions
(GType enum_type,
const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a> *descriptions);</pre>
<p>
Sets the array of human readable and translatable descriptions
and help texts for enum values.</p>
@ -171,25 +180,28 @@ and help texts for enum values.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
<td> a <span class="type">GType</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>descriptions</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>descriptions</code></em>&#160;:</span></td>
<td> a <code class="literal">NULL</code> terminated constant static array of <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2510505"></a><h3>
<a name="id2533687"></a><h3>
<a name="gimp-enum-get-value-descriptions"></a>gimp_enum_get_value_descriptions ()</h3>
<a class="indexterm" name="id2510521"></a><pre class="programlisting">const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_value_descriptions (GType enum_type);</pre>
<a class="indexterm" name="id2533698"></a><pre class="programlisting">const <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_value_descriptions
(GType enum_type);</pre>
<p>
Retreives the array of human readable and translatable descriptions
and help texts for enum values.</p>
@ -200,26 +212,29 @@ and help texts for enum values.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
<td> a <span class="type">GType</span>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a <code class="literal">NULL</code> terminated constant array of <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2510615"></a><h3>
<a name="id2556652"></a><h3>
<a name="gimp-flags-get-value-descriptions"></a>gimp_flags_get_value_descriptions ()</h3>
<a class="indexterm" name="id2510630"></a><pre class="programlisting">const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_value_descriptions (GType flags_type);</pre>
<a class="indexterm" name="id2556663"></a><pre class="programlisting">const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_value_descriptions
(GType flags_type);</pre>
<p>
Retreives the array of human readable and translatable descriptions
and help texts for flags values.</p>
@ -230,27 +245,30 @@ and help texts for flags values.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></td>
<td> a <span class="type">GType</span>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a <code class="literal">NULL</code> terminated constant array of <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2510724"></a><h3>
<a name="id2556753"></a><h3>
<a name="gimp-flags-set-value-descriptions"></a>gimp_flags_set_value_descriptions ()</h3>
<a class="indexterm" name="id2510740"></a><pre class="programlisting">void gimp_flags_set_value_descriptions (GType flags_type,
const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a> *descriptions);</pre>
<a class="indexterm" name="id2556764"></a><pre class="programlisting">void gimp_flags_set_value_descriptions
(GType flags_type,
const <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a> *descriptions);</pre>
<p>
Sets the array of human readable and translatable descriptions
and help texts for flags values.</p>
@ -261,21 +279,27 @@ and help texts for flags values.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></td>
<td> a <span class="type">GType</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>descriptions</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>descriptions</code></em>&#160;:</span></td>
<td> a <code class="literal">NULL</code> terminated constant static array of <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpbaseenums.html"><b>&lt;&lt;&#160;gimpbaseenums</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpversion.html"><b>gimpversion&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

79
devel-docs/libgimpbase/html/libgimpbase-gimpchecks.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpchecks</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimplimits.html" title="gimplimits">
<link rel="next" href="libgimpbase-gimpdatafiles.html" title="gimpdatafiles">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimplimits.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpdatafiles.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2585527" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2566485" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpchecks"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2585527"></a><span class="refentrytitle">gimpchecks</span>
</h2>
<h2><span class="refentrytitle">gimpchecks</span></h2>
<p>gimpchecks &#8212; Constants and functions related to rendering checkerboards.</p>
</td>
<td valign="top" align="right"></td>
@ -42,27 +38,27 @@
#define <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE:CAPS">GIMP_CHECK_SIZE</a>
#define <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE-SM:CAPS">GIMP_CHECK_SIZE_SM</a>
#define <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-DARK:CAPS">GIMP_CHECK_DARK</a>
#define <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-LIGHT:CAPS">GIMP_CHECK_LIGHT</a>
void <a href="libgimpbase-gimpchecks.html#gimp-checks-get-shades">gimp_checks_get_shades</a> (<a href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a> type,
guchar *light,
guchar *dark);
#define <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE:CAPS">GIMP_CHECK_SIZE</a>
#define <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE-SM:CAPS">GIMP_CHECK_SIZE_SM</a>
#define <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-DARK:CAPS">GIMP_CHECK_DARK</a>
#define <a href="libgimpbase-gimpchecks.html#GIMP-CHECK-LIGHT:CAPS">GIMP_CHECK_LIGHT</a>
void <a href="libgimpbase-gimpchecks.html#gimp-checks-get-shades">gimp_checks_get_shades</a> (<a href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a> type,
guchar *light,
guchar *dark);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2566485"></a><h2>Description</h2>
<a name="id2536536"></a><h2>Description</h2>
<p>
Constants and functions related to rendering checkerboards.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2566502"></a><h2>Details</h2>
<a name="id2536547"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2566513"></a><h3>
<a name="id2536553"></a><h3>
<a name="GIMP-CHECK-SIZE:CAPS"></a>GIMP_CHECK_SIZE</h3>
<a class="indexterm" name="id2566524"></a><pre class="programlisting">#define GIMP_CHECK_SIZE 8
<a class="indexterm" name="id2536562"></a><pre class="programlisting">#define GIMP_CHECK_SIZE 8
</pre>
<p>
The default checkerboard size in pixels. This is configurable in the
@ -72,9 +68,9 @@ this constant instead.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2566543"></a><h3>
<a name="id2536580"></a><h3>
<a name="GIMP-CHECK-SIZE-SM:CAPS"></a>GIMP_CHECK_SIZE_SM</h3>
<a class="indexterm" name="id2566554"></a><pre class="programlisting">#define GIMP_CHECK_SIZE_SM 4
<a class="indexterm" name="id2536590"></a><pre class="programlisting">#define GIMP_CHECK_SIZE_SM 4
</pre>
<p>
The default small checkerboard size in pixels.
@ -82,9 +78,9 @@ The default small checkerboard size in pixels.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588728"></a><h3>
<a name="id2536606"></a><h3>
<a name="GIMP-CHECK-DARK:CAPS"></a>GIMP_CHECK_DARK</h3>
<a class="indexterm" name="id2588740"></a><pre class="programlisting">#define GIMP_CHECK_DARK 0.4
<a class="indexterm" name="id2536615"></a><pre class="programlisting">#define GIMP_CHECK_DARK 0.4
</pre>
<p>
The dark gray value for the default checkerboard pattern.
@ -92,9 +88,9 @@ The dark gray value for the default checkerboard pattern.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588756"></a><h3>
<a name="id2536631"></a><h3>
<a name="GIMP-CHECK-LIGHT:CAPS"></a>GIMP_CHECK_LIGHT</h3>
<a class="indexterm" name="id2588768"></a><pre class="programlisting">#define GIMP_CHECK_LIGHT 0.6
<a class="indexterm" name="id2536641"></a><pre class="programlisting">#define GIMP_CHECK_LIGHT 0.6
</pre>
<p>
The light gray value for the default checkerboard pattern.
@ -102,11 +98,11 @@ The light gray value for the default checkerboard pattern.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588784"></a><h3>
<a name="id2545265"></a><h3>
<a name="gimp-checks-get-shades"></a>gimp_checks_get_shades ()</h3>
<a class="indexterm" name="id2588798"></a><pre class="programlisting">void gimp_checks_get_shades (<a href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a> type,
guchar *light,
guchar *dark);</pre>
<a class="indexterm" name="id2545274"></a><pre class="programlisting">void gimp_checks_get_shades (<a href="libgimpbase-gimpbaseenums.html#GimpCheckType">GimpCheckType</a> type,
guchar *light,
guchar *dark);</pre>
<p>
Retrieves the actual shades of gray to use when drawing a
checkerboard for a certain <a href="libgimpbase-gimpbaseenums.html#GimpCheckType"><span class="type">GimpCheckType</span></a>.</p>
@ -117,26 +113,33 @@ checkerboard for a certain <a href="libgimpbase-gimpbaseenums.html#GimpCheckType
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td> the checkerboard type
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>light</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>light</code></em>&#160;:</span></td>
<td> return location for the light shade
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>dark</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>dark</code></em>&#160;:</span></td>
<td> return location for the dark shade
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimplimits.html"><b>&lt;&lt;&#160;gimplimits</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpdatafiles.html"><b>gimpdatafiles&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

101
devel-docs/libgimpbase/html/libgimpbase-gimpdatafiles.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpdatafiles</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpchecks.html" title="gimpchecks">
<link rel="next" href="libgimpbase-gimpenv.html" title="gimpenv">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpchecks.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpenv.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2571990" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2580943" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpdatafiles"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2571990"></a><span class="refentrytitle">gimpdatafiles</span>
</h2>
<h2><span class="refentrytitle">gimpdatafiles</span></h2>
<p>gimpdatafiles &#8212; Functions to handle GIMP data files.</p>
</td>
<td valign="top" align="right"></td>
@ -42,29 +38,29 @@
<a href="libgimpbase-gimpdatafiles.html#GimpDatafileData">GimpDatafileData</a>;
void (<a href="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc">*GimpDatafileLoaderFunc</a>) (const <a href="libgimpbase-gimpdatafiles.html#GimpDatafileData">GimpDatafileData</a> *file_data,
gpointer user_data);
gboolean <a href="libgimpbase-gimpdatafiles.html#gimp-datafiles-check-extension">gimp_datafiles_check_extension</a> (const gchar *filename,
const gchar *extension);
void <a href="libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories">gimp_datafiles_read_directories</a> (const gchar *path_str,
GFileTest flags,
<a href="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc">GimpDatafileLoaderFunc</a> loader_func,
gpointer user_data);
<a href="libgimpbase-gimpdatafiles.html#GimpDatafileData">GimpDatafileData</a>;
void (<a href="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc">*GimpDatafileLoaderFunc</a>) (const <a href="libgimpbase-gimpdatafiles.html#GimpDatafileData">GimpDatafileData</a> *file_data,
gpointer user_data);
gboolean <a href="libgimpbase-gimpdatafiles.html#gimp-datafiles-check-extension">gimp_datafiles_check_extension</a> (const gchar *filename,
const gchar *extension);
void <a href="libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories">gimp_datafiles_read_directories</a> (const gchar *path_str,
GFileTest flags,
<a href="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc">GimpDatafileLoaderFunc</a> loader_func,
gpointer user_data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2580943"></a><h2>Description</h2>
<a name="id2534571"></a><h2>Description</h2>
<p>
Functions to handle GIMP data files.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2580958"></a><h2>Details</h2>
<a name="id2534582"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2580969"></a><h3>
<a name="id2534588"></a><h3>
<a name="GimpDatafileData"></a>GimpDatafileData</h3>
<a class="indexterm" name="id2580981"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2534598"></a><pre class="programlisting">typedef struct {
const gchar *filename;
const gchar *dirname;
const gchar *basename;
@ -80,10 +76,10 @@ Functions to handle GIMP data files.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2583229"></a><h3>
<a name="id2534616"></a><h3>
<a name="GimpDatafileLoaderFunc"></a>GimpDatafileLoaderFunc ()</h3>
<a class="indexterm" name="id2583240"></a><pre class="programlisting">void (*GimpDatafileLoaderFunc) (const <a href="libgimpbase-gimpdatafiles.html#GimpDatafileData">GimpDatafileData</a> *file_data,
gpointer user_data);</pre>
<a class="indexterm" name="id2534625"></a><pre class="programlisting">void (*GimpDatafileLoaderFunc) (const <a href="libgimpbase-gimpdatafiles.html#GimpDatafileData">GimpDatafileData</a> *file_data,
gpointer user_data);</pre>
<p>
</p>
@ -91,12 +87,14 @@ Functions to handle GIMP data files.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>file_data</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>file_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
@ -107,10 +105,10 @@ Functions to handle GIMP data files.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2583307"></a><h3>
<a name="id2536427"></a><h3>
<a name="gimp-datafiles-check-extension"></a>gimp_datafiles_check_extension ()</h3>
<a class="indexterm" name="id2583318"></a><pre class="programlisting">gboolean gimp_datafiles_check_extension (const gchar *filename,
const gchar *extension);</pre>
<a class="indexterm" name="id2536436"></a><pre class="programlisting">gboolean gimp_datafiles_check_extension (const gchar *filename,
const gchar *extension);</pre>
<p>
</p>
@ -118,17 +116,20 @@ Functions to handle GIMP data files.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>extension</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>extension</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -139,12 +140,12 @@ Functions to handle GIMP data files.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592053"></a><h3>
<a name="id2536511"></a><h3>
<a name="gimp-datafiles-read-directories"></a>gimp_datafiles_read_directories ()</h3>
<a class="indexterm" name="id2592064"></a><pre class="programlisting">void gimp_datafiles_read_directories (const gchar *path_str,
GFileTest flags,
<a href="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc">GimpDatafileLoaderFunc</a> loader_func,
gpointer user_data);</pre>
<a class="indexterm" name="id2536521"></a><pre class="programlisting">void gimp_datafiles_read_directories (const gchar *path_str,
GFileTest flags,
<a href="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc">GimpDatafileLoaderFunc</a> loader_func,
gpointer user_data);</pre>
<p>
</p>
@ -152,22 +153,26 @@ Functions to handle GIMP data files.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>path_str</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>path_str</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>loader_func</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>loader_func</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
@ -178,5 +183,9 @@ Functions to handle GIMP data files.
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpchecks.html"><b>&lt;&lt;&#160;gimpchecks</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpenv.html"><b>gimpenv&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

231
devel-docs/libgimpbase/html/libgimpbase-gimpenv.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpenv</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpdatafiles.html" title="gimpdatafiles">
<link rel="next" href="libgimpbase-gimpmemsize.html" title="gimpmemsize">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpdatafiles.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpmemsize.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2573894" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2574488" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpenv"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2573894"></a><span class="refentrytitle">gimpenv</span>
</h2>
<h2><span class="refentrytitle">gimpenv</span></h2>
<p>gimpenv &#8212; Functions to access the GIMP environment.</p>
</td>
<td valign="top" align="right"></td>
@ -42,35 +38,62 @@
const gchar* <a href="libgimpbase-gimpenv.html#gimp-directory">gimp_directory</a> (void);
gchar* <a href="libgimpbase-gimpenv.html#gimp-personal-rc-file">gimp_personal_rc_file</a> (const gchar *basename);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-data-directory">gimp_data_directory</a> (void);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-locale-directory">gimp_locale_directory</a> (void);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-plug-in-directory">gimp_plug_in_directory</a> (void);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-sysconf-directory">gimp_sysconf_directory</a> (void);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-gtkrc">gimp_gtkrc</a> (void);
GList* <a href="libgimpbase-gimpenv.html#gimp-path-parse">gimp_path_parse</a> (const gchar *path,
gint max_paths,
gboolean check,
GList **check_failed);
gchar* <a href="libgimpbase-gimpenv.html#gimp-path-to-str">gimp_path_to_str</a> (GList *path);
void <a href="libgimpbase-gimpenv.html#gimp-path-free">gimp_path_free</a> (GList *path);
gchar* <a href="libgimpbase-gimpenv.html#gimp-path-get-user-writable-dir">gimp_path_get_user_writable_dir</a> (GList *path);
void <a href="libgimpbase-gimpenv.html#gimp-env-init">gimp_env_init</a> (gboolean plug_in);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-directory">gimp_directory</a> (void);
gchar* <a href="libgimpbase-gimpenv.html#gimp-personal-rc-file">gimp_personal_rc_file</a> (const gchar *basename);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-data-directory">gimp_data_directory</a> (void);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-locale-directory">gimp_locale_directory</a> (void);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-plug-in-directory">gimp_plug_in_directory</a> (void);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-sysconf-directory">gimp_sysconf_directory</a> (void);
const gchar* <a href="libgimpbase-gimpenv.html#gimp-gtkrc">gimp_gtkrc</a> (void);
GList* <a href="libgimpbase-gimpenv.html#gimp-path-parse">gimp_path_parse</a> (const gchar *path,
gint max_paths,
gboolean check,
GList **check_failed);
gchar* <a href="libgimpbase-gimpenv.html#gimp-path-to-str">gimp_path_to_str</a> (GList *path);
void <a href="libgimpbase-gimpenv.html#gimp-path-free">gimp_path_free</a> (GList *path);
gchar* <a href="libgimpbase-gimpenv.html#gimp-path-get-user-writable-dir">gimp_path_get_user_writable_dir</a> (GList *path);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2574488"></a><h2>Description</h2>
<a name="id2539698"></a><h2>Description</h2>
<p>
A set of functions to find the locations of GIMP's data directories and
configuration files.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2574505"></a><h2>Details</h2>
<a name="id2545441"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2574516"></a><h3>
<a name="id2545447"></a><h3>
<a name="gimp-env-init"></a>gimp_env_init ()</h3>
<a class="indexterm" name="id2545458"></a><pre class="programlisting">void gimp_env_init (gboolean plug_in);</pre>
<p>
You don't need to care about this function. It is being called for
you automatically (by means of the <a
href="../libgimp/libgimp-gimp.html#MAIN:CAPS"
><code class="function">MAIN()</code></a> macro that every plug-in
runs). Calling it again will cause a fatal error.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>plug_in</code></em>&#160;:</span></td>
<td> must be <code class="literal">TRUE</code> if this function is called from a plug-in
</td>
</tr></tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2545529"></a><h3>
<a name="gimp-directory"></a>gimp_directory ()</h3>
<a class="indexterm" name="id2574529"></a><pre class="programlisting">const gchar* gimp_directory (void);</pre>
<a class="indexterm" name="id2545539"></a><pre class="programlisting">const gchar* gimp_directory (void);</pre>
<p>
Returns the user-specific GIMP settings directory. If the
environment variable GIMP2_DIRECTORY exists, it is used. If it is
@ -88,17 +111,17 @@ return some non-empty string, whether it corresponds to an existing
directory or not.
</p>
<p>
The returned string is allocated just once, and should *NOT* be
freed with <code class="function">g_free()</code>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</p>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The user-specific GIMP settings directory.
</td>
</tr></tbody>
@ -106,9 +129,9 @@ is on Windows).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574620"></a><h3>
<a name="id2545620"></a><h3>
<a name="gimp-personal-rc-file"></a>gimp_personal_rc_file ()</h3>
<a class="indexterm" name="id2574631"></a><pre class="programlisting">gchar* gimp_personal_rc_file (const gchar *basename);</pre>
<a class="indexterm" name="id2545629"></a><pre class="programlisting">gchar* gimp_personal_rc_file (const gchar *basename);</pre>
<p>
Returns the name of a file in the user-specific GIMP settings directory.
</p>
@ -124,12 +147,14 @@ is on Windows).</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>basename</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>basename</code></em>&#160;:</span></td>
<td> The basename of a rc_file.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The name of a file in the user-specific GIMP settings directory.
</td>
</tr>
@ -138,9 +163,9 @@ is on Windows).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2583612"></a><h3>
<a name="id2560109"></a><h3>
<a name="gimp-data-directory"></a>gimp_data_directory ()</h3>
<a class="indexterm" name="id2583624"></a><pre class="programlisting">const gchar* gimp_data_directory (void);</pre>
<a class="indexterm" name="id2560119"></a><pre class="programlisting">const gchar* gimp_data_directory (void);</pre>
<p>
Returns the top directory for GIMP data. If the environment
variable GIMP2_DATADIR exists, that is used. It should be an
@ -149,17 +174,17 @@ directory is used. On Win32, the installation directory as deduced
from the executable's name is used.
</p>
<p>
The returned string is allocated just once, and should *NOT* be
freed with <code class="function">g_free()</code>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</p>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The top directory for GIMP data.
</td>
</tr></tbody>
@ -167,9 +192,9 @@ is on Windows).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2583686"></a><h3>
<a name="id2560171"></a><h3>
<a name="gimp-locale-directory"></a>gimp_locale_directory ()</h3>
<a class="indexterm" name="id2583697"></a><pre class="programlisting">const gchar* gimp_locale_directory (void);</pre>
<a class="indexterm" name="id2560180"></a><pre class="programlisting">const gchar* gimp_locale_directory (void);</pre>
<p>
Returns the top directory for GIMP locale files. If the environment
variable GIMP2_LOCALEDIR exists, that is used. It should be an
@ -178,17 +203,17 @@ directory is used. On Win32, the installation directory as deduced
from the executable's name is used.
</p>
<p>
The returned string is allocated just once, and should *NOT* be
freed with <code class="function">g_free()</code>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</p>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The top directory for GIMP locale files.
</td>
</tr></tbody>
@ -196,9 +221,9 @@ is on Windows).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2583759"></a><h3>
<a name="id2560234"></a><h3>
<a name="gimp-plug-in-directory"></a>gimp_plug_in_directory ()</h3>
<a class="indexterm" name="id2583770"></a><pre class="programlisting">const gchar* gimp_plug_in_directory (void);</pre>
<a class="indexterm" name="id2560242"></a><pre class="programlisting">const gchar* gimp_plug_in_directory (void);</pre>
<p>
Returns the top directory for GIMP plug_ins and modules. If the
environment variable GIMP2_PLUGINDIR exists, that is used. It
@ -207,17 +232,17 @@ defined directory is used. On Win32, the installation directory as
deduced from the executable's name is used.
</p>
<p>
The returned string is allocated just once, and should *NOT* be
freed with <code class="function">g_free()</code>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</p>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The top directory for GIMP plug_ins and modules.
</td>
</tr></tbody>
@ -225,9 +250,9 @@ is on Windows).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588903"></a><h3>
<a name="id2560296"></a><h3>
<a name="gimp-sysconf-directory"></a>gimp_sysconf_directory ()</h3>
<a class="indexterm" name="id2588914"></a><pre class="programlisting">const gchar* gimp_sysconf_directory (void);</pre>
<a class="indexterm" name="id2560305"></a><pre class="programlisting">const gchar* gimp_sysconf_directory (void);</pre>
<p>
Returns the top directory for GIMP config files. If the environment
variable GIMP2_SYSCONFDIR exists, that is used. It should be an
@ -236,17 +261,17 @@ directory is used. On Win32, the installation directory as deduced
from the executable's name is used.
</p>
<p>
The returned string is allocated just once, and should *NOT* be
freed with <code class="function">g_free()</code>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</p>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The top directory for GIMP config files.
</td>
</tr></tbody>
@ -254,24 +279,24 @@ is on Windows).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588976"></a><h3>
<a name="id2560358"></a><h3>
<a name="gimp-gtkrc"></a>gimp_gtkrc ()</h3>
<a class="indexterm" name="id2588988"></a><pre class="programlisting">const gchar* gimp_gtkrc (void);</pre>
<a class="indexterm" name="id2554381"></a><pre class="programlisting">const gchar* gimp_gtkrc (void);</pre>
<p>
Returns the name of the GIMP's application-specific gtkrc file.
</p>
<p>
The returned string is allocated just once, and should *NOT* be
freed with <code class="function">g_free()</code>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</p>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The name of the GIMP's application-specific gtkrc file.
</td>
</tr></tbody>
@ -279,12 +304,12 @@ is on Windows).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2589048"></a><h3>
<a name="id2554430"></a><h3>
<a name="gimp-path-parse"></a>gimp_path_parse ()</h3>
<a class="indexterm" name="id2589060"></a><pre class="programlisting">GList* gimp_path_parse (const gchar *path,
gint max_paths,
gboolean check,
GList **check_failed);</pre>
<a class="indexterm" name="id2554440"></a><pre class="programlisting">GList* gimp_path_parse (const gchar *path,
gint max_paths,
gboolean check,
GList **check_failed);</pre>
<p>
</p>
<p>
@ -294,28 +319,33 @@ is on Windows).</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>path</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>path</code></em>&#160;:</span></td>
<td> A list of directories separated by <span class="type">G_SEARCHPATH_SEPARATOR</span>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>max_paths</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>max_paths</code></em>&#160;:</span></td>
<td> The maximum number of directories to return.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>check</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>check</code></em>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if you want the directories to be checked.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>check_failed</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>check_failed</code></em>&#160;:</span></td>
<td> Returns a <span class="type">GList</span> of path elements for which the
check failed.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A <span class="type">GList</span> of all directories in <em class="parameter"><code>path</code></em>.
</td>
</tr>
@ -324,9 +354,9 @@ is on Windows).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601047"></a><h3>
<a name="id2554599"></a><h3>
<a name="gimp-path-to-str"></a>gimp_path_to_str ()</h3>
<a class="indexterm" name="id2601057"></a><pre class="programlisting">gchar* gimp_path_to_str (GList *path);</pre>
<a class="indexterm" name="id2554610"></a><pre class="programlisting">gchar* gimp_path_to_str (GList *path);</pre>
<p>
</p>
<p>
@ -336,12 +366,14 @@ is on Windows).</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>path</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>path</code></em>&#160;:</span></td>
<td> A list of directories as returned by <a href="libgimpbase-gimpenv.html#gimp-path-parse"><code class="function">gimp_path_parse()</code></a>.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A searchpath string separated by <span class="type">G_SEARCHPATH_SEPARATOR</span>.
</td>
</tr>
@ -350,9 +382,9 @@ is on Windows).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601129"></a><h3>
<a name="id2560683"></a><h3>
<a name="gimp-path-free"></a>gimp_path_free ()</h3>
<a class="indexterm" name="id2601141"></a><pre class="programlisting">void gimp_path_free (GList *path);</pre>
<a class="indexterm" name="id2560692"></a><pre class="programlisting">void gimp_path_free (GList *path);</pre>
<p>
This function frees the memory allocated for the list and the strings
it contains.</p>
@ -362,7 +394,8 @@ it contains.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>path</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>path</code></em>&#160;:</span></td>
<td> A list of directories as returned by <a href="libgimpbase-gimpenv.html#gimp-path-parse"><code class="function">gimp_path_parse()</code></a>.
</td>
</tr></tbody>
@ -370,9 +403,9 @@ it contains.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601202"></a><h3>
<a name="id2560746"></a><h3>
<a name="gimp-path-get-user-writable-dir"></a>gimp_path_get_user_writable_dir ()</h3>
<a class="indexterm" name="id2601215"></a><pre class="programlisting">gchar* gimp_path_get_user_writable_dir (GList *path);</pre>
<a class="indexterm" name="id2560754"></a><pre class="programlisting">gchar* gimp_path_get_user_writable_dir (GList *path);</pre>
<p>
Note that you have to <code class="function">g_free()</code> the returned string.</p>
<p>
@ -382,12 +415,14 @@ Note that you have to <code class="function">g_free()</code> the returned string
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>path</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>path</code></em>&#160;:</span></td>
<td> A list of directories as returned by <a href="libgimpbase-gimpenv.html#gimp-path-parse"><code class="function">gimp_path_parse()</code></a>.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The first directory in <em class="parameter"><code>path</code></em> where the user has write permission.
</td>
</tr>
@ -396,5 +431,9 @@ Note that you have to <code class="function">g_free()</code> the returned string
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpdatafiles.html"><b>&lt;&lt;&#160;gimpdatafiles</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpmemsize.html"><b>gimpmemsize&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

60
devel-docs/libgimpbase/html/libgimpbase-gimplimits.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimplimits</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpversion.html" title="gimpversion">
<link rel="next" href="libgimpbase-gimpchecks.html" title="gimpchecks">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpversion.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpchecks.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2582144" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2573973" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimplimits"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2582144"></a><span class="refentrytitle">gimplimits</span>
</h2>
<h2><span class="refentrytitle">gimplimits</span></h2>
<p>gimplimits &#8212; Boundaries of some GIMP data types and some global constants.</p>
</td>
<td valign="top" align="right"></td>
@ -42,26 +38,26 @@
#define <a href="libgimpbase-gimplimits.html#GIMP-MIN-IMAGE-SIZE:CAPS">GIMP_MIN_IMAGE_SIZE</a>
#define <a href="libgimpbase-gimplimits.html#GIMP-MAX-IMAGE-SIZE:CAPS">GIMP_MAX_IMAGE_SIZE</a>
#define <a href="libgimpbase-gimplimits.html#GIMP-MIN-RESOLUTION:CAPS">GIMP_MIN_RESOLUTION</a>
#define <a href="libgimpbase-gimplimits.html#GIMP-MAX-RESOLUTION:CAPS">GIMP_MAX_RESOLUTION</a>
#define <a href="libgimpbase-gimplimits.html#GIMP-MAX-MEMSIZE:CAPS">GIMP_MAX_MEMSIZE</a>
#define <a href="libgimpbase-gimplimits.html#GIMP-MIN-IMAGE-SIZE:CAPS">GIMP_MIN_IMAGE_SIZE</a>
#define <a href="libgimpbase-gimplimits.html#GIMP-MAX-IMAGE-SIZE:CAPS">GIMP_MAX_IMAGE_SIZE</a>
#define <a href="libgimpbase-gimplimits.html#GIMP-MIN-RESOLUTION:CAPS">GIMP_MIN_RESOLUTION</a>
#define <a href="libgimpbase-gimplimits.html#GIMP-MAX-RESOLUTION:CAPS">GIMP_MAX_RESOLUTION</a>
#define <a href="libgimpbase-gimplimits.html#GIMP-MAX-MEMSIZE:CAPS">GIMP_MAX_MEMSIZE</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2573973"></a><h2>Description</h2>
<a name="id2533450"></a><h2>Description</h2>
<p>
Boundaries of some GIMP data types and some global constants.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2590722"></a><h2>Details</h2>
<a name="id2543539"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2590733"></a><h3>
<a name="id2518496"></a><h3>
<a name="GIMP-MIN-IMAGE-SIZE:CAPS"></a>GIMP_MIN_IMAGE_SIZE</h3>
<a class="indexterm" name="id2590745"></a><pre class="programlisting">#define GIMP_MIN_IMAGE_SIZE 1
<a class="indexterm" name="id2518505"></a><pre class="programlisting">#define GIMP_MIN_IMAGE_SIZE 1
</pre>
<p>
The minimum width and height of a GIMP image in pixels.
@ -69,9 +65,9 @@ The minimum width and height of a GIMP image in pixels.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2590761"></a><h3>
<a name="id2518521"></a><h3>
<a name="GIMP-MAX-IMAGE-SIZE:CAPS"></a>GIMP_MAX_IMAGE_SIZE</h3>
<a class="indexterm" name="id2570959"></a><pre class="programlisting">#define GIMP_MAX_IMAGE_SIZE 262144 /* 2^18 */
<a class="indexterm" name="id2518531"></a><pre class="programlisting">#define GIMP_MAX_IMAGE_SIZE 262144 /* 2^18 */
</pre>
<p>
The maximum width and height of a GIMP image in pixels. This is a
@ -81,9 +77,9 @@ sizes is needed; for example to give a spin button an upper limit.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570978"></a><h3>
<a name="id2518551"></a><h3>
<a name="GIMP-MIN-RESOLUTION:CAPS"></a>GIMP_MIN_RESOLUTION</h3>
<a class="indexterm" name="id2570989"></a><pre class="programlisting">#define GIMP_MIN_RESOLUTION 5e-3 /* shouldn't display as 0.000 */
<a class="indexterm" name="id2518560"></a><pre class="programlisting">#define GIMP_MIN_RESOLUTION 5e-3 /* shouldn't display as 0.000 */
</pre>
<p>
The minimum resolution of a GIMP image in pixels per inch. This is a
@ -94,9 +90,9 @@ this value.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571009"></a><h3>
<a name="id2518580"></a><h3>
<a name="GIMP-MAX-RESOLUTION:CAPS"></a>GIMP_MAX_RESOLUTION</h3>
<a class="indexterm" name="id2571021"></a><pre class="programlisting">#define GIMP_MAX_RESOLUTION 65536.0
<a class="indexterm" name="id2518590"></a><pre class="programlisting">#define GIMP_MAX_RESOLUTION 65536.0
</pre>
<p>
The maximum resolution of a GIMP image in pixels per inch. This is a
@ -107,9 +103,9 @@ this value.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571040"></a><h3>
<a name="id2525947"></a><h3>
<a name="GIMP-MAX-MEMSIZE:CAPS"></a>GIMP_MAX_MEMSIZE</h3>
<a class="indexterm" name="id2571052"></a><pre class="programlisting">#define GIMP_MAX_MEMSIZE ((guint64) 1 &lt;&lt; 42) /* 4 terabyte;
<a class="indexterm" name="id2525956"></a><pre class="programlisting">#define GIMP_MAX_MEMSIZE ((guint64) 1 &lt;&lt; 42) /* 4 terabyte;
</pre>
<p>
A large but arbitrary value that can be used when an upper limit for a
@ -121,5 +117,9 @@ href="../libgimpwidgets/GimpMemsizeEntry.html"
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpversion.html"><b>&lt;&lt;&#160;gimpversion</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpchecks.html"><b>gimpchecks&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

208
devel-docs/libgimpbase/html/libgimpbase-gimpmemsize.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpmemsize</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpenv.html" title="gimpenv">
<link rel="next" href="libgimpbase-gimpparasite.html" title="gimpparasite">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpenv.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpparasite.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2586877" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2579446" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpmemsize"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2586877"></a><span class="refentrytitle">gimpmemsize</span>
</h2>
<h2><span class="refentrytitle">gimpmemsize</span></h2>
<p>gimpmemsize &#8212; Functions to (de)serialize a given memory size.</p>
</td>
<td valign="top" align="right"></td>
@ -42,27 +38,36 @@
gchar* <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize">gimp_memsize_serialize</a> (guint64 memsize);
gboolean <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize">gimp_memsize_deserialize</a> (const gchar *string,
guint64 *memsize);
gchar* <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string">gimp_memsize_to_string</a> (guint64 memsize);
#define <a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</a>
#define <a href="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</a> (value)
gchar* <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize">gimp_memsize_serialize</a> (guint64 memsize);
gboolean <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize">gimp_memsize_deserialize</a> (const gchar *string,
guint64 *memsize);
gchar* <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string">gimp_memsize_to_string</a> (guint64 memsize);
#define <a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</a>
#define <a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-PARAM-MEMSIZE:CAPS">GIMP_TYPE_PARAM_MEMSIZE</a>
#define <a href="libgimpbase-gimpmemsize.html#GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS">GIMP_IS_PARAM_SPEC_MEMSIZE</a> (pspec)
GParamSpec* <a href="libgimpbase-gimpmemsize.html#gimp-param-spec-memsize">gimp_param_spec_memsize</a> (const gchar *name,
const gchar *nick,
const gchar *blurb,
guint64 minimum,
guint64 maximum,
guint64 default_value,
GParamFlags flags);
#define <a href="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</a> (value)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2579446"></a><h2>Description</h2>
<a name="id2534480"></a><h2>Description</h2>
<p>
Functions to (de)serialize a given memory size.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2579463"></a><h2>Details</h2>
<a name="id2534491"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2579473"></a><h3>
<a name="id2534498"></a><h3>
<a name="gimp-memsize-serialize"></a>gimp_memsize_serialize ()</h3>
<a class="indexterm" name="id2579487"></a><pre class="programlisting">gchar* gimp_memsize_serialize (guint64 memsize);</pre>
<a class="indexterm" name="id2534506"></a><pre class="programlisting">gchar* gimp_memsize_serialize (guint64 memsize);</pre>
<p>
Creates a string representation of a given memory size. This string
can be parsed by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize"><code class="function">gimp_memsize_deserialize()</code></a> and can thus be used in
@ -75,27 +80,29 @@ nice human-readable string please use <a href="libgimpbase-gimpmemsize.html#gimp
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td> memory size in bytes
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A newly allocated string representation of <em class="parameter"><code>memsize</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565627"></a><h3>
<a name="id2516733"></a><h3>
<a name="gimp-memsize-deserialize"></a>gimp_memsize_deserialize ()</h3>
<a class="indexterm" name="id2565640"></a><pre class="programlisting">gboolean gimp_memsize_deserialize (const gchar *string,
guint64 *memsize);</pre>
<a class="indexterm" name="id2516742"></a><pre class="programlisting">gboolean gimp_memsize_deserialize (const gchar *string,
guint64 *memsize);</pre>
<p>
Parses a string representation of a memory size as returned by
<a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><code class="function">gimp_memsize_serialize()</code></a>.</p>
@ -106,17 +113,20 @@ Parses a string representation of a memory size as returned by
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>string</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>string</code></em>&#160;:</span></td>
<td> a string as returned by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><code class="function">gimp_memsize_serialize()</code></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td> return location for memory size in bytes
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>string</code></em> was successfully parsed and
<em class="parameter"><code>memsize</code></em> has been set, <code class="literal">FALSE</code> otherwise.
@ -124,14 +134,14 @@ Parses a string representation of a memory size as returned by
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556749"></a><h3>
<a name="id2558860"></a><h3>
<a name="gimp-memsize-to-string"></a>gimp_memsize_to_string ()</h3>
<a class="indexterm" name="id2556760"></a><pre class="programlisting">gchar* gimp_memsize_to_string (guint64 memsize);</pre>
<a class="indexterm" name="id2558869"></a><pre class="programlisting">gchar* gimp_memsize_to_string (guint64 memsize);</pre>
<p>
This function returns a human readable, translated representation
of the passed <em class="parameter"><code>memsize</code></em>. Large values are displayed using a
@ -144,12 +154,14 @@ becomes "4.4 KB" and so on.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
<td> A memory size in bytes.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A newly allocated human-readable, translated string.
</td>
</tr>
@ -158,9 +170,9 @@ becomes "4.4 KB" and so on.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556830"></a><h3>
<a name="id2558938"></a><h3>
<a name="GIMP-TYPE-MEMSIZE:CAPS"></a>GIMP_TYPE_MEMSIZE</h3>
<a class="indexterm" name="id2556842"></a><pre class="programlisting">#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
<a class="indexterm" name="id2558948"></a><pre class="programlisting">#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
</pre>
<p>
<a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS"><span class="type">GIMP_TYPE_MEMSIZE</span></a> is a <span class="type">GType</span> derived from <span class="type">G_TYPE_UINT64</span>.
@ -168,9 +180,19 @@ becomes "4.4 KB" and so on.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2556880"></a><h3>
<a name="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"></a>GIMP_VALUE_HOLDS_MEMSIZE()</h3>
<a class="indexterm" name="id2556891"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
<a name="id2558986"></a><h3>
<a name="GIMP-TYPE-PARAM-MEMSIZE:CAPS"></a>GIMP_TYPE_PARAM_MEMSIZE</h3>
<a class="indexterm" name="id2558995"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_MEMSIZE (gimp_param_memsize_get_type ())
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559011"></a><h3>
<a name="GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS"></a>GIMP_IS_PARAM_SPEC_MEMSIZE()</h3>
<a class="indexterm" name="id2559020"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_MEMSIZE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_MEMSIZE))
</pre>
<p>
@ -178,7 +200,103 @@ becomes "4.4 KB" and so on.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>pspec</code></em>&#160;:</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559056"></a><h3>
<a name="gimp-param-spec-memsize"></a>gimp_param_spec_memsize ()</h3>
<a class="indexterm" name="id2560368"></a><pre class="programlisting">GParamSpec* gimp_param_spec_memsize (const gchar *name,
const gchar *nick,
const gchar *blurb,
guint64 minimum,
guint64 maximum,
guint64 default_value,
GParamFlags flags);</pre>
<p>
Creates a param spec to hold a memory size value.
See <code class="function">g_param_spec_internal()</code> for more information.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> Canonical name of the param
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>nick</code></em>&#160;:</span></td>
<td> Nickname of the param
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>blurb</code></em>&#160;:</span></td>
<td> Brief desciption of param.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>minimum</code></em>&#160;:</span></td>
<td> Smallest allowed value of the parameter.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>maximum</code></em>&#160;:</span></td>
<td> Largest allowed value of the parameter.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></td>
<td> Value to use if none is assigned.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td> a combination of <span class="type">GParamFlags</span>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a newly allocated <span class="type">GParamSpec</span> instance
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560585"></a><h3>
<a name="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"></a>GIMP_VALUE_HOLDS_MEMSIZE()</h3>
<a class="indexterm" name="id2560595"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td>
@ -188,5 +306,9 @@ becomes "4.4 KB" and so on.</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpenv.html"><b>&lt;&lt;&#160;gimpenv</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpparasite.html"><b>gimpparasite&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

269
devel-docs/libgimpbase/html/libgimpbase-gimpparasite.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpparasite</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpmemsize.html" title="gimpmemsize">
<link rel="next" href="libgimpbase-gimpparasiteio.html" title="gimpparasiteio">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpmemsize.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpparasiteio.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2586818" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2557208" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpparasite"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2586818"></a><span class="refentrytitle">gimpparasite</span>
</h2>
<h2><span class="refentrytitle">gimpparasite</span></h2>
<p>gimpparasite &#8212; Arbitrary pieces of data which can be attached to various GIMP objects.</p>
</td>
<td valign="top" align="right"></td>
@ -42,48 +38,48 @@
<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>;
<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* <a href="libgimpbase-gimpparasite.html#gimp-parasite-new">gimp_parasite_new</a> (const gchar *name,
guint32 flags,
guint32 size,
gconstpointer data);
void <a href="libgimpbase-gimpparasite.html#gimp-parasite-free">gimp_parasite_free</a> (<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* <a href="libgimpbase-gimpparasite.html#gimp-parasite-copy">gimp_parasite_copy</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-compare">gimp_parasite_compare</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *a,
const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *b);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-is-type">gimp_parasite_is_type</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
const gchar *name);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-is-persistent">gimp_parasite_is_persistent</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-is-undoable">gimp_parasite_is_undoable</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-has-flag">gimp_parasite_has_flag</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
gulong flag);
gulong <a href="libgimpbase-gimpparasite.html#gimp-parasite-flags">gimp_parasite_flags</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
const gchar* <a href="libgimpbase-gimpparasite.html#gimp-parasite-name">gimp_parasite_name</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
gconstpointer <a href="libgimpbase-gimpparasite.html#gimp-parasite-data">gimp_parasite_data</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
glong <a href="libgimpbase-gimpparasite.html#gimp-parasite-data-size">gimp_parasite_data_size</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-PERSISTENT:CAPS">GIMP_PARASITE_PERSISTENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-UNDOABLE:CAPS">GIMP_PARASITE_UNDOABLE</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-PARENT:CAPS">GIMP_PARASITE_ATTACH_PARENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-PERSISTENT:CAPS">GIMP_PARASITE_PARENT_PERSISTENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-UNDOABLE:CAPS">GIMP_PARASITE_PARENT_UNDOABLE</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS">GIMP_PARASITE_ATTACH_GRANDPARENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS">GIMP_PARASITE_GRANDPARENT_PERSISTENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS">GIMP_PARASITE_GRANDPARENT_UNDOABLE</a>
<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>;
<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* <a href="libgimpbase-gimpparasite.html#gimp-parasite-new">gimp_parasite_new</a> (const gchar *name,
guint32 flags,
guint32 size,
gconstpointer data);
void <a href="libgimpbase-gimpparasite.html#gimp-parasite-free">gimp_parasite_free</a> (<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* <a href="libgimpbase-gimpparasite.html#gimp-parasite-copy">gimp_parasite_copy</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-compare">gimp_parasite_compare</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *a,
const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *b);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-is-type">gimp_parasite_is_type</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
const gchar *name);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-is-persistent">gimp_parasite_is_persistent</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-is-undoable">gimp_parasite_is_undoable</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
gboolean <a href="libgimpbase-gimpparasite.html#gimp-parasite-has-flag">gimp_parasite_has_flag</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
gulong flag);
gulong <a href="libgimpbase-gimpparasite.html#gimp-parasite-flags">gimp_parasite_flags</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
const gchar* <a href="libgimpbase-gimpparasite.html#gimp-parasite-name">gimp_parasite_name</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
gconstpointer <a href="libgimpbase-gimpparasite.html#gimp-parasite-data">gimp_parasite_data</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
glong <a href="libgimpbase-gimpparasite.html#gimp-parasite-data-size">gimp_parasite_data_size</a> (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-PERSISTENT:CAPS">GIMP_PARASITE_PERSISTENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-UNDOABLE:CAPS">GIMP_PARASITE_UNDOABLE</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-PARENT:CAPS">GIMP_PARASITE_ATTACH_PARENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-PERSISTENT:CAPS">GIMP_PARASITE_PARENT_PERSISTENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-UNDOABLE:CAPS">GIMP_PARASITE_PARENT_UNDOABLE</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS">GIMP_PARASITE_ATTACH_GRANDPARENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS">GIMP_PARASITE_GRANDPARENT_PERSISTENT</a>
#define <a href="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS">GIMP_PARASITE_GRANDPARENT_UNDOABLE</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2557208"></a><h2>Description</h2>
<a name="id2547607"></a><h2>Description</h2>
<p>
Arbitrary pieces of data which can be attached to various GIMP objects.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2600638"></a><h2>Details</h2>
<a name="id2547620"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2600648"></a><h3>
<a name="id2547626"></a><h3>
<a name="GimpParasite"></a>GimpParasite</h3>
<a class="indexterm" name="id2600661"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2516308"></a><pre class="programlisting">typedef struct {
gchar *name; /* The name of the parasite. USE A UNIQUE PREFIX! */
guint32 flags; /* save Parasite in XCF file, etc. */
guint32 size; /* amount of data */
@ -97,12 +93,12 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600683"></a><h3>
<a name="id2516330"></a><h3>
<a name="gimp-parasite-new"></a>gimp_parasite_new ()</h3>
<a class="indexterm" name="id2600695"></a><pre class="programlisting"><a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* gimp_parasite_new (const gchar *name,
guint32 flags,
guint32 size,
gconstpointer data);</pre>
<a class="indexterm" name="id2516340"></a><pre class="programlisting"><a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* gimp_parasite_new (const gchar *name,
guint32 flags,
guint32 size,
gconstpointer data);</pre>
<p>
</p>
@ -110,27 +106,32 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -141,16 +142,17 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600816"></a><h3>
<a name="id2516459"></a><h3>
<a name="gimp-parasite-free"></a>gimp_parasite_free ()</h3>
<a class="indexterm" name="id2600828"></a><pre class="programlisting">void gimp_parasite_free (<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<a class="indexterm" name="id2516469"></a><pre class="programlisting">void gimp_parasite_free (<a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
@ -160,9 +162,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600874"></a><h3>
<a name="id2516515"></a><h3>
<a name="gimp-parasite-copy"></a>gimp_parasite_copy ()</h3>
<a class="indexterm" name="id2600886"></a><pre class="programlisting"><a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* gimp_parasite_copy (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<a class="indexterm" name="id2516525"></a><pre class="programlisting"><a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a>* gimp_parasite_copy (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<p>
</p>
@ -170,12 +172,14 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -186,10 +190,10 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600410"></a><h3>
<a name="id2527405"></a><h3>
<a name="gimp-parasite-compare"></a>gimp_parasite_compare ()</h3>
<a class="indexterm" name="id2600421"></a><pre class="programlisting">gboolean gimp_parasite_compare (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *a,
const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *b);</pre>
<a class="indexterm" name="id2527414"></a><pre class="programlisting">gboolean gimp_parasite_compare (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *a,
const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *b);</pre>
<p>
</p>
@ -197,17 +201,20 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>a</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>a</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>b</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>b</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -218,10 +225,10 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600499"></a><h3>
<a name="id2527492"></a><h3>
<a name="gimp-parasite-is-type"></a>gimp_parasite_is_type ()</h3>
<a class="indexterm" name="id2600510"></a><pre class="programlisting">gboolean gimp_parasite_is_type (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
const gchar *name);</pre>
<a class="indexterm" name="id2527500"></a><pre class="programlisting">gboolean gimp_parasite_is_type (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
const gchar *name);</pre>
<p>
</p>
@ -229,17 +236,20 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -250,9 +260,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600588"></a><h3>
<a name="id2527577"></a><h3>
<a name="gimp-parasite-is-persistent"></a>gimp_parasite_is_persistent ()</h3>
<a class="indexterm" name="id2600600"></a><pre class="programlisting">gboolean gimp_parasite_is_persistent (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<a class="indexterm" name="id2527586"></a><pre class="programlisting">gboolean gimp_parasite_is_persistent (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<p>
</p>
@ -260,12 +270,14 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -276,9 +288,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603354"></a><h3>
<a name="id2527642"></a><h3>
<a name="gimp-parasite-is-undoable"></a>gimp_parasite_is_undoable ()</h3>
<a class="indexterm" name="id2603364"></a><pre class="programlisting">gboolean gimp_parasite_is_undoable (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<a class="indexterm" name="id2527651"></a><pre class="programlisting">gboolean gimp_parasite_is_undoable (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<p>
</p>
@ -286,12 +298,14 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -302,10 +316,10 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603415"></a><h3>
<a name="id2563184"></a><h3>
<a name="gimp-parasite-has-flag"></a>gimp_parasite_has_flag ()</h3>
<a class="indexterm" name="id2603425"></a><pre class="programlisting">gboolean gimp_parasite_has_flag (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
gulong flag);</pre>
<a class="indexterm" name="id2563192"></a><pre class="programlisting">gboolean gimp_parasite_has_flag (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
gulong flag);</pre>
<p>
</p>
@ -313,17 +327,20 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flag</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flag</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -334,9 +351,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603497"></a><h3>
<a name="id2563238"></a><h3>
<a name="gimp-parasite-flags"></a>gimp_parasite_flags ()</h3>
<a class="indexterm" name="id2603510"></a><pre class="programlisting">gulong gimp_parasite_flags (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<a class="indexterm" name="id2563246"></a><pre class="programlisting">gulong gimp_parasite_flags (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<p>
</p>
@ -344,12 +361,14 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -360,9 +379,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603566"></a><h3>
<a name="id2563296"></a><h3>
<a name="gimp-parasite-name"></a>gimp_parasite_name ()</h3>
<a class="indexterm" name="id2603579"></a><pre class="programlisting">const gchar* gimp_parasite_name (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<a class="indexterm" name="id2563305"></a><pre class="programlisting">const gchar* gimp_parasite_name (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<p>
</p>
@ -370,12 +389,14 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -386,9 +407,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603637"></a><h3>
<a name="id2563355"></a><h3>
<a name="gimp-parasite-data"></a>gimp_parasite_data ()</h3>
<a class="indexterm" name="id2603649"></a><pre class="programlisting">gconstpointer gimp_parasite_data (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<a class="indexterm" name="id2563363"></a><pre class="programlisting">gconstpointer gimp_parasite_data (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<p>
</p>
@ -396,12 +417,14 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -412,9 +435,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603706"></a><h3>
<a name="id2563414"></a><h3>
<a name="gimp-parasite-data-size"></a>gimp_parasite_data_size ()</h3>
<a class="indexterm" name="id2603717"></a><pre class="programlisting">glong gimp_parasite_data_size (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<a class="indexterm" name="id2563422"></a><pre class="programlisting">glong gimp_parasite_data_size (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite);</pre>
<p>
</p>
@ -422,12 +445,14 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -438,9 +463,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593239"></a><h3>
<a name="id2563472"></a><h3>
<a name="GIMP-PARASITE-PERSISTENT:CAPS"></a>GIMP_PARASITE_PERSISTENT</h3>
<a class="indexterm" name="id2603767"></a><pre class="programlisting">#define GIMP_PARASITE_PERSISTENT 1
<a class="indexterm" name="id2563481"></a><pre class="programlisting">#define GIMP_PARASITE_PERSISTENT 1
</pre>
<p>
@ -448,9 +473,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603780"></a><h3>
<a name="id2563494"></a><h3>
<a name="GIMP-PARASITE-UNDOABLE:CAPS"></a>GIMP_PARASITE_UNDOABLE</h3>
<a class="indexterm" name="id2603791"></a><pre class="programlisting">#define GIMP_PARASITE_UNDOABLE 2
<a class="indexterm" name="id2563503"></a><pre class="programlisting">#define GIMP_PARASITE_UNDOABLE 2
</pre>
<p>
@ -458,9 +483,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603805"></a><h3>
<a name="id2563517"></a><h3>
<a name="GIMP-PARASITE-ATTACH-PARENT:CAPS"></a>GIMP_PARASITE_ATTACH_PARENT</h3>
<a class="indexterm" name="id2603817"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_PARENT (0x80 &lt;&lt; 8)
<a class="indexterm" name="id2563527"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_PARENT (0x80 &lt;&lt; 8)
</pre>
<p>
@ -468,9 +493,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603832"></a><h3>
<a name="id2563542"></a><h3>
<a name="GIMP-PARASITE-PARENT-PERSISTENT:CAPS"></a>GIMP_PARASITE_PARENT_PERSISTENT</h3>
<a class="indexterm" name="id2603845"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT &lt;&lt; 8)
<a class="indexterm" name="id2563553"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT &lt;&lt; 8)
</pre>
<p>
@ -478,9 +503,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603860"></a><h3>
<a name="id2563568"></a><h3>
<a name="GIMP-PARASITE-PARENT-UNDOABLE:CAPS"></a>GIMP_PARASITE_PARENT_UNDOABLE</h3>
<a class="indexterm" name="id2603873"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE &lt;&lt; 8)
<a class="indexterm" name="id2563579"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE &lt;&lt; 8)
</pre>
<p>
@ -488,9 +513,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603888"></a><h3>
<a name="id2563594"></a><h3>
<a name="GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS"></a>GIMP_PARASITE_ATTACH_GRANDPARENT</h3>
<a class="indexterm" name="id2603901"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_GRANDPARENT (0x80 &lt;&lt; 16)
<a class="indexterm" name="id2563605"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_GRANDPARENT (0x80 &lt;&lt; 16)
</pre>
<p>
@ -498,9 +523,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603916"></a><h3>
<a name="id2563620"></a><h3>
<a name="GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS"></a>GIMP_PARASITE_GRANDPARENT_PERSISTENT</h3>
<a class="indexterm" name="id2603928"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT &lt;&lt; 16)
<a class="indexterm" name="id2563630"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT &lt;&lt; 16)
</pre>
<p>
@ -508,9 +533,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603944"></a><h3>
<a name="id2563646"></a><h3>
<a name="GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS"></a>GIMP_PARASITE_GRANDPARENT_UNDOABLE</h3>
<a class="indexterm" name="id2603958"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE &lt;&lt; 16)
<a class="indexterm" name="id2563658"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE &lt;&lt; 16)
</pre>
<p>
@ -518,7 +543,7 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2603974"></a><h2>See Also</h2>
<a name="id2563674"></a><h2>See Also</h2>
<p>
<a
href="../app/GimpImage.html#gimp-image-parasite-attach"
@ -531,5 +556,9 @@ href="../app/app-Gimp-parasites.html#gimp-parasite-attach"
</p>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpmemsize.html"><b>&lt;&lt;&#160;gimpmemsize</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpparasiteio.html"><b>gimpparasiteio&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

75
devel-docs/libgimpbase/html/libgimpbase-gimpparasiteio.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpparasiteio</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpparasite.html" title="gimpparasite">
<link rel="next" href="libgimpbase-gimpsignal.html" title="gimpsignal">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpparasite.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpsignal.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2572297" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2602338" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpparasiteio"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2572297"></a><span class="refentrytitle">gimpparasiteio</span>
</h2>
<h2><span class="refentrytitle">gimpparasiteio</span></h2>
<p>gimpparasiteio &#8212; Utility functions to (de)serialize certain C structures to/from <a href="libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a>'s.</p>
</td>
<td valign="top" align="right"></td>
@ -42,26 +38,26 @@
#define <a href="libgimpbase-gimpparasiteio.html#GIMP-PIXPIPE-MAXDIM:CAPS">GIMP_PIXPIPE_MAXDIM</a>
void <a href="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-init">gimp_pixpipe_params_init</a> (GimpPixPipeParams *params);
void <a href="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-parse">gimp_pixpipe_params_parse</a> (const gchar *parameters,
GimpPixPipeParams *params);
gchar* <a href="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-build">gimp_pixpipe_params_build</a> (GimpPixPipeParams *params);
#define <a href="libgimpbase-gimpparasiteio.html#GIMP-PIXPIPE-MAXDIM:CAPS">GIMP_PIXPIPE_MAXDIM</a>
void <a href="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-init">gimp_pixpipe_params_init</a> (GimpPixPipeParams *params);
void <a href="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-parse">gimp_pixpipe_params_parse</a> (const gchar *parameters,
GimpPixPipeParams *params);
gchar* <a href="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-build">gimp_pixpipe_params_build</a> (GimpPixPipeParams *params);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2602338"></a><h2>Description</h2>
<a name="id2562209"></a><h2>Description</h2>
<p>
Utility functions to (de)serialize certain C structures to/from <a href="libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a>'s.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2602362"></a><h2>Details</h2>
<a name="id2562227"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2602373"></a><h3>
<a name="id2562233"></a><h3>
<a name="GIMP-PIXPIPE-MAXDIM:CAPS"></a>GIMP_PIXPIPE_MAXDIM</h3>
<a class="indexterm" name="id2602384"></a><pre class="programlisting">#define GIMP_PIXPIPE_MAXDIM 4
<a class="indexterm" name="id2562242"></a><pre class="programlisting">#define GIMP_PIXPIPE_MAXDIM 4
</pre>
<p>
@ -69,16 +65,17 @@ Utility functions to (de)serialize certain C structures to/from <a href="libgimp
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602400"></a><h3>
<a name="id2562258"></a><h3>
<a name="gimp-pixpipe-params-init"></a>gimp_pixpipe_params_init ()</h3>
<a class="indexterm" name="id2602411"></a><pre class="programlisting">void gimp_pixpipe_params_init (GimpPixPipeParams *params);</pre>
<a class="indexterm" name="id2562267"></a><pre class="programlisting">void gimp_pixpipe_params_init (GimpPixPipeParams *params);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>params</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>params</code></em>&#160;:</span></td>
<td>
@ -88,10 +85,10 @@ Utility functions to (de)serialize certain C structures to/from <a href="libgimp
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2580148"></a><h3>
<a name="id2562312"></a><h3>
<a name="gimp-pixpipe-params-parse"></a>gimp_pixpipe_params_parse ()</h3>
<a class="indexterm" name="id2580159"></a><pre class="programlisting">void gimp_pixpipe_params_parse (const gchar *parameters,
GimpPixPipeParams *params);</pre>
<a class="indexterm" name="id2542326"></a><pre class="programlisting">void gimp_pixpipe_params_parse (const gchar *parameters,
GimpPixPipeParams *params);</pre>
<p>
</p>
@ -99,12 +96,14 @@ Utility functions to (de)serialize certain C structures to/from <a href="libgimp
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>parameters</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>parameters</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>params</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>params</code></em>&#160;:</span></td>
<td>
@ -115,9 +114,9 @@ Utility functions to (de)serialize certain C structures to/from <a href="libgimp
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2580227"></a><h3>
<a name="id2542393"></a><h3>
<a name="gimp-pixpipe-params-build"></a>gimp_pixpipe_params_build ()</h3>
<a class="indexterm" name="id2580238"></a><pre class="programlisting">gchar* gimp_pixpipe_params_build (GimpPixPipeParams *params);</pre>
<a class="indexterm" name="id2542402"></a><pre class="programlisting">gchar* gimp_pixpipe_params_build (GimpPixPipeParams *params);</pre>
<p>
</p>
@ -125,12 +124,14 @@ Utility functions to (de)serialize certain C structures to/from <a href="libgimp
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>params</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>params</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -141,11 +142,15 @@ Utility functions to (de)serialize certain C structures to/from <a href="libgimp
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2557349"></a><h2>See Also</h2>
<a name="id2542458"></a><h2>See Also</h2>
<p>
<a href="libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a>
</p>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpparasite.html"><b>&lt;&lt;&#160;gimpparasite</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpsignal.html"><b>gimpsignal&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

801
devel-docs/libgimpbase/html/libgimpbase-gimpprotocol.html
View File

@ -1,801 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpprotocol</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimputils.html" title="gimputils">
<link rel="next" href="libgimpbase-gimpwire.html" title="gimpwire">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimputils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpwire.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2591999" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2605466" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpprotocol"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2591999"></a><span class="refentrytitle">gimpprotocol</span>
</h2>
<p>gimpprotocol &#8212; The communication protocol between GIMP and it's plug-ins.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#define <a href="libgimpbase-gimpprotocol.html#GIMP-PROTOCOL-VERSION:CAPS">GIMP_PROTOCOL_VERSION</a>
<a href="libgimpbase-gimpprotocol.html#GPConfig">GPConfig</a>;
<a href="libgimpbase-gimpprotocol.html#GPTileReq">GPTileReq</a>;
<a href="libgimpbase-gimpprotocol.html#GPTileAck">GPTileAck</a>;
<a href="libgimpbase-gimpprotocol.html#GPTileData">GPTileData</a>;
<a href="libgimpbase-gimpprotocol.html#GPParam">GPParam</a>;
<a href="libgimpbase-gimpprotocol.html#GPParamDef">GPParamDef</a>;
<a href="libgimpbase-gimpprotocol.html#GPProcRun">GPProcRun</a>;
<a href="libgimpbase-gimpprotocol.html#GPProcReturn">GPProcReturn</a>;
<a href="libgimpbase-gimpprotocol.html#GPProcInstall">GPProcInstall</a>;
<a href="libgimpbase-gimpprotocol.html#GPProcUninstall">GPProcUninstall</a>;
void <a href="libgimpbase-gimpprotocol.html#gp-init">gp_init</a> (void);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-has-init-write">gp_has_init_write</a> (GIOChannel *channel,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-quit-write">gp_quit_write</a> (GIOChannel *channel,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-config-write">gp_config_write</a> (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPConfig">GPConfig</a> *config,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-tile-req-write">gp_tile_req_write</a> (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPTileReq">GPTileReq</a> *tile_req,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-tile-ack-write">gp_tile_ack_write</a> (GIOChannel *channel,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-tile-data-write">gp_tile_data_write</a> (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPTileData">GPTileData</a> *tile_data,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-proc-run-write">gp_proc_run_write</a> (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcRun">GPProcRun</a> *proc_run,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-proc-return-write">gp_proc_return_write</a> (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcReturn">GPProcReturn</a> *proc_return,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-temp-proc-run-write">gp_temp_proc_run_write</a> (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcRun">GPProcRun</a> *proc_run,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-temp-proc-return-write">gp_temp_proc_return_write</a> (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcReturn">GPProcReturn</a> *proc_return,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-proc-install-write">gp_proc_install_write</a> (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcInstall">GPProcInstall</a> *proc_install,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-proc-uninstall-write">gp_proc_uninstall_write</a> (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcUninstall">GPProcUninstall</a> *proc_uninstall,
gpointer user_data);
gboolean <a href="libgimpbase-gimpprotocol.html#gp-extension-ack-write">gp_extension_ack_write</a> (GIOChannel *channel,
gpointer user_data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2605466"></a><h2>Description</h2>
<p>
The communication protocol between GIMP and it's plug-ins.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2605483"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2605494"></a><h3>
<a name="GIMP-PROTOCOL-VERSION:CAPS"></a>GIMP_PROTOCOL_VERSION</h3>
<a class="indexterm" name="id2605505"></a><pre class="programlisting">#define GIMP_PROTOCOL_VERSION 0x0011
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605520"></a><h3>
<a name="GPConfig"></a>GPConfig</h3>
<a class="indexterm" name="id2605532"></a><pre class="programlisting">typedef struct {
guint32 version;
guint32 tile_width;
guint32 tile_height;
gint32 shm_ID;
gint8 check_size;
gint8 check_type;
gint8 show_help_button;
gint8 gimp_reserved_4;
gint8 gimp_reserved_5;
gint8 gimp_reserved_6;
gint8 gimp_reserved_7;
gint8 gimp_reserved_8;
gint8 install_cmap;
gint8 show_tool_tips;
gint32 min_colors;
gint32 gdisp_ID;
gchar *app_name;
gchar *wm_class;
gchar *display_name;
gint32 monitor_number;
} GPConfig;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2561352"></a><h3>
<a name="GPTileReq"></a>GPTileReq</h3>
<a class="indexterm" name="id2602775"></a><pre class="programlisting">typedef struct {
gint32 drawable_ID;
guint32 tile_num;
guint32 shadow;
} GPTileReq;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2561143"></a><h3>
<a name="GPTileAck"></a>GPTileAck</h3>
<a class="indexterm" name="id2605558"></a><pre class="programlisting">typedef struct _GPTileAck GPTileAck;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605573"></a><h3>
<a name="GPTileData"></a>GPTileData</h3>
<a class="indexterm" name="id2558778"></a><pre class="programlisting">typedef struct {
gint32 drawable_ID;
guint32 tile_num;
guint32 shadow;
guint32 bpp;
guint32 width;
guint32 height;
guint32 use_shm;
guchar *data;
} GPTileData;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558797"></a><h3>
<a name="GPParam"></a>GPParam</h3>
<a class="indexterm" name="id2558809"></a><pre class="programlisting">typedef struct {
guint32 type;
union
{
gint32 d_int32;
gint16 d_int16;
gint8 d_int8;
gdouble d_float;
gchar *d_string;
gint32 *d_int32array;
gint16 *d_int16array;
gint8 *d_int8array;
gdouble *d_floatarray;
gchar **d_stringarray;
GimpRGB d_color;
struct
{
gint32 x;
gint32 y;
gint32 width;
gint32 height;
} d_region;
gint32 d_display;
gint32 d_image;
gint32 d_layer;
gint32 d_channel;
gint32 d_drawable;
gint32 d_selection;
gint32 d_boundary;
gint32 d_path;
struct
{
gchar *name;
guint32 flags;
guint32 size;
gpointer data;
} d_parasite;
gint32 d_status;
} data;
} GPParam;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558837"></a><h3>
<a name="GPParamDef"></a>GPParamDef</h3>
<a class="indexterm" name="id2558849"></a><pre class="programlisting">typedef struct {
guint32 type;
gchar *name;
gchar *description;
} GPParamDef;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558866"></a><h3>
<a name="GPProcRun"></a>GPProcRun</h3>
<a class="indexterm" name="id2558878"></a><pre class="programlisting">typedef struct {
gchar *name;
guint32 nparams;
GPParam *params;
} GPProcRun;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558895"></a><h3>
<a name="GPProcReturn"></a>GPProcReturn</h3>
<a class="indexterm" name="id2558907"></a><pre class="programlisting">typedef struct {
gchar *name;
guint32 nparams;
GPParam *params;
} GPProcReturn;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558924"></a><h3>
<a name="GPProcInstall"></a>GPProcInstall</h3>
<a class="indexterm" name="id2558937"></a><pre class="programlisting">typedef struct {
gchar *name;
gchar *blurb;
gchar *help;
gchar *author;
gchar *copyright;
gchar *date;
gchar *menu_path;
gchar *image_types;
guint32 type;
guint32 nparams;
guint32 nreturn_vals;
GPParamDef *params;
GPParamDef *return_vals;
} GPProcInstall;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558958"></a><h3>
<a name="GPProcUninstall"></a>GPProcUninstall</h3>
<a class="indexterm" name="id2558970"></a><pre class="programlisting">typedef struct {
gchar *name;
} GPProcUninstall;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2558987"></a><h3>
<a name="gp-init"></a>gp_init ()</h3>
<a class="indexterm" name="id2558999"></a><pre class="programlisting">void gp_init (void);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559020"></a><h3>
<a name="gp-has-init-write"></a>gp_has_init_write ()</h3>
<a class="indexterm" name="id2559032"></a><pre class="programlisting">gboolean gp_has_init_write (GIOChannel *channel,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610990"></a><h3>
<a name="gp-quit-write"></a>gp_quit_write ()</h3>
<a class="indexterm" name="id2611000"></a><pre class="programlisting">gboolean gp_quit_write (GIOChannel *channel,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611069"></a><h3>
<a name="gp-config-write"></a>gp_config_write ()</h3>
<a class="indexterm" name="id2611080"></a><pre class="programlisting">gboolean gp_config_write (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPConfig">GPConfig</a> *config,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>config</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611168"></a><h3>
<a name="gp-tile-req-write"></a>gp_tile_req_write ()</h3>
<a class="indexterm" name="id2611179"></a><pre class="programlisting">gboolean gp_tile_req_write (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPTileReq">GPTileReq</a> *tile_req,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>tile_req</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611267"></a><h3>
<a name="gp-tile-ack-write"></a>gp_tile_ack_write ()</h3>
<a class="indexterm" name="id2611278"></a><pre class="programlisting">gboolean gp_tile_ack_write (GIOChannel *channel,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611347"></a><h3>
<a name="gp-tile-data-write"></a>gp_tile_data_write ()</h3>
<a class="indexterm" name="id2611358"></a><pre class="programlisting">gboolean gp_tile_data_write (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPTileData">GPTileData</a> *tile_data,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>tile_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611446"></a><h3>
<a name="gp-proc-run-write"></a>gp_proc_run_write ()</h3>
<a class="indexterm" name="id2611457"></a><pre class="programlisting">gboolean gp_proc_run_write (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcRun">GPProcRun</a> *proc_run,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>proc_run</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611545"></a><h3>
<a name="gp-proc-return-write"></a>gp_proc_return_write ()</h3>
<a class="indexterm" name="id2611556"></a><pre class="programlisting">gboolean gp_proc_return_write (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcReturn">GPProcReturn</a> *proc_return,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>proc_return</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611644"></a><h3>
<a name="gp-temp-proc-run-write"></a>gp_temp_proc_run_write ()</h3>
<a class="indexterm" name="id2611655"></a><pre class="programlisting">gboolean gp_temp_proc_run_write (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcRun">GPProcRun</a> *proc_run,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>proc_run</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611744"></a><h3>
<a name="gp-temp-proc-return-write"></a>gp_temp_proc_return_write ()</h3>
<a class="indexterm" name="id2611754"></a><pre class="programlisting">gboolean gp_temp_proc_return_write (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcReturn">GPProcReturn</a> *proc_return,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>proc_return</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611843"></a><h3>
<a name="gp-proc-install-write"></a>gp_proc_install_write ()</h3>
<a class="indexterm" name="id2611853"></a><pre class="programlisting">gboolean gp_proc_install_write (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcInstall">GPProcInstall</a> *proc_install,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>proc_install</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611942"></a><h3>
<a name="gp-proc-uninstall-write"></a>gp_proc_uninstall_write ()</h3>
<a class="indexterm" name="id2611952"></a><pre class="programlisting">gboolean gp_proc_uninstall_write (GIOChannel *channel,
<a href="libgimpbase-gimpprotocol.html#GPProcUninstall">GPProcUninstall</a> *proc_uninstall,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>proc_uninstall</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2612041"></a><h3>
<a name="gp-extension-ack-write"></a>gp_extension_ack_write ()</h3>
<a class="indexterm" name="id2612051"></a><pre class="programlisting">gboolean gp_extension_ack_write (GIOChannel *channel,
gpointer user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>channel</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2612122"></a><h2>See Also</h2>
<p>
<span class="type">libgimp-gimpwire</span>
</p>
</div>
</div>
</body>
</html>

67
devel-docs/libgimpbase/html/libgimpbase-gimpsignal.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpsignal</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpparasiteio.html" title="gimpparasiteio">
<link rel="next" href="libgimpbase-gimpunit.html" title="gimpunit">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpparasiteio.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpunit.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2561733" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2570526" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpsignal"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2561733"></a><span class="refentrytitle">gimpsignal</span>
</h2>
<h2><span class="refentrytitle">gimpsignal</span></h2>
<p>gimpsignal &#8212; Portable signal handling.</p>
</td>
<td valign="top" align="right"></td>
@ -42,25 +38,25 @@
void (<a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">*GimpSignalHandlerFunc</a>) (gint signum);
<a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">GimpSignalHandlerFunc</a> <a href="libgimpbase-gimpsignal.html#gimp-signal-private">gimp_signal_private</a> (gint signum,
<a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">GimpSignalHandlerFunc</a> handler,
gint flags);
void (<a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">*GimpSignalHandlerFunc</a>) (gint signum);
<a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">GimpSignalHandlerFunc</a> <a href="libgimpbase-gimpsignal.html#gimp-signal-private">gimp_signal_private</a> (gint signum,
<a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">GimpSignalHandlerFunc</a> handler,
gint flags);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2570526"></a><h2>Description</h2>
<a name="id2521583"></a><h2>Description</h2>
<p>
Portable signal handling.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2570541"></a><h2>Details</h2>
<a name="id2521594"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2570552"></a><h3>
<a name="id2521600"></a><h3>
<a name="GimpSignalHandlerFunc"></a>GimpSignalHandlerFunc ()</h3>
<a class="indexterm" name="id2570563"></a><pre class="programlisting">void (*GimpSignalHandlerFunc) (gint signum);</pre>
<a class="indexterm" name="id2521609"></a><pre class="programlisting">void (*GimpSignalHandlerFunc) (gint signum);</pre>
<p>
A prototype for signal handler functions. Note that each function which
takes or returns a variable of this type also accepts or may return
@ -70,7 +66,8 @@ special values defined by your system's signal.h header file (like
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>signum</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>signum</code></em>&#160;:</span></td>
<td>The number of the signal. Useful if different signals are handled
by a single handler.
@ -81,11 +78,11 @@ special values defined by your system's signal.h header file (like
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570626"></a><h3>
<a name="id2521670"></a><h3>
<a name="gimp-signal-private"></a>gimp_signal_private ()</h3>
<a class="indexterm" name="id2570638"></a><pre class="programlisting"><a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">GimpSignalHandlerFunc</a> gimp_signal_private (gint signum,
<a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">GimpSignalHandlerFunc</a> handler,
gint flags);</pre>
<a class="indexterm" name="id2521680"></a><pre class="programlisting"><a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">GimpSignalHandlerFunc</a> gimp_signal_private (gint signum,
<a href="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">GimpSignalHandlerFunc</a> handler,
gint flags);</pre>
<p>
This function furnishes a workalike for signal(2) but
which internally invokes sigaction(2) after certain
@ -107,25 +104,29 @@ exactly what we want. [austin 06.04.2000]</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>signum</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>signum</code></em>&#160;:</span></td>
<td> Selects signal to be handled see man 5 signal (or man 7 signal)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>handler</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>handler</code></em>&#160;:</span></td>
<td> Handler that maps to signum. Invoked by O/S.
Handler gets signal that caused invocation. Corresponds
to the <em class="parameter"><code>sa_handler</code></em> field of the <em class="parameter"><code>sigaction</code></em> struct.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td> Preferences. OR'ed SA_&lt;xxx&gt;. See man sigaction. Corresponds
to the <em class="parameter"><code>sa_flags</code></em> field of the <em class="parameter"><code>sigaction</code></em> struct.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A reference to the signal handling function which was
active before the call to <a href="libgimpbase-gimpsignal.html#gimp-signal-private"><code class="function">gimp_signal_private()</code></a>.
</td>
@ -135,11 +136,15 @@ exactly what we want. [austin 06.04.2000]</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2559332"></a><h2>See Also</h2>
<a name="id2561789"></a><h2>See Also</h2>
<p>
signal(2), signal(5 or 7), sigaction(2).
</p>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpparasiteio.html"><b>&lt;&lt;&#160;gimpparasiteio</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpunit.html"><b>gimpunit&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

357
devel-docs/libgimpbase/html/libgimpbase-gimpunit.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpunit</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpsignal.html" title="gimpsignal">
<link rel="next" href="libgimpbase-gimputils.html" title="gimputils">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpsignal.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimputils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2510125" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2559445" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpunit"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2510125"></a><span class="refentrytitle">gimpunit</span>
</h2>
<h2><span class="refentrytitle">gimpunit</span></h2>
<p>gimpunit &#8212; Provides a collection of predefined units and functions for creating
user-defined units.</p>
</td>
@ -43,34 +39,43 @@ user-defined units.</p>
enum <a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a>;
gint <a href="libgimpbase-gimpunit.html#gimp-unit-get-number-of-units">gimp_unit_get_number_of_units</a> (void);
gint <a href="libgimpbase-gimpunit.html#gimp-unit-get-number-of-built-in-units">gimp_unit_get_number_of_built_in_units</a>
(void);
<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> <a href="libgimpbase-gimpunit.html#gimp-unit-new">gimp_unit_new</a> (gchar *identifier,
gdouble factor,
gint digits,
gchar *symbol,
gchar *abbreviation,
gchar *singular,
gchar *plural);
gboolean <a href="libgimpbase-gimpunit.html#gimp-unit-get-deletion-flag">gimp_unit_get_deletion_flag</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
void <a href="libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag">gimp_unit_set_deletion_flag</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
gboolean deletion_flag);
gdouble <a href="libgimpbase-gimpunit.html#gimp-unit-get-factor">gimp_unit_get_factor</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
gint <a href="libgimpbase-gimpunit.html#gimp-unit-get-digits">gimp_unit_get_digits</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-identifier">gimp_unit_get_identifier</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-symbol">gimp_unit_get_symbol</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-abbreviation">gimp_unit_get_abbreviation</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-singular">gimp_unit_get_singular</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-plural">gimp_unit_get_plural</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
#define <a href="libgimpbase-gimpunit.html#GIMP-TYPE-UNIT:CAPS">GIMP_TYPE_UNIT</a>
#define <a href="libgimpbase-gimpunit.html#GIMP-VALUE-HOLDS-UNIT:CAPS">GIMP_VALUE_HOLDS_UNIT</a> (value)
enum <a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a>;
gint <a href="libgimpbase-gimpunit.html#gimp-unit-get-number-of-units">gimp_unit_get_number_of_units</a> (void);
gint <a href="libgimpbase-gimpunit.html#gimp-unit-get-number-of-built-in-units">gimp_unit_get_number_of_built_in_units</a>
(void);
<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> <a href="libgimpbase-gimpunit.html#gimp-unit-new">gimp_unit_new</a> (gchar *identifier,
gdouble factor,
gint digits,
gchar *symbol,
gchar *abbreviation,
gchar *singular,
gchar *plural);
gboolean <a href="libgimpbase-gimpunit.html#gimp-unit-get-deletion-flag">gimp_unit_get_deletion_flag</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
void <a href="libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag">gimp_unit_set_deletion_flag</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
gboolean deletion_flag);
gdouble <a href="libgimpbase-gimpunit.html#gimp-unit-get-factor">gimp_unit_get_factor</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
gint <a href="libgimpbase-gimpunit.html#gimp-unit-get-digits">gimp_unit_get_digits</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-identifier">gimp_unit_get_identifier</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-symbol">gimp_unit_get_symbol</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-abbreviation">gimp_unit_get_abbreviation</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-singular">gimp_unit_get_singular</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
const gchar* <a href="libgimpbase-gimpunit.html#gimp-unit-get-plural">gimp_unit_get_plural</a> (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);
#define <a href="libgimpbase-gimpunit.html#GIMP-TYPE-UNIT:CAPS">GIMP_TYPE_UNIT</a>
#define <a href="libgimpbase-gimpunit.html#GIMP-TYPE-PARAM-UNIT:CAPS">GIMP_TYPE_PARAM_UNIT</a>
#define <a href="libgimpbase-gimpunit.html#GIMP-IS-PARAM-SPEC-UNIT:CAPS">GIMP_IS_PARAM_SPEC_UNIT</a> (pspec)
GParamSpec* <a href="libgimpbase-gimpunit.html#gimp-param-spec-unit">gimp_param_spec_unit</a> (const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean allow_pixels,
gboolean allow_percent,
<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> default_value,
GParamFlags flags);
#define <a href="libgimpbase-gimpunit.html#GIMP-VALUE-HOLDS-UNIT:CAPS">GIMP_VALUE_HOLDS_UNIT</a> (value)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2559445"></a><h2>Description</h2>
<a name="id2520737"></a><h2>Description</h2>
<p>
Provides a collection of predefined units and functions for creating
user-defined units.
@ -78,11 +83,11 @@ user-defined units.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2559462"></a><h2>Details</h2>
<a name="id2520821"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2559473"></a><h3>
<a name="id2520827"></a><h3>
<a name="GimpUnit"></a>enum GimpUnit</h3>
<a class="indexterm" name="id2559485"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
<a class="indexterm" name="id2520836"></a><pre class="programlisting">typedef enum /*&lt; skip &gt;*/
{
GIMP_UNIT_PIXEL = 0,
@ -102,9 +107,9 @@ user-defined units.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576029"></a><h3>
<a name="id2520856"></a><h3>
<a name="gimp-unit-get-number-of-units"></a>gimp_unit_get_number_of_units ()</h3>
<a class="indexterm" name="id2576041"></a><pre class="programlisting">gint gimp_unit_get_number_of_units (void);</pre>
<a class="indexterm" name="id2520865"></a><pre class="programlisting">gint gimp_unit_get_number_of_units (void);</pre>
<p>
Returns the number of units which are known to the <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a> system.</p>
<p>
@ -113,7 +118,8 @@ Returns the number of units which are known to the <a href="libgimpbase-gimpunit
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The number of defined units.
</td>
</tr></tbody>
@ -121,10 +127,10 @@ Returns the number of units which are known to the <a href="libgimpbase-gimpunit
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576088"></a><h3>
<a name="id2520912"></a><h3>
<a name="gimp-unit-get-number-of-built-in-units"></a>gimp_unit_get_number_of_built_in_units ()</h3>
<a class="indexterm" name="id2576099"></a><pre class="programlisting">gint gimp_unit_get_number_of_built_in_units
(void);</pre>
<a class="indexterm" name="id2520921"></a><pre class="programlisting">gint gimp_unit_get_number_of_built_in_units
(void);</pre>
<p>
Returns the number of <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>'s which are hardcoded in the unit system
(UNIT_INCH, UNIT_MM, UNIT_POINT, UNIT_PICA and the two "pseudo unit"
@ -135,7 +141,8 @@ Returns the number of <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The number of built-in units.
</td>
</tr></tbody>
@ -143,15 +150,15 @@ Returns the number of <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576150"></a><h3>
<a name="id2520971"></a><h3>
<a name="gimp-unit-new"></a>gimp_unit_new ()</h3>
<a class="indexterm" name="id2576162"></a><pre class="programlisting"><a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (gchar *identifier,
gdouble factor,
gint digits,
gchar *symbol,
gchar *abbreviation,
gchar *singular,
gchar *plural);</pre>
<a class="indexterm" name="id2520981"></a><pre class="programlisting"><a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> gimp_unit_new (gchar *identifier,
gdouble factor,
gint digits,
gchar *symbol,
gchar *abbreviation,
gchar *singular,
gchar *plural);</pre>
<p>
Returns the integer ID of the new <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>.
</p>
@ -166,42 +173,50 @@ set to <code class="literal">TRUE</code>. You will have to set it to <code class
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>identifier</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>identifier</code></em>&#160;:</span></td>
<td> The unit's identifier string.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>factor</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>factor</code></em>&#160;:</span></td>
<td> The unit's factor (how many units are in one inch).
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>digits</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>digits</code></em>&#160;:</span></td>
<td> The unit's suggested number of digits (see <a href="libgimpbase-gimpunit.html#gimp-unit-get-digits"><code class="function">gimp_unit_get_digits()</code></a>).
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>symbol</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>symbol</code></em>&#160;:</span></td>
<td> The symbol of the unit (e.g. "''" for inch).
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>abbreviation</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>abbreviation</code></em>&#160;:</span></td>
<td> The abbreviation of the unit.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>singular</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>singular</code></em>&#160;:</span></td>
<td> The singular form of the unit.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>plural</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>plural</code></em>&#160;:</span></td>
<td> The plural form of the unit.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The ID of the new unit.
</td>
</tr>
@ -210,9 +225,9 @@ set to <code class="literal">TRUE</code>. You will have to set it to <code class
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560173"></a><h3>
<a name="id2529125"></a><h3>
<a name="gimp-unit-get-deletion-flag"></a>gimp_unit_get_deletion_flag ()</h3>
<a class="indexterm" name="id2560184"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2529135"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
</p>
<p>
@ -222,12 +237,14 @@ set to <code class="literal">TRUE</code>. You will have to set it to <code class
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td> The unit you want to know the <em class="parameter"><code>deletion_flag</code></em> of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The unit's <em class="parameter"><code>deletion_flag</code></em>.
</td>
</tr>
@ -236,10 +253,10 @@ set to <code class="literal">TRUE</code>. You will have to set it to <code class
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560257"></a><h3>
<a name="id2529207"></a><h3>
<a name="gimp-unit-set-deletion-flag"></a>gimp_unit_set_deletion_flag ()</h3>
<a class="indexterm" name="id2560269"></a><pre class="programlisting">void gimp_unit_set_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
gboolean deletion_flag);</pre>
<a class="indexterm" name="id2529217"></a><pre class="programlisting">void gimp_unit_set_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit,
gboolean deletion_flag);</pre>
<p>
Sets a <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>'s <em class="parameter"><code>deletion_flag</code></em>. If the <em class="parameter"><code>deletion_flag</code></em> of a unit is
<code class="literal">TRUE</code> when GIMP exits, this unit will not be saved in the users's
@ -255,12 +272,14 @@ ignored.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td> The unit you want to set the <em class="parameter"><code>deletion_flag</code></em> for.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>deletion_flag</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>deletion_flag</code></em>&#160;:</span></td>
<td> The new deletion_flag.
</td>
</tr>
@ -269,9 +288,9 @@ ignored.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605995"></a><h3>
<a name="id2566090"></a><h3>
<a name="gimp-unit-get-factor"></a>gimp_unit_get_factor ()</h3>
<a class="indexterm" name="id2606005"></a><pre class="programlisting">gdouble gimp_unit_get_factor (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2566099"></a><pre class="programlisting">gdouble gimp_unit_get_factor (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
A <a href="libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a>'s <em class="parameter"><code>factor</code></em> is defined to be:
</p>
@ -287,12 +306,14 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td> The unit you want to know the factor of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The unit's factor.
</td>
</tr>
@ -301,9 +322,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606064"></a><h3>
<a name="id2566185"></a><h3>
<a name="gimp-unit-get-digits"></a>gimp_unit_get_digits ()</h3>
<a class="indexterm" name="id2606074"></a><pre class="programlisting">gint gimp_unit_get_digits (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2566194"></a><pre class="programlisting">gint gimp_unit_get_digits (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
Returns the number of digits an entry field should provide to get
approximately the same accuracy as an inch input field with two digits.
@ -317,12 +338,14 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td> The unit you want to know the digits.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The suggested number of digits.
</td>
</tr>
@ -331,9 +354,9 @@ Returns 0 for <em class="parameter"><code>unit</code></em> == GIMP_UNIT_PIXEL.</
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606140"></a><h3>
<a name="id2566266"></a><h3>
<a name="gimp-unit-get-identifier"></a>gimp_unit_get_identifier ()</h3>
<a class="indexterm" name="id2606150"></a><pre class="programlisting">const gchar* gimp_unit_get_identifier (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2566275"></a><pre class="programlisting">const gchar* gimp_unit_get_identifier (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
This is an unstranslated string and must not be changed or freed.</p>
<p>
@ -343,12 +366,14 @@ This is an unstranslated string and must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td> The unit you want to know the identifier of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The unit's identifier.
</td>
</tr>
@ -357,9 +382,9 @@ This is an unstranslated string and must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606207"></a><h3>
<a name="id2566338"></a><h3>
<a name="gimp-unit-get-symbol"></a>gimp_unit_get_symbol ()</h3>
<a class="indexterm" name="id2606217"></a><pre class="programlisting">const gchar* gimp_unit_get_symbol (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2566346"></a><pre class="programlisting">const gchar* gimp_unit_get_symbol (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
This is e.g. "''" for UNIT_INCH.
</p>
@ -372,12 +397,14 @@ NOTE: This string must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td> The unit you want to know the symbol of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The unit's symbol.
</td>
</tr>
@ -386,9 +413,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606277"></a><h3>
<a name="id2566413"></a><h3>
<a name="gimp-unit-get-abbreviation"></a>gimp_unit_get_abbreviation ()</h3>
<a class="indexterm" name="id2606288"></a><pre class="programlisting">const gchar* gimp_unit_get_abbreviation (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2566422"></a><pre class="programlisting">const gchar* gimp_unit_get_abbreviation (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
For built-in units, this function returns the translated abbreviation
of the unit.
@ -402,12 +429,14 @@ NOTE: This string must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td> The unit you want to know the abbreviation of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The unit's abbreviation.
</td>
</tr>
@ -416,9 +445,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606349"></a><h3>
<a name="id2566489"></a><h3>
<a name="gimp-unit-get-singular"></a>gimp_unit_get_singular ()</h3>
<a class="indexterm" name="id2606360"></a><pre class="programlisting">const gchar* gimp_unit_get_singular (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2566498"></a><pre class="programlisting">const gchar* gimp_unit_get_singular (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
For built-in units, this function returns the translated singular form
of the unit's name.
@ -432,12 +461,14 @@ NOTE: This string must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td> The unit you want to know the singular form of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The unit's singular form.
</td>
</tr>
@ -446,9 +477,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606421"></a><h3>
<a name="id2566566"></a><h3>
<a name="gimp-unit-get-plural"></a>gimp_unit_get_plural ()</h3>
<a class="indexterm" name="id2606432"></a><pre class="programlisting">const gchar* gimp_unit_get_plural (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<a class="indexterm" name="id2566575"></a><pre class="programlisting">const gchar* gimp_unit_get_plural (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre>
<p>
For built-in units, this function returns the translated plural form
of the unit's name.
@ -462,12 +493,14 @@ NOTE: This string must not be changed or freed.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
<td> The unit you want to know the plural form of.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The unit's plural form.
</td>
</tr>
@ -476,9 +509,9 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606493"></a><h3>
<a name="id2566642"></a><h3>
<a name="GIMP-TYPE-UNIT:CAPS"></a>GIMP_TYPE_UNIT</h3>
<a class="indexterm" name="id2606503"></a><pre class="programlisting">#define GIMP_TYPE_UNIT (gimp_unit_get_type ())
<a class="indexterm" name="id2566652"></a><pre class="programlisting">#define GIMP_TYPE_UNIT (gimp_unit_get_type ())
</pre>
<p>
<a href="libgimpbase-gimpunit.html#GIMP-TYPE-UNIT:CAPS"><span class="type">GIMP_TYPE_UNIT</span></a> is a <span class="type">GType</span> derived from <span class="type">G_TYPE_INT</span>.
@ -486,9 +519,19 @@ NOTE: This string must not be changed or freed.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606537"></a><h3>
<a name="GIMP-VALUE-HOLDS-UNIT:CAPS"></a>GIMP_VALUE_HOLDS_UNIT()</h3>
<a class="indexterm" name="id2606547"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
<a name="id2566690"></a><h3>
<a name="GIMP-TYPE-PARAM-UNIT:CAPS"></a>GIMP_TYPE_PARAM_UNIT</h3>
<a class="indexterm" name="id2566699"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2566716"></a><h3>
<a name="GIMP-IS-PARAM-SPEC-UNIT:CAPS"></a>GIMP_IS_PARAM_SPEC_UNIT()</h3>
<a class="indexterm" name="id2566727"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_UNIT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))
</pre>
<p>
@ -496,7 +539,103 @@ NOTE: This string must not be changed or freed.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>pspec</code></em>&#160;:</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2566762"></a><h3>
<a name="gimp-param-spec-unit"></a>gimp_param_spec_unit ()</h3>
<a class="indexterm" name="id2566771"></a><pre class="programlisting">GParamSpec* gimp_param_spec_unit (const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean allow_pixels,
gboolean allow_percent,
<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> default_value,
GParamFlags flags);</pre>
<p>
Creates a param spec to hold a units param.
See <code class="function">g_param_spec_internal()</code> for more information.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> Canonical name of the param
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>nick</code></em>&#160;:</span></td>
<td> Nickname of the param
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>blurb</code></em>&#160;:</span></td>
<td> Brief desciption of param.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>allow_pixels</code></em>&#160;:</span></td>
<td> Whether "pixels" is an allowed unit.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>allow_percent</code></em>&#160;:</span></td>
<td> Whether "perecent" is an allowed unit.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></td>
<td> Unit to use if none is assigned.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
<td> a combination of <span class="type">GParamFlags</span>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a newly allocated <span class="type">GParamSpec</span> instance
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2566989"></a><h3>
<a name="GIMP-VALUE-HOLDS-UNIT:CAPS"></a>GIMP_VALUE_HOLDS_UNIT()</h3>
<a class="indexterm" name="id2566998"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td>
@ -506,7 +645,7 @@ NOTE: This string must not be changed or freed.</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2606580"></a><h2>See Also</h2>
<a name="id2567035"></a><h2>See Also</h2>
<p>
<a
href="../libgimpwidgets/GimpUnitMenu.html"
@ -519,5 +658,9 @@ href="../libgimpwidgets/GimpSizeEntry.html"
</p>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpsignal.html"><b>&lt;&lt;&#160;gimpsignal</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimputils.html"><b>gimputils&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

387
devel-docs/libgimpbase/html/libgimpbase-gimputils.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimputils</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpunit.html" title="gimpunit">
<link rel="next" href="libgimpbase-gimpprotocol.html" title="gimpprotocol">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="next" href="ix01.html" title="Index">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpunit.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpprotocol.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2585499" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2604658" class="shortcut">Description</a></nobr></td></tr>
</table>
<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimputils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2585499"></a><span class="refentrytitle">gimputils</span>
</h2>
<h2><span class="refentrytitle">gimputils</span></h2>
<p>gimputils &#8212; Utilities of general interest</p>
</td>
<td valign="top" align="right"></td>
@ -42,56 +38,57 @@
gchar* <a href="libgimpbase-gimputils.html#gimp-any-to-utf8">gimp_any_to_utf8</a> (const gchar *str,
gssize len,
const gchar *warning_format,
...);
const gchar* <a href="libgimpbase-gimputils.html#gimp-filename-to-utf8">gimp_filename_to_utf8</a> (const gchar *filename);
gchar* <a href="libgimpbase-gimputils.html#gimp-utf8-strtrim">gimp_utf8_strtrim</a> (const gchar *str,
gint max_chars);
gchar* <a href="libgimpbase-gimputils.html#gimp-escape-uline">gimp_escape_uline</a> (const gchar *str);
gchar* <a href="libgimpbase-gimputils.html#gimp-strip-uline">gimp_strip_uline</a> (const gchar *str);
<a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a href="libgimpbase-gimputils.html#gimp-enum-get-desc">gimp_enum_get_desc</a> (GEnumClass *enum_class,
gint value);
gboolean <a href="libgimpbase-gimputils.html#gimp-enum-get-value">gimp_enum_get_value</a> (GType enum_type,
gint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-desc">gimp_enum_value_get_desc</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-help">gimp_enum_value_get_help</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
<a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a href="libgimpbase-gimputils.html#gimp-flags-get-first-desc">gimp_flags_get_first_desc</a> (GFlagsClass *flags_class,
guint value);
gboolean <a href="libgimpbase-gimputils.html#gimp-flags-get-first-value">gimp_flags_get_first_value</a> (GType flags_type,
guint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-desc">gimp_flags_value_get_desc</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-help">gimp_flags_value_get_help</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
gchar* <a href="libgimpbase-gimputils.html#gimp-any-to-utf8">gimp_any_to_utf8</a> (const gchar *str,
gssize len,
const gchar *warning_format,
...);
const gchar* <a href="libgimpbase-gimputils.html#gimp-filename-to-utf8">gimp_filename_to_utf8</a> (const gchar *filename);
gchar* <a href="libgimpbase-gimputils.html#gimp-utf8-strtrim">gimp_utf8_strtrim</a> (const gchar *str,
gint max_chars);
gchar* <a href="libgimpbase-gimputils.html#gimp-escape-uline">gimp_escape_uline</a> (const gchar *str);
gchar* <a href="libgimpbase-gimputils.html#gimp-strip-uline">gimp_strip_uline</a> (const gchar *str);
gchar* <a href="libgimpbase-gimputils.html#gimp-canonicalize-identifier">gimp_canonicalize_identifier</a> (const gchar *identifier);
<a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* <a href="libgimpbase-gimputils.html#gimp-enum-get-desc">gimp_enum_get_desc</a> (GEnumClass *enum_class,
gint value);
gboolean <a href="libgimpbase-gimputils.html#gimp-enum-get-value">gimp_enum_get_value</a> (GType enum_type,
gint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-desc">gimp_enum_value_get_desc</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
const gchar* <a href="libgimpbase-gimputils.html#gimp-enum-value-get-help">gimp_enum_value_get_help</a> (GEnumClass *enum_class,
GEnumValue *enum_value);
<a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* <a href="libgimpbase-gimputils.html#gimp-flags-get-first-desc">gimp_flags_get_first_desc</a> (GFlagsClass *flags_class,
guint value);
gboolean <a href="libgimpbase-gimputils.html#gimp-flags-get-first-value">gimp_flags_get_first_value</a> (GType flags_type,
guint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-desc">gimp_flags_value_get_desc</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
const gchar* <a href="libgimpbase-gimputils.html#gimp-flags-value-get-help">gimp_flags_value_get_help</a> (GFlagsClass *flags_class,
GFlagsValue *flags_value);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2604658"></a><h2>Description</h2>
<a name="id2523734"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2604674"></a><h2>Details</h2>
<a name="id2523745"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2604685"></a><h3>
<a name="id2523751"></a><h3>
<a name="gimp-any-to-utf8"></a>gimp_any_to_utf8 ()</h3>
<a class="indexterm" name="id2604697"></a><pre class="programlisting">gchar* gimp_any_to_utf8 (const gchar *str,
gssize len,
const gchar *warning_format,
...);</pre>
<a class="indexterm" name="id2523761"></a><pre class="programlisting">gchar* gimp_any_to_utf8 (const gchar *str,
gssize len,
const gchar *warning_format,
...);</pre>
<p>
This function takes any string (UTF-8 or not) and always returns a valid
UTF-8 string.
@ -114,30 +111,35 @@ of <em class="parameter"><code>str</code></em> is valid UTF-8, only "(invalid UT
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></td>
<td> The string to be converted to UTF-8.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>len</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>len</code></em>&#160;:</span></td>
<td> The length of the string, or -1 if the string
is nul-terminated.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>warning_format</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>warning_format</code></em>&#160;:</span></td>
<td> The message format for the warning message if conversion
to UTF-8 fails. See the <code class="function"><code class="function">printf()</code></code>
documentation.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td> The parameters to insert into the format string.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The UTF-8 string as described above.
</td>
</tr>
@ -146,9 +148,9 @@ of <em class="parameter"><code>str</code></em> is valid UTF-8, only "(invalid UT
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2569275"></a><h3>
<a name="id2523939"></a><h3>
<a name="gimp-filename-to-utf8"></a>gimp_filename_to_utf8 ()</h3>
<a class="indexterm" name="id2569286"></a><pre class="programlisting">const gchar* gimp_filename_to_utf8 (const gchar *filename);</pre>
<a class="indexterm" name="id2523948"></a><pre class="programlisting">const gchar* gimp_filename_to_utf8 (const gchar *filename);</pre>
<p>
Convert a filename in the filesystem's encoding to UTF-8
temporarily. The return value is a pointer to a string that is
@ -166,12 +168,14 @@ UTF-8 encoded filename.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td> The filename to be converted to UTF-8.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A temporarily valid UTF-8 representation of <em class="parameter"><code>filename</code></em>.
This string must not be changed or freed.
</td>
@ -181,10 +185,10 @@ UTF-8 encoded filename.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2569373"></a><h3>
<a name="id2562448"></a><h3>
<a name="gimp-utf8-strtrim"></a>gimp_utf8_strtrim ()</h3>
<a class="indexterm" name="id2569386"></a><pre class="programlisting">gchar* gimp_utf8_strtrim (const gchar *str,
gint max_chars);</pre>
<a class="indexterm" name="id2562458"></a><pre class="programlisting">gchar* gimp_utf8_strtrim (const gchar *str,
gint max_chars);</pre>
<p>
Creates a (possibly trimmed) copy of <em class="parameter"><code>str</code></em>. The string is cut if it
exceeds <em class="parameter"><code>max_chars</code></em> characters or on the first newline. The fact
@ -196,18 +200,21 @@ that the string was trimmed is indicated by appending an ellipsis.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></td>
<td> an UTF-8 encoded string (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>max_chars</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>max_chars</code></em>&#160;:</span></td>
<td> the maximum number of characters before the string get
trimmed
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A (possibly trimmed) copy of <em class="parameter"><code>str</code></em> which should be freed
using <code class="function">g_free()</code> when it is not needed any longer.
</td>
@ -217,9 +224,9 @@ using <code class="function">g_free()</code> when it is not needed any longer.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2569505"></a><h3>
<a name="id2562573"></a><h3>
<a name="gimp-escape-uline"></a>gimp_escape_uline ()</h3>
<a class="indexterm" name="id2569519"></a><pre class="programlisting">gchar* gimp_escape_uline (const gchar *str);</pre>
<a class="indexterm" name="id2562583"></a><pre class="programlisting">gchar* gimp_escape_uline (const gchar *str);</pre>
<p>
This function returns a copy of <em class="parameter"><code>str</code></em> with all underline converted
to two adjacent underlines. This comes in handy when needing to display
@ -232,12 +239,14 @@ them to mnemonics.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></td>
<td> Underline infested string (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A (possibly escaped) copy of <em class="parameter"><code>str</code></em> which should be
freed using <code class="function">g_free()</code> when it is not needed any longer.
@ -245,14 +254,14 @@ freed using <code class="function">g_free()</code> when it is not needed any lon
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2608670"></a><h3>
<a name="id2568622"></a><h3>
<a name="gimp-strip-uline"></a>gimp_strip_uline ()</h3>
<a class="indexterm" name="id2608680"></a><pre class="programlisting">gchar* gimp_strip_uline (const gchar *str);</pre>
<a class="indexterm" name="id2568630"></a><pre class="programlisting">gchar* gimp_strip_uline (const gchar *str);</pre>
<p>
This function returns a copy of <em class="parameter"><code>str</code></em> stripped of underline
characters. This comes in handy when needing to strip mnemonics
@ -270,12 +279,14 @@ rid of the mnemonic (see bug <span class="type">157561</span>).</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>str</code></em>&#160;:</span></td>
<td> underline infested string (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A (possibly stripped) copy of <em class="parameter"><code>str</code></em> which should be
freed using <code class="function">g_free()</code> when it is not needed any longer.
</td>
@ -285,10 +296,48 @@ rid of the mnemonic (see bug <span class="type">157561</span>).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2608783"></a><h3>
<a name="id2568726"></a><h3>
<a name="gimp-canonicalize-identifier"></a>gimp_canonicalize_identifier ()</h3>
<a class="indexterm" name="id2568736"></a><pre class="programlisting">gchar* gimp_canonicalize_identifier (const gchar *identifier);</pre>
<p>
Turns any input string into a canonicalized string.
</p>
<p>
Canonical identifiers are e.g. expected by the PDB for procedure
and parameter names. Every character of the input string that is
not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>identifier</code></em>&#160;:</span></td>
<td> The identifier string to canonicalize.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The canonicalized identifier. This is a newly
allocated string that should be freed with <code class="function">g_free()</code>
when no longer needed.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568821"></a><h3>
<a name="gimp-enum-get-desc"></a>gimp_enum_get_desc ()</h3>
<a class="indexterm" name="id2608798"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_desc (GEnumClass *enum_class,
gint value);</pre>
<a class="indexterm" name="id2568831"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc">GimpEnumDesc</a>* gimp_enum_get_desc (GEnumClass *enum_class,
gint value);</pre>
<p>
Retrieves <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a> associated with the given value, or <code class="literal">NULL</code>.</p>
<p>
@ -298,36 +347,39 @@ Retrieves <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="typ
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></td>
<td> a <span class="type">GEnumClass</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> a value from <em class="parameter"><code>enum_class</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the value's <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2608925"></a><h3>
<a name="id2568952"></a><h3>
<a name="gimp-enum-get-value"></a>gimp_enum_get_value ()</h3>
<a class="indexterm" name="id2608939"></a><pre class="programlisting">gboolean gimp_enum_get_value (GType enum_type,
gint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);</pre>
<a class="indexterm" name="id2568962"></a><pre class="programlisting">gboolean gimp_enum_get_value (GType enum_type,
gint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);</pre>
<p>
Checks if <em class="parameter"><code>value</code></em> is valid for the enum registered as <em class="parameter"><code>enum_type</code></em>.
If the value exists in that enum, its name, nick and its translated
@ -340,37 +392,44 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>enum_type</code></em>&#160;:</span></td>
<td> the <span class="type">GType</span> of a registered enum
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> an integer value
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_name</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value_name</code></em>&#160;:</span></td>
<td> return location for the value's name (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_nick</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value_nick</code></em>&#160;:</span></td>
<td> return location for the value's nick (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_desc</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value_desc</code></em>&#160;:</span></td>
<td> return location for the value's translated desc (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_help</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value_help</code></em>&#160;:</span></td>
<td> return location for the value's translated help (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>value</code></em> is valid for the <em class="parameter"><code>enum_type</code></em>,
<code class="literal">FALSE</code> otherwise
@ -378,15 +437,15 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609239"></a><h3>
<a name="id2569234"></a><h3>
<a name="gimp-enum-value-get-desc"></a>gimp_enum_value_get_desc ()</h3>
<a class="indexterm" name="id2609252"></a><pre class="programlisting">const gchar* gimp_enum_value_get_desc (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<a class="indexterm" name="id2569243"></a><pre class="programlisting">const gchar* gimp_enum_value_get_desc (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<p>
Retrieves the translated desc for a given <em class="parameter"><code>enum_value</code></em>.</p>
<p>
@ -396,32 +455,35 @@ Retrieves the translated desc for a given <em class="parameter"><code>enum_value
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></td>
<td> a <span class="type">GEnumClass</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>enum_value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>enum_value</code></em>&#160;:</span></td>
<td> a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the translated desc of the enum value
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609370"></a><h3>
<a name="id2569357"></a><h3>
<a name="gimp-enum-value-get-help"></a>gimp_enum_value_get_help ()</h3>
<a class="indexterm" name="id2609383"></a><pre class="programlisting">const gchar* gimp_enum_value_get_help (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<a class="indexterm" name="id2569366"></a><pre class="programlisting">const gchar* gimp_enum_value_get_help (GEnumClass *enum_class,
GEnumValue *enum_value);</pre>
<p>
Retrieves the translated help for a given <em class="parameter"><code>enum_value</code></em>.</p>
<p>
@ -431,32 +493,35 @@ Retrieves the translated help for a given <em class="parameter"><code>enum_value
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>enum_class</code></em>&#160;:</span></td>
<td> a <span class="type">GEnumClass</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>enum_value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>enum_value</code></em>&#160;:</span></td>
<td> a <span class="type">GEnumValue</span> from <em class="parameter"><code>enum_class</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the translated help of the enum value
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609500"></a><h3>
<a name="id2569480"></a><h3>
<a name="gimp-flags-get-first-desc"></a>gimp_flags_get_first_desc ()</h3>
<a class="indexterm" name="id2609514"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_first_desc (GFlagsClass *flags_class,
guint value);</pre>
<a class="indexterm" name="id2569490"></a><pre class="programlisting"><a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc">GimpFlagsDesc</a>* gimp_flags_get_first_desc (GFlagsClass *flags_class,
guint value);</pre>
<p>
Retrieves the first <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a> that matches the given value, or <code class="literal">NULL</code>.</p>
<p>
@ -466,36 +531,39 @@ Retrieves the first <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></td>
<td> a <span class="type">GFlagsClass</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> a value from <em class="parameter"><code>flags_class</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the value's <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609640"></a><h3>
<a name="id2569610"></a><h3>
<a name="gimp-flags-get-first-value"></a>gimp_flags_get_first_value ()</h3>
<a class="indexterm" name="id2609654"></a><pre class="programlisting">gboolean gimp_flags_get_first_value (GType flags_type,
guint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);</pre>
<a class="indexterm" name="id2569619"></a><pre class="programlisting">gboolean gimp_flags_get_first_value (GType flags_type,
guint value,
const gchar **value_name,
const gchar **value_nick,
const gchar **value_desc,
const gchar **value_help);</pre>
<p>
Checks if <em class="parameter"><code>value</code></em> is valid for the flags registered as <em class="parameter"><code>flags_type</code></em>.
If the value exists in that flags, its name, nick and its translated
@ -508,37 +576,44 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags_type</code></em>&#160;:</span></td>
<td> the <span class="type">GType</span> of registered flags
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> an integer value
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_name</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value_name</code></em>&#160;:</span></td>
<td> return location for the value's name (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_nick</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value_nick</code></em>&#160;:</span></td>
<td> return location for the value's nick (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_desc</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value_desc</code></em>&#160;:</span></td>
<td> return location for the value's translated desc (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value_help</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>value_help</code></em>&#160;:</span></td>
<td> return location for the value's translated help (or <code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>value</code></em> is valid for the <em class="parameter"><code>flags_type</code></em>,
<code class="literal">FALSE</code> otherwise
@ -546,15 +621,15 @@ and <em class="parameter"><code>value_help</code></em> are not <code class="lite
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609954"></a><h3>
<a name="id2569892"></a><h3>
<a name="gimp-flags-value-get-desc"></a>gimp_flags_value_get_desc ()</h3>
<a class="indexterm" name="id2609968"></a><pre class="programlisting">const gchar* gimp_flags_value_get_desc (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<a class="indexterm" name="id2569901"></a><pre class="programlisting">const gchar* gimp_flags_value_get_desc (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<p>
Retrieves the translated desc for a given <em class="parameter"><code>flags_value</code></em>.</p>
<p>
@ -564,32 +639,35 @@ Retrieves the translated desc for a given <em class="parameter"><code>flags_valu
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></td>
<td> a <span class="type">GFlagsClass</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags_value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags_value</code></em>&#160;:</span></td>
<td> a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the translated desc of the flags value
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610085"></a><h3>
<a name="id2569993"></a><h3>
<a name="gimp-flags-value-get-help"></a>gimp_flags_value_get_help ()</h3>
<a class="indexterm" name="id2610099"></a><pre class="programlisting">const gchar* gimp_flags_value_get_help (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<a class="indexterm" name="id2570002"></a><pre class="programlisting">const gchar* gimp_flags_value_get_help (GFlagsClass *flags_class,
GFlagsValue *flags_value);</pre>
<p>
Retrieves the translated help for a given <em class="parameter"><code>flags_value</code></em>.</p>
<p>
@ -599,27 +677,34 @@ Retrieves the translated help for a given <em class="parameter"><code>flags_valu
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags_class</code></em>&#160;:</span></td>
<td> a <span class="type">GFlagsClass</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>flags_value</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>flags_value</code></em>&#160;:</span></td>
<td> a <span class="type">GFlagsValue</span> from <em class="parameter"><code>flags_class</code></em>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the translated help of the flags value
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p>Since GIMP 2.2
</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpunit.html"><b>&lt;&lt;&#160;gimpunit</b></a></td>
<td align="right"><a accesskey="n" href="ix01.html"><b>Index&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

75
devel-docs/libgimpbase/html/libgimpbase-gimpversion.html
View File

@ -1,37 +1,33 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpversion</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpbasetypes.html" title="gimpbasetypes">
<link rel="next" href="libgimpbase-gimplimits.html" title="gimplimits">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpbasetypes.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimplimits.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2572683" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2571098" class="shortcut">Description</a></nobr></td></tr>
</table>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpversion"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2572683"></a><span class="refentrytitle">gimpversion</span>
</h2>
<h2><span class="refentrytitle">gimpversion</span></h2>
<p>gimpversion &#8212; Macros and constants useful for determining GIMP's version number and
capabilities.</p>
</td>
@ -43,16 +39,16 @@ capabilities.</p>
#define <a href="libgimpbase-gimpversion.html#GIMP-MAJOR-VERSION:CAPS">GIMP_MAJOR_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-MINOR-VERSION:CAPS">GIMP_MINOR_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-MICRO-VERSION:CAPS">GIMP_MICRO_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-VERSION:CAPS">GIMP_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-API-VERSION:CAPS">GIMP_API_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-CHECK-VERSION:CAPS">GIMP_CHECK_VERSION</a> (major, minor, micro)
#define <a href="libgimpbase-gimpversion.html#GIMP-MAJOR-VERSION:CAPS">GIMP_MAJOR_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-MINOR-VERSION:CAPS">GIMP_MINOR_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-MICRO-VERSION:CAPS">GIMP_MICRO_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-VERSION:CAPS">GIMP_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-API-VERSION:CAPS">GIMP_API_VERSION</a>
#define <a href="libgimpbase-gimpversion.html#GIMP-CHECK-VERSION:CAPS">GIMP_CHECK_VERSION</a> (major, minor, micro)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2571098"></a><h2>Description</h2>
<a name="id2524947"></a><h2>Description</h2>
<p>
Macros and constants useful for determining GIMP's version number and
capabilities.
@ -60,11 +56,11 @@ capabilities.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2572996"></a><h2>Details</h2>
<a name="id2524875"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2573007"></a><h3>
<a name="id2524881"></a><h3>
<a name="GIMP-MAJOR-VERSION:CAPS"></a>GIMP_MAJOR_VERSION</h3>
<a class="indexterm" name="id2573019"></a><pre class="programlisting">#define GIMP_MAJOR_VERSION (2)
<a class="indexterm" name="id2524890"></a><pre class="programlisting">#define GIMP_MAJOR_VERSION (2)
</pre>
<p>
@ -72,9 +68,9 @@ capabilities.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573034"></a><h3>
<a name="id2524906"></a><h3>
<a name="GIMP-MINOR-VERSION:CAPS"></a>GIMP_MINOR_VERSION</h3>
<a class="indexterm" name="id2573046"></a><pre class="programlisting">#define GIMP_MINOR_VERSION (2)
<a class="indexterm" name="id2545704"></a><pre class="programlisting">#define GIMP_MINOR_VERSION (3)
</pre>
<p>
@ -82,9 +78,9 @@ capabilities.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573062"></a><h3>
<a name="id2545720"></a><h3>
<a name="GIMP-MICRO-VERSION:CAPS"></a>GIMP_MICRO_VERSION</h3>
<a class="indexterm" name="id2573074"></a><pre class="programlisting">#define GIMP_MICRO_VERSION (17)
<a class="indexterm" name="id2545729"></a><pre class="programlisting">#define GIMP_MICRO_VERSION (6)
</pre>
<p>
@ -92,9 +88,9 @@ capabilities.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573091"></a><h3>
<a name="id2545746"></a><h3>
<a name="GIMP-VERSION:CAPS"></a>GIMP_VERSION</h3>
<a class="indexterm" name="id2573103"></a><pre class="programlisting">#define GIMP_VERSION "2.2.17"
<a class="indexterm" name="id2545756"></a><pre class="programlisting">#define GIMP_VERSION "2.3.6"
</pre>
<p>
@ -102,9 +98,9 @@ capabilities.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573120"></a><h3>
<a name="id2545773"></a><h3>
<a name="GIMP-API-VERSION:CAPS"></a>GIMP_API_VERSION</h3>
<a class="indexterm" name="id2589603"></a><pre class="programlisting">#define GIMP_API_VERSION "2.0"
<a class="indexterm" name="id2545782"></a><pre class="programlisting">#define GIMP_API_VERSION "2.0"
</pre>
<p>
Since: GIMP 2.2
@ -112,9 +108,9 @@ Since: GIMP 2.2
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2589620"></a><h3>
<a name="id2545799"></a><h3>
<a name="GIMP-CHECK-VERSION:CAPS"></a>GIMP_CHECK_VERSION()</h3>
<a class="indexterm" name="id2589631"></a><pre class="programlisting">#define GIMP_CHECK_VERSION(major, minor, micro)</pre>
<a class="indexterm" name="id2545808"></a><pre class="programlisting">#define GIMP_CHECK_VERSION(major, minor, micro)</pre>
<p>
</p>
@ -122,17 +118,20 @@ Since: GIMP 2.2
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>major</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>major</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>minor</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>minor</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>micro</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>micro</code></em>&#160;:</span></td>
<td>
@ -143,5 +142,9 @@ Since: GIMP 2.2
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimpbase-gimpbasetypes.html"><b>&lt;&lt;&#160;gimpbasetypes</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimplimits.html"><b>gimplimits&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

1098
devel-docs/libgimpbase/html/libgimpbase-gimpwire.html
View File

File diff suppressed because it is too large Load Diff

86
devel-docs/libgimpbase/html/libgimpbase.devhelp
View File

@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "">
<book xmlns="http://www.devhelp.net/book" title="GIMP Base Library Reference Manual" link="index.html" author="" name="libgimpbase">
<chapters>
<sub name="GIMP Base Library" link="libgimpbase.html">
@ -16,21 +15,41 @@
<sub name="gimpsignal" link="libgimpbase-gimpsignal.html"/>
<sub name="gimpunit" link="libgimpbase-gimpunit.html"/>
<sub name="gimputils" link="libgimpbase-gimputils.html"/>
<sub name="gimpprotocol" link="libgimpbase-gimpprotocol.html"/>
<sub name="gimpwire" link="libgimpbase-gimpwire.html"/>
</sub>
<sub name="Index" link="ix01.html"/>
<sub name="Index of new symbols in GIMP 2.2" link="ix02.html"/>
<sub name="Index of new symbols in GIMP 2.4" link="ix03.html"/>
<sub name="Index of deprecated symbols" link="ix04.html"/>
</chapters>
<functions>
<function name="enum GimpAddMaskType" link="libgimpbase-gimpbaseenums.html#GimpAddMaskType"/>
<function name="enum GimpBlendMode" link="libgimpbase-gimpbaseenums.html#GimpBlendMode"/>
<function name="enum GimpBucketFillMode" link="libgimpbase-gimpbaseenums.html#GimpBucketFillMode"/>
<function name="enum GimpChannelOps" link="libgimpbase-gimpbaseenums.html#GimpChannelOps"/>
<function name="enum GimpChannelType" link="libgimpbase-gimpbaseenums.html#GimpChannelType"/>
<function name="enum GimpCheckSize" link="libgimpbase-gimpbaseenums.html#GimpCheckSize"/>
<function name="enum GimpCheckType" link="libgimpbase-gimpbaseenums.html#GimpCheckType"/>
<function name="enum GimpCloneType" link="libgimpbase-gimpbaseenums.html#GimpCloneType"/>
<function name="enum GimpDesaturateMode" link="libgimpbase-gimpbaseenums.html#GimpDesaturateMode"/>
<function name="enum GimpDodgeBurnType" link="libgimpbase-gimpbaseenums.html#GimpDodgeBurnType"/>
<function name="enum GimpForegroundExtractMode" link="libgimpbase-gimpbaseenums.html#GimpForegroundExtractMode"/>
<function name="enum GimpGradientType" link="libgimpbase-gimpbaseenums.html#GimpGradientType"/>
<function name="enum GimpGridStyle" link="libgimpbase-gimpbaseenums.html#GimpGridStyle"/>
<function name="enum GimpIconType" link="libgimpbase-gimpbaseenums.html#GimpIconType"/>
<function name="enum GimpImageBaseType" link="libgimpbase-gimpbaseenums.html#GimpImageBaseType"/>
<function name="enum GimpImageType" link="libgimpbase-gimpbaseenums.html#GimpImageType"/>
<function name="enum GimpInterpolationType" link="libgimpbase-gimpbaseenums.html#GimpInterpolationType"/>
<function name="enum GimpMessageHandlerType" link="libgimpbase-gimpbaseenums.html#GimpMessageHandlerType"/>
<function name="enum GimpPaintApplicationMode" link="libgimpbase-gimpbaseenums.html#GimpPaintApplicationMode"/>
<function name="enum GimpPDBArgType" link="libgimpbase-gimpbaseenums.html#GimpPDBArgType"/>
<function name="enum GimpPDBProcType" link="libgimpbase-gimpbaseenums.html#GimpPDBProcType"/>
<function name="enum GimpPDBStatusType" link="libgimpbase-gimpbaseenums.html#GimpPDBStatusType"/>
<function name="enum GimpProgressCommand" link="libgimpbase-gimpbaseenums.html#GimpProgressCommand"/>
<function name="enum GimpRepeatMode" link="libgimpbase-gimpbaseenums.html#GimpRepeatMode"/>
<function name="enum GimpSizeType" link="libgimpbase-gimpbaseenums.html#GimpSizeType"/>
<function name="enum GimpStackTraceMode" link="libgimpbase-gimpbaseenums.html#GimpStackTraceMode"/>
<function name="enum GimpTransferMode" link="libgimpbase-gimpbaseenums.html#GimpTransferMode"/>
<function name="enum GimpTransformDirection" link="libgimpbase-gimpbaseenums.html#GimpTransformDirection"/>
<function name="GimpEnumDesc" link="libgimpbase-gimpbasetypes.html#GimpEnumDesc"/>
<function name="GimpFlagsDesc" link="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"/>
<function name="gimp_type_set_translation_domain ()" link="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain"/>
@ -59,6 +78,7 @@
<function name="GimpDatafileLoaderFunc ()" link="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc"/>
<function name="gimp_datafiles_check_extension ()" link="libgimpbase-gimpdatafiles.html#gimp-datafiles-check-extension"/>
<function name="gimp_datafiles_read_directories ()" link="libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories"/>
<function name="gimp_env_init ()" link="libgimpbase-gimpenv.html#gimp-env-init"/>
<function name="gimp_directory ()" link="libgimpbase-gimpenv.html#gimp-directory"/>
<function name="gimp_personal_rc_file ()" link="libgimpbase-gimpenv.html#gimp-personal-rc-file"/>
<function name="gimp_data_directory ()" link="libgimpbase-gimpenv.html#gimp-data-directory"/>
@ -74,6 +94,9 @@
<function name="gimp_memsize_deserialize ()" link="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize"/>
<function name="gimp_memsize_to_string ()" link="libgimpbase-gimpmemsize.html#gimp-memsize-to-string"/>
<function name="GIMP_TYPE_MEMSIZE" link="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS"/>
<function name="GIMP_TYPE_PARAM_MEMSIZE" link="libgimpbase-gimpmemsize.html#GIMP-TYPE-PARAM-MEMSIZE:CAPS"/>
<function name="GIMP_IS_PARAM_SPEC_MEMSIZE()" link="libgimpbase-gimpmemsize.html#GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS"/>
<function name="gimp_param_spec_memsize ()" link="libgimpbase-gimpmemsize.html#gimp-param-spec-memsize"/>
<function name="GIMP_VALUE_HOLDS_MEMSIZE()" link="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS"/>
<function name="GimpParasite" link="libgimpbase-gimpparasite.html#GimpParasite"/>
<function name="gimp_parasite_new ()" link="libgimpbase-gimpparasite.html#gimp-parasite-new"/>
@ -116,12 +139,16 @@
<function name="gimp_unit_get_singular ()" link="libgimpbase-gimpunit.html#gimp-unit-get-singular"/>
<function name="gimp_unit_get_plural ()" link="libgimpbase-gimpunit.html#gimp-unit-get-plural"/>
<function name="GIMP_TYPE_UNIT" link="libgimpbase-gimpunit.html#GIMP-TYPE-UNIT:CAPS"/>
<function name="GIMP_TYPE_PARAM_UNIT" link="libgimpbase-gimpunit.html#GIMP-TYPE-PARAM-UNIT:CAPS"/>
<function name="GIMP_IS_PARAM_SPEC_UNIT()" link="libgimpbase-gimpunit.html#GIMP-IS-PARAM-SPEC-UNIT:CAPS"/>
<function name="gimp_param_spec_unit ()" link="libgimpbase-gimpunit.html#gimp-param-spec-unit"/>
<function name="GIMP_VALUE_HOLDS_UNIT()" link="libgimpbase-gimpunit.html#GIMP-VALUE-HOLDS-UNIT:CAPS"/>
<function name="gimp_any_to_utf8 ()" link="libgimpbase-gimputils.html#gimp-any-to-utf8"/>
<function name="gimp_filename_to_utf8 ()" link="libgimpbase-gimputils.html#gimp-filename-to-utf8"/>
<function name="gimp_utf8_strtrim ()" link="libgimpbase-gimputils.html#gimp-utf8-strtrim"/>
<function name="gimp_escape_uline ()" link="libgimpbase-gimputils.html#gimp-escape-uline"/>
<function name="gimp_strip_uline ()" link="libgimpbase-gimputils.html#gimp-strip-uline"/>
<function name="gimp_canonicalize_identifier ()" link="libgimpbase-gimputils.html#gimp-canonicalize-identifier"/>
<function name="gimp_enum_get_desc ()" link="libgimpbase-gimputils.html#gimp-enum-get-desc"/>
<function name="gimp_enum_get_value ()" link="libgimpbase-gimputils.html#gimp-enum-get-value"/>
<function name="gimp_enum_value_get_desc ()" link="libgimpbase-gimputils.html#gimp-enum-value-get-desc"/>
@ -130,58 +157,5 @@
<function name="gimp_flags_get_first_value ()" link="libgimpbase-gimputils.html#gimp-flags-get-first-value"/>
<function name="gimp_flags_value_get_desc ()" link="libgimpbase-gimputils.html#gimp-flags-value-get-desc"/>
<function name="gimp_flags_value_get_help ()" link="libgimpbase-gimputils.html#gimp-flags-value-get-help"/>
<function name="GIMP_PROTOCOL_VERSION" link="libgimpbase-gimpprotocol.html#GIMP-PROTOCOL-VERSION:CAPS"/>
<function name="GPConfig" link="libgimpbase-gimpprotocol.html#GPConfig"/>
<function name="GPTileReq" link="libgimpbase-gimpprotocol.html#GPTileReq"/>
<function name="GPTileAck" link="libgimpbase-gimpprotocol.html#GPTileAck"/>
<function name="GPTileData" link="libgimpbase-gimpprotocol.html#GPTileData"/>
<function name="GPParam" link="libgimpbase-gimpprotocol.html#GPParam"/>
<function name="GPParamDef" link="libgimpbase-gimpprotocol.html#GPParamDef"/>
<function name="GPProcRun" link="libgimpbase-gimpprotocol.html#GPProcRun"/>
<function name="GPProcReturn" link="libgimpbase-gimpprotocol.html#GPProcReturn"/>
<function name="GPProcInstall" link="libgimpbase-gimpprotocol.html#GPProcInstall"/>
<function name="GPProcUninstall" link="libgimpbase-gimpprotocol.html#GPProcUninstall"/>
<function name="gp_init ()" link="libgimpbase-gimpprotocol.html#gp-init"/>
<function name="gp_has_init_write ()" link="libgimpbase-gimpprotocol.html#gp-has-init-write"/>
<function name="gp_quit_write ()" link="libgimpbase-gimpprotocol.html#gp-quit-write"/>
<function name="gp_config_write ()" link="libgimpbase-gimpprotocol.html#gp-config-write"/>
<function name="gp_tile_req_write ()" link="libgimpbase-gimpprotocol.html#gp-tile-req-write"/>
<function name="gp_tile_ack_write ()" link="libgimpbase-gimpprotocol.html#gp-tile-ack-write"/>
<function name="gp_tile_data_write ()" link="libgimpbase-gimpprotocol.html#gp-tile-data-write"/>
<function name="gp_proc_run_write ()" link="libgimpbase-gimpprotocol.html#gp-proc-run-write"/>
<function name="gp_proc_return_write ()" link="libgimpbase-gimpprotocol.html#gp-proc-return-write"/>
<function name="gp_temp_proc_run_write ()" link="libgimpbase-gimpprotocol.html#gp-temp-proc-run-write"/>
<function name="gp_temp_proc_return_write ()" link="libgimpbase-gimpprotocol.html#gp-temp-proc-return-write"/>
<function name="gp_proc_install_write ()" link="libgimpbase-gimpprotocol.html#gp-proc-install-write"/>
<function name="gp_proc_uninstall_write ()" link="libgimpbase-gimpprotocol.html#gp-proc-uninstall-write"/>
<function name="gp_extension_ack_write ()" link="libgimpbase-gimpprotocol.html#gp-extension-ack-write"/>
<function name="WireMessage" link="libgimpbase-gimpwire.html#WireMessage"/>
<function name="WireReadFunc ()" link="libgimpbase-gimpwire.html#WireReadFunc"/>
<function name="WireWriteFunc ()" link="libgimpbase-gimpwire.html#WireWriteFunc"/>
<function name="WireDestroyFunc ()" link="libgimpbase-gimpwire.html#WireDestroyFunc"/>
<function name="WireIOFunc ()" link="libgimpbase-gimpwire.html#WireIOFunc"/>
<function name="WireFlushFunc ()" link="libgimpbase-gimpwire.html#WireFlushFunc"/>
<function name="wire_register ()" link="libgimpbase-gimpwire.html#wire-register"/>
<function name="wire_set_reader ()" link="libgimpbase-gimpwire.html#wire-set-reader"/>
<function name="wire_set_writer ()" link="libgimpbase-gimpwire.html#wire-set-writer"/>
<function name="wire_set_flusher ()" link="libgimpbase-gimpwire.html#wire-set-flusher"/>
<function name="wire_read ()" link="libgimpbase-gimpwire.html#wire-read"/>
<function name="wire_write ()" link="libgimpbase-gimpwire.html#wire-write"/>
<function name="wire_flush ()" link="libgimpbase-gimpwire.html#wire-flush"/>
<function name="wire_error ()" link="libgimpbase-gimpwire.html#wire-error"/>
<function name="wire_clear_error ()" link="libgimpbase-gimpwire.html#wire-clear-error"/>
<function name="wire_read_msg ()" link="libgimpbase-gimpwire.html#wire-read-msg"/>
<function name="wire_write_msg ()" link="libgimpbase-gimpwire.html#wire-write-msg"/>
<function name="wire_destroy ()" link="libgimpbase-gimpwire.html#wire-destroy"/>
<function name="wire_read_int32 ()" link="libgimpbase-gimpwire.html#wire-read-int32"/>
<function name="wire_read_int16 ()" link="libgimpbase-gimpwire.html#wire-read-int16"/>
<function name="wire_read_int8 ()" link="libgimpbase-gimpwire.html#wire-read-int8"/>
<function name="wire_read_double ()" link="libgimpbase-gimpwire.html#wire-read-double"/>
<function name="wire_read_string ()" link="libgimpbase-gimpwire.html#wire-read-string"/>
<function name="wire_write_int32 ()" link="libgimpbase-gimpwire.html#wire-write-int32"/>
<function name="wire_write_int16 ()" link="libgimpbase-gimpwire.html#wire-write-int16"/>
<function name="wire_write_int8 ()" link="libgimpbase-gimpwire.html#wire-write-int8"/>
<function name="wire_write_double ()" link="libgimpbase-gimpwire.html#wire-write-double"/>
<function name="wire_write_string ()" link="libgimpbase-gimpwire.html#wire-write-string"/>
</functions>
</book>

187
devel-docs/libgimpbase/html/libgimpbase.devhelp2
View File

@ -1,187 +0,0 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "">
<book xmlns="http://www.devhelp.net/book" title="GIMP Base Library Reference Manual" link="index.html" author="" name="libgimpbase" version="2">
<chapters>
<sub name="GIMP Base Library" link="libgimpbase.html">
<sub name="gimpbaseenums" link="libgimpbase-gimpbaseenums.html"/>
<sub name="gimpbasetypes" link="libgimpbase-gimpbasetypes.html"/>
<sub name="gimpversion" link="libgimpbase-gimpversion.html"/>
<sub name="gimplimits" link="libgimpbase-gimplimits.html"/>
<sub name="gimpchecks" link="libgimpbase-gimpchecks.html"/>
<sub name="gimpdatafiles" link="libgimpbase-gimpdatafiles.html"/>
<sub name="gimpenv" link="libgimpbase-gimpenv.html"/>
<sub name="gimpmemsize" link="libgimpbase-gimpmemsize.html"/>
<sub name="gimpparasite" link="libgimpbase-gimpparasite.html"/>
<sub name="gimpparasiteio" link="libgimpbase-gimpparasiteio.html"/>
<sub name="gimpsignal" link="libgimpbase-gimpsignal.html"/>
<sub name="gimpunit" link="libgimpbase-gimpunit.html"/>
<sub name="gimputils" link="libgimpbase-gimputils.html"/>
<sub name="gimpprotocol" link="libgimpbase-gimpprotocol.html"/>
<sub name="gimpwire" link="libgimpbase-gimpwire.html"/>
</sub>
</chapters>
<functions>
<keyword type="enum" name="enum GimpCheckSize" link="libgimpbase-gimpbaseenums.html#GimpCheckSize"/>
<keyword type="enum" name="enum GimpCheckType" link="libgimpbase-gimpbaseenums.html#GimpCheckType"/>
<keyword type="enum" name="enum GimpImageBaseType" link="libgimpbase-gimpbaseenums.html#GimpImageBaseType"/>
<keyword type="enum" name="enum GimpImageType" link="libgimpbase-gimpbaseenums.html#GimpImageType"/>
<keyword type="enum" name="enum GimpMessageHandlerType" link="libgimpbase-gimpbaseenums.html#GimpMessageHandlerType"/>
<keyword type="enum" name="enum GimpPDBArgType" link="libgimpbase-gimpbaseenums.html#GimpPDBArgType"/>
<keyword type="enum" name="enum GimpPDBProcType" link="libgimpbase-gimpbaseenums.html#GimpPDBProcType"/>
<keyword type="enum" name="enum GimpPDBStatusType" link="libgimpbase-gimpbaseenums.html#GimpPDBStatusType"/>
<keyword type="enum" name="enum GimpProgressCommand" link="libgimpbase-gimpbaseenums.html#GimpProgressCommand"/>
<keyword type="enum" name="enum GimpStackTraceMode" link="libgimpbase-gimpbaseenums.html#GimpStackTraceMode"/>
<keyword type="struct" name="GimpEnumDesc" link="libgimpbase-gimpbasetypes.html#GimpEnumDesc"/>
<keyword type="struct" name="GimpFlagsDesc" link="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"/>
<keyword type="function" name="gimp_type_set_translation_domain ()" link="libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain" since="GIMP 2.2"/>
<keyword type="function" name="gimp_type_get_translation_domain ()" link="libgimpbase-gimpbasetypes.html#gimp-type-get-translation-domain" since="GIMP 2.2"/>
<keyword type="function" name="gimp_enum_set_value_descriptions ()" link="libgimpbase-gimpbasetypes.html#gimp-enum-set-value-descriptions" since="GIMP 2.2"/>
<keyword type="function" name="gimp_enum_get_value_descriptions ()" link="libgimpbase-gimpbasetypes.html#gimp-enum-get-value-descriptions" since="GIMP 2.2"/>
<keyword type="function" name="gimp_flags_get_value_descriptions ()" link="libgimpbase-gimpbasetypes.html#gimp-flags-get-value-descriptions" since="GIMP 2.2"/>
<keyword type="function" name="gimp_flags_set_value_descriptions ()" link="libgimpbase-gimpbasetypes.html#gimp-flags-set-value-descriptions" since="GIMP 2.2"/>
<keyword type="macro" name="GIMP_MAJOR_VERSION" link="libgimpbase-gimpversion.html#GIMP-MAJOR-VERSION:CAPS"/>
<keyword type="macro" name="GIMP_MINOR_VERSION" link="libgimpbase-gimpversion.html#GIMP-MINOR-VERSION:CAPS"/>
<keyword type="macro" name="GIMP_MICRO_VERSION" link="libgimpbase-gimpversion.html#GIMP-MICRO-VERSION:CAPS"/>
<keyword type="macro" name="GIMP_VERSION" link="libgimpbase-gimpversion.html#GIMP-VERSION:CAPS"/>
<keyword type="macro" name="GIMP_API_VERSION" link="libgimpbase-gimpversion.html#GIMP-API-VERSION:CAPS"/>
<keyword type="macro" name="GIMP_CHECK_VERSION()" link="libgimpbase-gimpversion.html#GIMP-CHECK-VERSION:CAPS"/>
<keyword type="macro" name="GIMP_MIN_IMAGE_SIZE" link="libgimpbase-gimplimits.html#GIMP-MIN-IMAGE-SIZE:CAPS"/>
<keyword type="macro" name="GIMP_MAX_IMAGE_SIZE" link="libgimpbase-gimplimits.html#GIMP-MAX-IMAGE-SIZE:CAPS"/>
<keyword type="macro" name="GIMP_MIN_RESOLUTION" link="libgimpbase-gimplimits.html#GIMP-MIN-RESOLUTION:CAPS"/>
<keyword type="macro" name="GIMP_MAX_RESOLUTION" link="libgimpbase-gimplimits.html#GIMP-MAX-RESOLUTION:CAPS"/>
<keyword type="macro" name="GIMP_MAX_MEMSIZE" link="libgimpbase-gimplimits.html#GIMP-MAX-MEMSIZE:CAPS"/>
<keyword type="macro" name="GIMP_CHECK_SIZE" link="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE:CAPS"/>
<keyword type="macro" name="GIMP_CHECK_SIZE_SM" link="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE-SM:CAPS"/>
<keyword type="macro" name="GIMP_CHECK_DARK" link="libgimpbase-gimpchecks.html#GIMP-CHECK-DARK:CAPS"/>
<keyword type="macro" name="GIMP_CHECK_LIGHT" link="libgimpbase-gimpchecks.html#GIMP-CHECK-LIGHT:CAPS"/>
<keyword type="function" name="gimp_checks_get_shades ()" link="libgimpbase-gimpchecks.html#gimp-checks-get-shades" since="GIMP 2.2"/>
<keyword type="struct" name="GimpDatafileData" link="libgimpbase-gimpdatafiles.html#GimpDatafileData"/>
<keyword type="function" name="GimpDatafileLoaderFunc ()" link="libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc"/>
<keyword type="function" name="gimp_datafiles_check_extension ()" link="libgimpbase-gimpdatafiles.html#gimp-datafiles-check-extension"/>
<keyword type="function" name="gimp_datafiles_read_directories ()" link="libgimpbase-gimpdatafiles.html#gimp-datafiles-read-directories"/>
<keyword type="function" name="gimp_directory ()" link="libgimpbase-gimpenv.html#gimp-directory"/>
<keyword type="function" name="gimp_personal_rc_file ()" link="libgimpbase-gimpenv.html#gimp-personal-rc-file"/>
<keyword type="function" name="gimp_data_directory ()" link="libgimpbase-gimpenv.html#gimp-data-directory"/>
<keyword type="function" name="gimp_locale_directory ()" link="libgimpbase-gimpenv.html#gimp-locale-directory"/>
<keyword type="function" name="gimp_plug_in_directory ()" link="libgimpbase-gimpenv.html#gimp-plug-in-directory"/>
<keyword type="function" name="gimp_sysconf_directory ()" link="libgimpbase-gimpenv.html#gimp-sysconf-directory"/>
<keyword type="function" name="gimp_gtkrc ()" link="libgimpbase-gimpenv.html#gimp-gtkrc"/>
<keyword type="function" name="gimp_path_parse ()" link="libgimpbase-gimpenv.html#gimp-path-parse"/>
<keyword type="function" name="gimp_path_to_str ()" link="libgimpbase-gimpenv.html#gimp-path-to-str"/>
<keyword type="function" name="gimp_path_free ()" link="libgimpbase-gimpenv.html#gimp-path-free"/>
<keyword type="function" name="gimp_path_get_user_writable_dir ()" link="libgimpbase-gimpenv.html#gimp-path-get-user-writable-dir"/>
<keyword type="function" name="gimp_memsize_serialize ()" link="libgimpbase-gimpmemsize.html#gimp-memsize-serialize" since="GIMP 2.2"/>
<keyword type="function" name="gimp_memsize_deserialize ()" link="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize" since="GIMP 2.2"/>
<keyword type="function" name="gimp_memsize_to_string ()" link="libgimpbase-gimpmemsize.html#gimp-memsize-to-string"/>
<keyword type="macro" name="GIMP_TYPE_MEMSIZE" link="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS"/>
<keyword type="macro" name="GIMP_VALUE_HOLDS_MEMSIZE()" link="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS"/>
<keyword type="struct" name="GimpParasite" link="libgimpbase-gimpparasite.html#GimpParasite"/>
<keyword type="function" name="gimp_parasite_new ()" link="libgimpbase-gimpparasite.html#gimp-parasite-new"/>
<keyword type="function" name="gimp_parasite_free ()" link="libgimpbase-gimpparasite.html#gimp-parasite-free"/>
<keyword type="function" name="gimp_parasite_copy ()" link="libgimpbase-gimpparasite.html#gimp-parasite-copy"/>
<keyword type="function" name="gimp_parasite_compare ()" link="libgimpbase-gimpparasite.html#gimp-parasite-compare"/>
<keyword type="function" name="gimp_parasite_is_type ()" link="libgimpbase-gimpparasite.html#gimp-parasite-is-type"/>
<keyword type="function" name="gimp_parasite_is_persistent ()" link="libgimpbase-gimpparasite.html#gimp-parasite-is-persistent"/>
<keyword type="function" name="gimp_parasite_is_undoable ()" link="libgimpbase-gimpparasite.html#gimp-parasite-is-undoable"/>
<keyword type="function" name="gimp_parasite_has_flag ()" link="libgimpbase-gimpparasite.html#gimp-parasite-has-flag"/>
<keyword type="function" name="gimp_parasite_flags ()" link="libgimpbase-gimpparasite.html#gimp-parasite-flags"/>
<keyword type="function" name="gimp_parasite_name ()" link="libgimpbase-gimpparasite.html#gimp-parasite-name"/>
<keyword type="function" name="gimp_parasite_data ()" link="libgimpbase-gimpparasite.html#gimp-parasite-data"/>
<keyword type="function" name="gimp_parasite_data_size ()" link="libgimpbase-gimpparasite.html#gimp-parasite-data-size"/>
<keyword type="macro" name="GIMP_PARASITE_PERSISTENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-PERSISTENT:CAPS"/>
<keyword type="macro" name="GIMP_PARASITE_UNDOABLE" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-UNDOABLE:CAPS"/>
<keyword type="macro" name="GIMP_PARASITE_ATTACH_PARENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-PARENT:CAPS"/>
<keyword type="macro" name="GIMP_PARASITE_PARENT_PERSISTENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-PERSISTENT:CAPS"/>
<keyword type="macro" name="GIMP_PARASITE_PARENT_UNDOABLE" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-UNDOABLE:CAPS"/>
<keyword type="macro" name="GIMP_PARASITE_ATTACH_GRANDPARENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS"/>
<keyword type="macro" name="GIMP_PARASITE_GRANDPARENT_PERSISTENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS"/>
<keyword type="macro" name="GIMP_PARASITE_GRANDPARENT_UNDOABLE" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS"/>
<keyword type="macro" name="GIMP_PIXPIPE_MAXDIM" link="libgimpbase-gimpparasiteio.html#GIMP-PIXPIPE-MAXDIM:CAPS"/>
<keyword type="function" name="gimp_pixpipe_params_init ()" link="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-init"/>
<keyword type="function" name="gimp_pixpipe_params_parse ()" link="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-parse"/>
<keyword type="function" name="gimp_pixpipe_params_build ()" link="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-build"/>
<keyword type="function" name="GimpSignalHandlerFunc ()" link="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc"/>
<keyword type="function" name="gimp_signal_private ()" link="libgimpbase-gimpsignal.html#gimp-signal-private"/>
<keyword type="enum" name="enum GimpUnit" link="libgimpbase-gimpunit.html#GimpUnit"/>
<keyword type="function" name="gimp_unit_get_number_of_units ()" link="libgimpbase-gimpunit.html#gimp-unit-get-number-of-units"/>
<keyword type="function" name="gimp_unit_get_number_of_built_in_units ()" link="libgimpbase-gimpunit.html#gimp-unit-get-number-of-built-in-units"/>
<keyword type="function" name="gimp_unit_new ()" link="libgimpbase-gimpunit.html#gimp-unit-new"/>
<keyword type="function" name="gimp_unit_get_deletion_flag ()" link="libgimpbase-gimpunit.html#gimp-unit-get-deletion-flag"/>
<keyword type="function" name="gimp_unit_set_deletion_flag ()" link="libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag"/>
<keyword type="function" name="gimp_unit_get_factor ()" link="libgimpbase-gimpunit.html#gimp-unit-get-factor"/>
<keyword type="function" name="gimp_unit_get_digits ()" link="libgimpbase-gimpunit.html#gimp-unit-get-digits"/>
<keyword type="function" name="gimp_unit_get_identifier ()" link="libgimpbase-gimpunit.html#gimp-unit-get-identifier"/>
<keyword type="function" name="gimp_unit_get_symbol ()" link="libgimpbase-gimpunit.html#gimp-unit-get-symbol"/>
<keyword type="function" name="gimp_unit_get_abbreviation ()" link="libgimpbase-gimpunit.html#gimp-unit-get-abbreviation"/>
<keyword type="function" name="gimp_unit_get_singular ()" link="libgimpbase-gimpunit.html#gimp-unit-get-singular"/>
<keyword type="function" name="gimp_unit_get_plural ()" link="libgimpbase-gimpunit.html#gimp-unit-get-plural"/>
<keyword type="macro" name="GIMP_TYPE_UNIT" link="libgimpbase-gimpunit.html#GIMP-TYPE-UNIT:CAPS"/>
<keyword type="macro" name="GIMP_VALUE_HOLDS_UNIT()" link="libgimpbase-gimpunit.html#GIMP-VALUE-HOLDS-UNIT:CAPS"/>
<keyword type="function" name="gimp_any_to_utf8 ()" link="libgimpbase-gimputils.html#gimp-any-to-utf8"/>
<keyword type="function" name="gimp_filename_to_utf8 ()" link="libgimpbase-gimputils.html#gimp-filename-to-utf8"/>
<keyword type="function" name="gimp_utf8_strtrim ()" link="libgimpbase-gimputils.html#gimp-utf8-strtrim"/>
<keyword type="function" name="gimp_escape_uline ()" link="libgimpbase-gimputils.html#gimp-escape-uline" since="GIMP 2.2"/>
<keyword type="function" name="gimp_strip_uline ()" link="libgimpbase-gimputils.html#gimp-strip-uline"/>
<keyword type="function" name="gimp_enum_get_desc ()" link="libgimpbase-gimputils.html#gimp-enum-get-desc" since="GIMP 2.2"/>
<keyword type="function" name="gimp_enum_get_value ()" link="libgimpbase-gimputils.html#gimp-enum-get-value" since="GIMP 2.2"/>
<keyword type="function" name="gimp_enum_value_get_desc ()" link="libgimpbase-gimputils.html#gimp-enum-value-get-desc" since="GIMP 2.2"/>
<keyword type="function" name="gimp_enum_value_get_help ()" link="libgimpbase-gimputils.html#gimp-enum-value-get-help" since="GIMP 2.2"/>
<keyword type="function" name="gimp_flags_get_first_desc ()" link="libgimpbase-gimputils.html#gimp-flags-get-first-desc" since="GIMP 2.2"/>
<keyword type="function" name="gimp_flags_get_first_value ()" link="libgimpbase-gimputils.html#gimp-flags-get-first-value" since="GIMP 2.2"/>
<keyword type="function" name="gimp_flags_value_get_desc ()" link="libgimpbase-gimputils.html#gimp-flags-value-get-desc" since="GIMP 2.2"/>
<keyword type="function" name="gimp_flags_value_get_help ()" link="libgimpbase-gimputils.html#gimp-flags-value-get-help" since="GIMP 2.2"/>
<keyword type="macro" name="GIMP_PROTOCOL_VERSION" link="libgimpbase-gimpprotocol.html#GIMP-PROTOCOL-VERSION:CAPS"/>
<keyword type="struct" name="GPConfig" link="libgimpbase-gimpprotocol.html#GPConfig"/>
<keyword type="struct" name="GPTileReq" link="libgimpbase-gimpprotocol.html#GPTileReq"/>
<keyword type="struct" name="GPTileAck" link="libgimpbase-gimpprotocol.html#GPTileAck"/>
<keyword type="struct" name="GPTileData" link="libgimpbase-gimpprotocol.html#GPTileData"/>
<keyword type="struct" name="GPParam" link="libgimpbase-gimpprotocol.html#GPParam"/>
<keyword type="struct" name="GPParamDef" link="libgimpbase-gimpprotocol.html#GPParamDef"/>
<keyword type="struct" name="GPProcRun" link="libgimpbase-gimpprotocol.html#GPProcRun"/>
<keyword type="struct" name="GPProcReturn" link="libgimpbase-gimpprotocol.html#GPProcReturn"/>
<keyword type="struct" name="GPProcInstall" link="libgimpbase-gimpprotocol.html#GPProcInstall"/>
<keyword type="struct" name="GPProcUninstall" link="libgimpbase-gimpprotocol.html#GPProcUninstall"/>
<keyword type="function" name="gp_init ()" link="libgimpbase-gimpprotocol.html#gp-init"/>
<keyword type="function" name="gp_has_init_write ()" link="libgimpbase-gimpprotocol.html#gp-has-init-write"/>
<keyword type="function" name="gp_quit_write ()" link="libgimpbase-gimpprotocol.html#gp-quit-write"/>
<keyword type="function" name="gp_config_write ()" link="libgimpbase-gimpprotocol.html#gp-config-write"/>
<keyword type="function" name="gp_tile_req_write ()" link="libgimpbase-gimpprotocol.html#gp-tile-req-write"/>
<keyword type="function" name="gp_tile_ack_write ()" link="libgimpbase-gimpprotocol.html#gp-tile-ack-write"/>
<keyword type="function" name="gp_tile_data_write ()" link="libgimpbase-gimpprotocol.html#gp-tile-data-write"/>
<keyword type="function" name="gp_proc_run_write ()" link="libgimpbase-gimpprotocol.html#gp-proc-run-write"/>
<keyword type="function" name="gp_proc_return_write ()" link="libgimpbase-gimpprotocol.html#gp-proc-return-write"/>
<keyword type="function" name="gp_temp_proc_run_write ()" link="libgimpbase-gimpprotocol.html#gp-temp-proc-run-write"/>
<keyword type="function" name="gp_temp_proc_return_write ()" link="libgimpbase-gimpprotocol.html#gp-temp-proc-return-write"/>
<keyword type="function" name="gp_proc_install_write ()" link="libgimpbase-gimpprotocol.html#gp-proc-install-write"/>
<keyword type="function" name="gp_proc_uninstall_write ()" link="libgimpbase-gimpprotocol.html#gp-proc-uninstall-write"/>
<keyword type="function" name="gp_extension_ack_write ()" link="libgimpbase-gimpprotocol.html#gp-extension-ack-write"/>
<keyword type="struct" name="WireMessage" link="libgimpbase-gimpwire.html#WireMessage"/>
<keyword type="function" name="WireReadFunc ()" link="libgimpbase-gimpwire.html#WireReadFunc"/>
<keyword type="function" name="WireWriteFunc ()" link="libgimpbase-gimpwire.html#WireWriteFunc"/>
<keyword type="function" name="WireDestroyFunc ()" link="libgimpbase-gimpwire.html#WireDestroyFunc"/>
<keyword type="function" name="WireIOFunc ()" link="libgimpbase-gimpwire.html#WireIOFunc"/>
<keyword type="function" name="WireFlushFunc ()" link="libgimpbase-gimpwire.html#WireFlushFunc"/>
<keyword type="function" name="wire_register ()" link="libgimpbase-gimpwire.html#wire-register"/>
<keyword type="function" name="wire_set_reader ()" link="libgimpbase-gimpwire.html#wire-set-reader"/>
<keyword type="function" name="wire_set_writer ()" link="libgimpbase-gimpwire.html#wire-set-writer"/>
<keyword type="function" name="wire_set_flusher ()" link="libgimpbase-gimpwire.html#wire-set-flusher"/>
<keyword type="function" name="wire_read ()" link="libgimpbase-gimpwire.html#wire-read"/>
<keyword type="function" name="wire_write ()" link="libgimpbase-gimpwire.html#wire-write"/>
<keyword type="function" name="wire_flush ()" link="libgimpbase-gimpwire.html#wire-flush"/>
<keyword type="function" name="wire_error ()" link="libgimpbase-gimpwire.html#wire-error"/>
<keyword type="function" name="wire_clear_error ()" link="libgimpbase-gimpwire.html#wire-clear-error"/>
<keyword type="function" name="wire_read_msg ()" link="libgimpbase-gimpwire.html#wire-read-msg"/>
<keyword type="function" name="wire_write_msg ()" link="libgimpbase-gimpwire.html#wire-write-msg"/>
<keyword type="function" name="wire_destroy ()" link="libgimpbase-gimpwire.html#wire-destroy"/>
<keyword type="function" name="wire_read_int32 ()" link="libgimpbase-gimpwire.html#wire-read-int32"/>
<keyword type="function" name="wire_read_int16 ()" link="libgimpbase-gimpwire.html#wire-read-int16"/>
<keyword type="function" name="wire_read_int8 ()" link="libgimpbase-gimpwire.html#wire-read-int8"/>
<keyword type="function" name="wire_read_double ()" link="libgimpbase-gimpwire.html#wire-read-double"/>
<keyword type="function" name="wire_read_string ()" link="libgimpbase-gimpwire.html#wire-read-string"/>
<keyword type="function" name="wire_write_int32 ()" link="libgimpbase-gimpwire.html#wire-write-int32"/>
<keyword type="function" name="wire_write_int16 ()" link="libgimpbase-gimpwire.html#wire-write-int16"/>
<keyword type="function" name="wire_write_int8 ()" link="libgimpbase-gimpwire.html#wire-write-int8"/>
<keyword type="function" name="wire_write_double ()" link="libgimpbase-gimpwire.html#wire-write-double"/>
<keyword type="function" name="wire_write_string ()" link="libgimpbase-gimpwire.html#wire-write-string"/>
</functions>
</book>

18
devel-docs/libgimpbase/html/libgimpbase.html
View File

@ -1,26 +1,32 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Part&#160;I.&#160;GIMP Base Library</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="prev" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="next" href="libgimpbase-gimpbaseenums.html" title="gimpbaseenums">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td>&#160;</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpbaseenums.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="part" lang="en"><div class="titlepage"><div><div><h1 class="title">
<a name="libgimpbase"></a>Part&#160;I.&#160;GIMP Base Library</h1></div></div></div></div>
<a name="libgimpbase"></a>GIMP Base Library</h1></div></div></div></div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="index.html"><b>&lt;&lt;&#160;GIMP Base Library Reference Manual</b></a></td>
<td align="right"><a accesskey="n" href="libgimpbase-gimpbaseenums.html"><b>gimpbaseenums&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>

52
devel-docs/libgimpbase/html/style.css
View File

@ -19,23 +19,12 @@
{
vertical-align: top;
}
/* this is needed so that the local anchors are displayed below the naviagtion */
div.refnamediv a[name], div.refsect1 a[name]
{
position: relative;
top: -4.5em;
}
table.navigation#top
table.navigation
{
background: #ffeeee;
border: solid 1px #ffaaaa;
margin-top: 0;
margin-bottom: 0;
position: fixed;
top: 0;
left: 0;
height: 2em;
z-index: 1;
margin-top: 0.5em;
margin-bottom: 0.5em;
}
.navigation a
{
@ -49,18 +38,6 @@ table.navigation#top
{
font-size: 200%;
}
td.shortcuts
{
color: #770000;
font-size: 80%;
}
div.refentry, div.chapter, div.part, div.book, div.index, div.glossary, div.sect1, div.appendix, div.preface
{
position: relative;
top: 3em;
z-index: 0;
}
div.refnamediv
{
margin-top: 2em;
@ -87,26 +64,3 @@ a:hover
text-decoration: underline;
color: #FF0000;
}
div.table table
{
border-collapse: collapse;
border-spacing: 0px;
border-style: solid;
border-color: #777777;
border-width: 1px;
}
div.table table td, div.table table th
{
border-style: solid;
border-color: #777777;
border-width: 1px;
padding: 3px;
vertical-align: top;
}
div.table table th
{
background-color: #eeeeee;
}

15
devel-docs/libgimpbase/libgimpbase-docs.sgml
View File

@ -26,8 +26,19 @@
<xi:include href="xml/gimpsignal.xml" />
<xi:include href="xml/gimpunit.xml" />
<xi:include href="xml/gimputils.xml" />
<xi:include href="xml/gimpprotocol.xml" />
<xi:include href="xml/gimpwire.xml" />
</part>
<index>
<title>Index</title>
</index>
<index role="GIMP 2.2">
<title>Index of new symbols in GIMP 2.2</title>
</index>
<index role="GIMP 2.4">
<title>Index of new symbols in GIMP 2.4</title>
</index>
<index role="deprecated">
<title>Index of deprecated symbols</title>
</index>
</book>

125
devel-docs/libgimpbase/libgimpbase-sections.txt
View File

@ -12,37 +12,91 @@ gimp_flags_set_value_descriptions
<SECTION>
<FILE>gimpbaseenums</FILE>
GimpAddMaskType
GimpBlendMode
GimpBucketFillMode
GimpChannelOps
GimpChannelType
GimpCheckSize
GimpCheckType
GimpCloneType
GimpDesaturateMode
GimpDodgeBurnType
GimpForegroundExtractMode
GimpGradientType
GimpGridStyle
GimpIconType
GimpImageBaseType
GimpImageType
GimpInterpolationType
GimpMessageHandlerType
GimpPaintApplicationMode
GimpPDBArgType
GimpPDBProcType
GimpPDBStatusType
GimpProgressCommand
GimpRepeatMode
GimpSizeType
GimpStackTraceMode
GimpTransferMode
GimpTransformDirection
<SUBSECTION Standard>
GIMP_TYPE_ADD_MASK_TYPE
GIMP_TYPE_BLEND_MODE
GIMP_TYPE_BUCKET_FILL_MODE
GIMP_TYPE_CHANNEL_OPS
GIMP_TYPE_CHANNEL_TYPE
GIMP_TYPE_CHECK_SIZE
GIMP_TYPE_CHECK_TYPE
GIMP_TYPE_CLONE_TYPE
GIMP_TYPE_DESATURATE_MODE
GIMP_TYPE_DODGE_BURN_TYPE
GIMP_TYPE_FOREGROUND_EXTRACT_MODE
GIMP_TYPE_GRADIENT_TYPE
GIMP_TYPE_GRID_STYLE
GIMP_TYPE_ICON_TYPE
GIMP_TYPE_IMAGE_BASE_TYPE
GIMP_TYPE_IMAGE_TYPE
GIMP_TYPE_INTERPOLATION_TYPE
GIMP_TYPE_MESSAGE_HANDLER_TYPE
GIMP_TYPE_PAINT_APPLICATION_MODE
GIMP_TYPE_PDB_ARG_TYPE
GIMP_TYPE_PDB_PROC_TYPE
GIMP_TYPE_PDB_STATUS_TYPE
GIMP_TYPE_PROGRESS_COMMAND
GIMP_TYPE_REPEAT_MODE
GIMP_TYPE_SIZE_TYPE
GIMP_TYPE_STACK_TRACE_MODE
GIMP_TYPE_TRANSFER_MODE
GIMP_TYPE_TRANSFORM_DIRECTION
gimp_add_mask_type_get_type
gimp_blend_mode_get_type
gimp_bucket_fill_mode_get_type
gimp_channel_ops_get_type
gimp_channel_type_get_type
gimp_check_size_get_type
gimp_check_type_get_type
gimp_clone_type_get_type
gimp_desaturate_mode_get_type
gimp_dodge_burn_type_get_type
gimp_foreground_extract_mode_get_type
gimp_gradient_type_get_type
gimp_grid_style_get_type
gimp_icon_type_get_type
gimp_image_base_type_get_type
gimp_image_type_get_type
gimp_interpolation_type_get_type
gimp_message_handler_type_get_type
gimp_paint_application_mode_get_type
gimp_pdb_arg_type_get_type
gimp_pdb_proc_type_get_type
gimp_pdb_status_type_get_type
gimp_progress_command_get_type
gimp_repeat_mode_get_type
gimp_size_type_get_type
gimp_stack_trace_mode_get_type
gimp_transfer_mode_get_type
gimp_transform_direction_get_type
</SECTION>
<SECTION>
@ -56,6 +110,7 @@ gimp_checks_get_shades
<SECTION>
<FILE>gimpenv</FILE>
gimp_env_init
gimp_directory
gimp_personal_rc_file
gimp_data_directory
@ -84,9 +139,13 @@ gimp_memsize_serialize
gimp_memsize_deserialize
gimp_memsize_to_string
GIMP_TYPE_MEMSIZE
GIMP_TYPE_PARAM_MEMSIZE
GIMP_IS_PARAM_SPEC_MEMSIZE
gimp_param_spec_memsize
GIMP_VALUE_HOLDS_MEMSIZE
<SUBSECTION Standard>
gimp_memsize_get_type
gimp_param_memsize_get_type
</SECTION>
<SECTION>
@ -122,35 +181,6 @@ gimp_pixpipe_params_parse
gimp_pixpipe_params_build
</SECTION>
<SECTION>
<FILE>gimpprotocol</FILE>
GIMP_PROTOCOL_VERSION
GPConfig
GPTileReq
GPTileAck
GPTileData
GPParam
GPParamDef
GPProcRun
GPProcReturn
GPProcInstall
GPProcUninstall
gp_init
gp_has_init_write
gp_quit_write
gp_config_write
gp_tile_req_write
gp_tile_ack_write
gp_tile_data_write
gp_proc_run_write
gp_proc_return_write
gp_temp_proc_run_write
gp_temp_proc_return_write
gp_proc_install_write
gp_proc_uninstall_write
gp_extension_ack_write
</SECTION>
<SECTION>
<FILE>gimpsignal</FILE>
GimpSignalHandlerFunc
@ -173,9 +203,13 @@ gimp_unit_get_abbreviation
gimp_unit_get_singular
gimp_unit_get_plural
GIMP_TYPE_UNIT
GIMP_TYPE_PARAM_UNIT
GIMP_IS_PARAM_SPEC_UNIT
gimp_param_spec_unit
GIMP_VALUE_HOLDS_UNIT
<SUBSECTION Standard>
gimp_unit_get_type
gimp_param_unit_get_type
</SECTION>
<SECTION>
@ -185,6 +219,7 @@ gimp_filename_to_utf8
gimp_utf8_strtrim
gimp_escape_uline
gimp_strip_uline
gimp_canonicalize_identifier
gimp_enum_get_desc
gimp_enum_get_value
gimp_enum_value_get_desc
@ -195,38 +230,6 @@ gimp_flags_value_get_desc
gimp_flags_value_get_help
</SECTION>
<SECTION>
<FILE>gimpwire</FILE>
WireMessage
WireReadFunc
WireWriteFunc
WireDestroyFunc
WireIOFunc
WireFlushFunc
wire_register
wire_set_reader
wire_set_writer
wire_set_flusher
wire_read
wire_write
wire_flush
wire_error
wire_clear_error
wire_read_msg
wire_write_msg
wire_destroy
wire_read_int32
wire_read_int16
wire_read_int8
wire_read_double
wire_read_string
wire_write_int32
wire_write_int16
wire_write_int8
wire_write_double
wire_write_string
</SECTION>
<SECTION>
<FILE>gimpversion</FILE>
GIMP_MAJOR_VERSION

176
devel-docs/libgimpbase/tmpl/gimpbaseenums.sgml
View File

@ -17,6 +17,59 @@ Basic GIMP enumeration data types.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### ENUM GimpAddMaskType ##### -->
<para>
</para>
@GIMP_ADD_WHITE_MASK:
@GIMP_ADD_BLACK_MASK:
@GIMP_ADD_ALPHA_MASK:
@GIMP_ADD_ALPHA_TRANSFER_MASK:
@GIMP_ADD_SELECTION_MASK:
@GIMP_ADD_COPY_MASK:
<!-- ##### ENUM GimpBlendMode ##### -->
<para>
</para>
@GIMP_FG_BG_RGB_MODE:
@GIMP_FG_BG_HSV_MODE:
@GIMP_FG_TRANSPARENT_MODE:
@GIMP_CUSTOM_MODE:
<!-- ##### ENUM GimpBucketFillMode ##### -->
<para>
</para>
@GIMP_FG_BUCKET_FILL:
@GIMP_BG_BUCKET_FILL:
@GIMP_PATTERN_BUCKET_FILL:
<!-- ##### ENUM GimpChannelOps ##### -->
<para>
</para>
@GIMP_CHANNEL_OP_ADD:
@GIMP_CHANNEL_OP_SUBTRACT:
@GIMP_CHANNEL_OP_REPLACE:
@GIMP_CHANNEL_OP_INTERSECT:
<!-- ##### ENUM GimpChannelType ##### -->
<para>
</para>
@GIMP_RED_CHANNEL:
@GIMP_GREEN_CHANNEL:
@GIMP_BLUE_CHANNEL:
@GIMP_GRAY_CHANNEL:
@GIMP_INDEXED_CHANNEL:
@GIMP_ALPHA_CHANNEL:
<!-- ##### ENUM GimpCheckSize ##### -->
<para>
@ -38,6 +91,75 @@ Basic GIMP enumeration data types.
@GIMP_CHECK_TYPE_GRAY_ONLY:
@GIMP_CHECK_TYPE_BLACK_ONLY:
<!-- ##### ENUM GimpCloneType ##### -->
<para>
</para>
@GIMP_IMAGE_CLONE:
@GIMP_PATTERN_CLONE:
<!-- ##### ENUM GimpDesaturateMode ##### -->
<para>
</para>
@GIMP_DESATURATE_LIGHTNESS:
@GIMP_DESATURATE_LUMINOSITY:
@GIMP_DESATURATE_AVERAGE:
<!-- ##### ENUM GimpDodgeBurnType ##### -->
<para>
</para>
@GIMP_DODGE:
@GIMP_BURN:
<!-- ##### ENUM GimpForegroundExtractMode ##### -->
<para>
</para>
@GIMP_FOREGROUND_EXTRACT_SIOX:
<!-- ##### ENUM GimpGradientType ##### -->
<para>
</para>
@GIMP_GRADIENT_LINEAR:
@GIMP_GRADIENT_BILINEAR:
@GIMP_GRADIENT_RADIAL:
@GIMP_GRADIENT_SQUARE:
@GIMP_GRADIENT_CONICAL_SYMMETRIC:
@GIMP_GRADIENT_CONICAL_ASYMMETRIC:
@GIMP_GRADIENT_SHAPEBURST_ANGULAR:
@GIMP_GRADIENT_SHAPEBURST_SPHERICAL:
@GIMP_GRADIENT_SHAPEBURST_DIMPLED:
@GIMP_GRADIENT_SPIRAL_CLOCKWISE:
@GIMP_GRADIENT_SPIRAL_ANTICLOCKWISE:
<!-- ##### ENUM GimpGridStyle ##### -->
<para>
</para>
@GIMP_GRID_DOTS:
@GIMP_GRID_INTERSECTIONS:
@GIMP_GRID_ON_OFF_DASH:
@GIMP_GRID_DOUBLE_DASH:
@GIMP_GRID_SOLID:
<!-- ##### ENUM GimpIconType ##### -->
<para>
</para>
@GIMP_ICON_TYPE_STOCK_ID:
@GIMP_ICON_TYPE_INLINE_PIXBUF:
@GIMP_ICON_TYPE_IMAGE_FILE:
<!-- ##### ENUM GimpImageBaseType ##### -->
<para>
@ -59,6 +181,16 @@ Basic GIMP enumeration data types.
@GIMP_INDEXED_IMAGE:
@GIMP_INDEXEDA_IMAGE:
<!-- ##### ENUM GimpInterpolationType ##### -->
<para>
</para>
@GIMP_INTERPOLATION_NONE:
@GIMP_INTERPOLATION_LINEAR:
@GIMP_INTERPOLATION_CUBIC:
@GIMP_INTERPOLATION_LANCZOS:
<!-- ##### ENUM GimpMessageHandlerType ##### -->
<para>
@ -68,6 +200,14 @@ Basic GIMP enumeration data types.
@GIMP_CONSOLE:
@GIMP_ERROR_CONSOLE:
<!-- ##### ENUM GimpPaintApplicationMode ##### -->
<para>
</para>
@GIMP_PAINT_CONSTANT:
@GIMP_PAINT_INCREMENTAL:
<!-- ##### ENUM GimpPDBArgType ##### -->
<para>
@ -127,6 +267,25 @@ Basic GIMP enumeration data types.
@GIMP_PROGRESS_COMMAND_END:
@GIMP_PROGRESS_COMMAND_SET_TEXT:
@GIMP_PROGRESS_COMMAND_SET_VALUE:
@GIMP_PROGRESS_COMMAND_PULSE:
@GIMP_PROGRESS_COMMAND_GET_WINDOW:
<!-- ##### ENUM GimpRepeatMode ##### -->
<para>
</para>
@GIMP_REPEAT_NONE:
@GIMP_REPEAT_SAWTOOTH:
@GIMP_REPEAT_TRIANGULAR:
<!-- ##### ENUM GimpSizeType ##### -->
<para>
</para>
@GIMP_PIXELS:
@GIMP_POINTS:
<!-- ##### ENUM GimpStackTraceMode ##### -->
<para>
@ -137,3 +296,20 @@ Basic GIMP enumeration data types.
@GIMP_STACK_TRACE_QUERY:
@GIMP_STACK_TRACE_ALWAYS:
<!-- ##### ENUM GimpTransferMode ##### -->
<para>
</para>
@GIMP_SHADOWS:
@GIMP_MIDTONES:
@GIMP_HIGHLIGHTS:
<!-- ##### ENUM GimpTransformDirection ##### -->
<para>
</para>
@GIMP_TRANSFORM_FORWARD:
@GIMP_TRANSFORM_BACKWARD:

10
devel-docs/libgimpbase/tmpl/gimpenv.sgml
View File

@ -18,6 +18,16 @@ configuration files.
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION gimp_env_init ##### -->
<para>
</para>
@plug_in:
<!-- # Unused Parameters # -->
@library:
<!-- ##### FUNCTION gimp_directory ##### -->
<para>

30
devel-docs/libgimpbase/tmpl/gimpmemsize.sgml
View File

@ -52,6 +52,36 @@ Functions to (de)serialize a given memory size.
<!-- ##### MACRO GIMP_TYPE_PARAM_MEMSIZE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_IS_PARAM_SPEC_MEMSIZE ##### -->
<para>
</para>
@pspec:
<!-- ##### FUNCTION gimp_param_spec_memsize ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@minimum:
@maximum:
@default_value:
@flags:
@Returns:
<!-- ##### MACRO GIMP_VALUE_HOLDS_MEMSIZE ##### -->
<para>

297
devel-docs/libgimpbase/tmpl/gimpprotocol.sgml
View File

@ -1,297 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpprotocol
<!-- ##### SECTION Short_Description ##### -->
The communication protocol between GIMP and it's plug-ins.
<!-- ##### SECTION Long_Description ##### -->
<para>
The communication protocol between GIMP and it's plug-ins.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#libgimp-gimpwire
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO GIMP_PROTOCOL_VERSION ##### -->
<para>
</para>
<!-- ##### STRUCT GPConfig ##### -->
<para>
</para>
@version:
@tile_width:
@tile_height:
@shm_ID:
@check_size:
@check_type:
@show_help_button:
@gimp_reserved_4:
@gimp_reserved_5:
@gimp_reserved_6:
@gimp_reserved_7:
@gimp_reserved_8:
@install_cmap:
@show_tool_tips:
@min_colors:
@gdisp_ID:
@app_name:
@wm_class:
@display_name:
@monitor_number:
<!-- ##### STRUCT GPTileReq ##### -->
<para>
</para>
@drawable_ID:
@tile_num:
@shadow:
<!-- ##### STRUCT GPTileAck ##### -->
<para>
</para>
<!-- ##### STRUCT GPTileData ##### -->
<para>
</para>
@drawable_ID:
@tile_num:
@shadow:
@bpp:
@width:
@height:
@use_shm:
@data:
<!-- ##### STRUCT GPParam ##### -->
<para>
</para>
@type:
@d_display:
@d_image:
@d_layer:
@d_channel:
@d_drawable:
@d_selection:
@d_boundary:
@d_path:
@d_status:
<!-- ##### STRUCT GPParamDef ##### -->
<para>
</para>
@type:
@name:
@description:
<!-- ##### STRUCT GPProcRun ##### -->
<para>
</para>
@name:
@nparams:
@params:
<!-- ##### STRUCT GPProcReturn ##### -->
<para>
</para>
@name:
@nparams:
@params:
<!-- ##### STRUCT GPProcInstall ##### -->
<para>
</para>
@name:
@blurb:
@help:
@author:
@copyright:
@date:
@menu_path:
@image_types:
@type:
@nparams:
@nreturn_vals:
@params:
@return_vals:
<!-- ##### STRUCT GPProcUninstall ##### -->
<para>
</para>
@name:
<!-- ##### FUNCTION gp_init ##### -->
<para>
</para>
<!-- ##### FUNCTION gp_has_init_write ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_quit_write ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_config_write ##### -->
<para>
</para>
@channel:
@config:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_tile_req_write ##### -->
<para>
</para>
@channel:
@tile_req:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_tile_ack_write ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_tile_data_write ##### -->
<para>
</para>
@channel:
@tile_data:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_proc_run_write ##### -->
<para>
</para>
@channel:
@proc_run:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_proc_return_write ##### -->
<para>
</para>
@channel:
@proc_return:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_temp_proc_run_write ##### -->
<para>
</para>
@channel:
@proc_run:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_temp_proc_return_write ##### -->
<para>
</para>
@channel:
@proc_return:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_proc_install_write ##### -->
<para>
</para>
@channel:
@proc_install:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_proc_uninstall_write ##### -->
<para>
</para>
@channel:
@proc_uninstall:
@user_data:
@Returns:
<!-- ##### FUNCTION gp_extension_ack_write ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:

30
devel-docs/libgimpbase/tmpl/gimpunit.sgml
View File

@ -155,6 +155,36 @@ user-defined units.
<!-- ##### MACRO GIMP_TYPE_PARAM_UNIT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_IS_PARAM_SPEC_UNIT ##### -->
<para>
</para>
@pspec:
<!-- ##### FUNCTION gimp_param_spec_unit ##### -->
<para>
</para>
@name:
@nick:
@blurb:
@allow_pixels:
@allow_percent:
@default_value:
@flags:
@Returns:
<!-- ##### MACRO GIMP_VALUE_HOLDS_UNIT ##### -->
<para>

9
devel-docs/libgimpbase/tmpl/gimputils.sgml
View File

@ -66,6 +66,15 @@ Utilities of general interest
@Returns:
<!-- ##### FUNCTION gimp_canonicalize_identifier ##### -->
<para>
</para>
@identifier:
@Returns:
<!-- ##### FUNCTION gimp_enum_get_desc ##### -->
<para>

314
devel-docs/libgimpbase/tmpl/gimpwire.sgml
View File

@ -1,314 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpwire
<!-- ##### SECTION Short_Description ##### -->
The lowlevel I/O protocol used for communication between GIMP and
it's plug-ins.
<!-- ##### SECTION Long_Description ##### -->
<para>
The lowlevel I/O protocol used for communication between GIMP and
it's plug-ins.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#libgimp-gimpprotocol
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT WireMessage ##### -->
<para>
</para>
@type:
@data:
<!-- ##### USER_FUNCTION WireReadFunc ##### -->
<para>
</para>
@channel:
@msg:
@user_data:
<!-- ##### USER_FUNCTION WireWriteFunc ##### -->
<para>
</para>
@channel:
@msg:
@user_data:
<!-- ##### USER_FUNCTION WireDestroyFunc ##### -->
<para>
</para>
@msg:
<!-- ##### USER_FUNCTION WireIOFunc ##### -->
<para>
</para>
@channel:
@buf:
@count:
@user_data:
@Returns:
<!-- ##### USER_FUNCTION WireFlushFunc ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_register ##### -->
<para>
</para>
@type:
@read_func:
@write_func:
@destroy_func:
<!-- ##### FUNCTION wire_set_reader ##### -->
<para>
</para>
@read_func:
<!-- ##### FUNCTION wire_set_writer ##### -->
<para>
</para>
@write_func:
<!-- ##### FUNCTION wire_set_flusher ##### -->
<para>
</para>
@flush_func:
<!-- ##### FUNCTION wire_read ##### -->
<para>
</para>
@channel:
@buf:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write ##### -->
<para>
</para>
@channel:
@buf:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_flush ##### -->
<para>
</para>
@channel:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_error ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION wire_clear_error ##### -->
<para>
</para>
<!-- ##### FUNCTION wire_read_msg ##### -->
<para>
</para>
@channel:
@msg:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_msg ##### -->
<para>
</para>
@channel:
@msg:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_destroy ##### -->
<para>
</para>
@msg:
<!-- ##### FUNCTION wire_read_int32 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_read_int16 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_read_int8 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_read_double ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_read_string ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_int32 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_int16 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_int8 ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_double ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:
<!-- ##### FUNCTION wire_write_string ##### -->
<para>
</para>
@channel:
@data:
@count:
@user_data:
@Returns:

327
devel-docs/libgimpbase/xml/gimpbaseenums.xml
View File

@ -4,34 +4,49 @@
<refentry id="libgimpbase-gimpbaseenums">
<refmeta>
<refentrytitle role="top_of_page">gimpbaseenums</refentrytitle>
<refentrytitle>gimpbaseenums</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpbaseenums</refname>
<refpurpose>Basic GIMP enumeration data types.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpbaseenums</refname><refpurpose>Basic GIMP enumeration data types.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
enum <link linkend="GimpCheckSize">GimpCheckSize</link>;
enum <link linkend="GimpCheckType">GimpCheckType</link>;
enum <link linkend="GimpImageBaseType">GimpImageBaseType</link>;
enum <link linkend="GimpImageType">GimpImageType</link>;
enum <link linkend="GimpMessageHandlerType">GimpMessageHandlerType</link>;
enum <link linkend="GimpPDBArgType">GimpPDBArgType</link>;
enum <link linkend="GimpPDBProcType">GimpPDBProcType</link>;
enum <link linkend="GimpPDBStatusType">GimpPDBStatusType</link>;
enum <link linkend="GimpProgressCommand">GimpProgressCommand</link>;
enum <link linkend="GimpStackTraceMode">GimpStackTraceMode</link>;
enum <link linkend="GimpAddMaskType">GimpAddMaskType</link>;
enum <link linkend="GimpBlendMode">GimpBlendMode</link>;
enum <link linkend="GimpBucketFillMode">GimpBucketFillMode</link>;
enum <link linkend="GimpChannelOps">GimpChannelOps</link>;
enum <link linkend="GimpChannelType">GimpChannelType</link>;
enum <link linkend="GimpCheckSize">GimpCheckSize</link>;
enum <link linkend="GimpCheckType">GimpCheckType</link>;
enum <link linkend="GimpCloneType">GimpCloneType</link>;
enum <link linkend="GimpDesaturateMode">GimpDesaturateMode</link>;
enum <link linkend="GimpDodgeBurnType">GimpDodgeBurnType</link>;
enum <link linkend="GimpForegroundExtractMode">GimpForegroundExtractMode</link>;
enum <link linkend="GimpGradientType">GimpGradientType</link>;
enum <link linkend="GimpGridStyle">GimpGridStyle</link>;
enum <link linkend="GimpIconType">GimpIconType</link>;
enum <link linkend="GimpImageBaseType">GimpImageBaseType</link>;
enum <link linkend="GimpImageType">GimpImageType</link>;
enum <link linkend="GimpInterpolationType">GimpInterpolationType</link>;
enum <link linkend="GimpMessageHandlerType">GimpMessageHandlerType</link>;
enum <link linkend="GimpPaintApplicationMode">GimpPaintApplicationMode</link>;
enum <link linkend="GimpPDBArgType">GimpPDBArgType</link>;
enum <link linkend="GimpPDBProcType">GimpPDBProcType</link>;
enum <link linkend="GimpPDBStatusType">GimpPDBStatusType</link>;
enum <link linkend="GimpProgressCommand">GimpProgressCommand</link>;
enum <link linkend="GimpRepeatMode">GimpRepeatMode</link>;
enum <link linkend="GimpSizeType">GimpSizeType</link>;
enum <link linkend="GimpStackTraceMode">GimpStackTraceMode</link>;
enum <link linkend="GimpTransferMode">GimpTransferMode</link>;
enum <link linkend="GimpTransformDirection">GimpTransformDirection</link>;
</synopsis>
</refsynopsisdiv>
@ -44,17 +59,85 @@ enum <link linkend="GimpStackTraceMode">GimpStackTraceMode</link>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Basic GIMP enumeration data types.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpCheckSize" role="enum"/>enum GimpCheckSize</title>
<title><anchor id="GimpAddMaskType"/>enum GimpAddMaskType</title>
<indexterm><primary>GimpAddMaskType</primary></indexterm><programlisting>typedef enum
{
GIMP_ADD_WHITE_MASK, /*&lt; desc="_White (full opacity)" &gt;*/
GIMP_ADD_BLACK_MASK, /*&lt; desc="_Black (full transparency)" &gt;*/
GIMP_ADD_ALPHA_MASK, /*&lt; desc="Layer's _alpha channel" &gt;*/
GIMP_ADD_ALPHA_TRANSFER_MASK, /*&lt; desc="_Transfer layer's alpha channel" &gt;*/
GIMP_ADD_SELECTION_MASK, /*&lt; desc="_Selection" &gt;*/
GIMP_ADD_COPY_MASK /*&lt; desc="_Grayscale copy of layer" &gt;*/
} GimpAddMaskType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpBlendMode"/>enum GimpBlendMode</title>
<indexterm><primary>GimpBlendMode</primary></indexterm><programlisting>typedef enum
{
GIMP_FG_BG_RGB_MODE, /*&lt; desc="FG to BG (RGB)" &gt;*/
GIMP_FG_BG_HSV_MODE, /*&lt; desc="FG to BG (HSV)" &gt;*/
GIMP_FG_TRANSPARENT_MODE, /*&lt; desc="FG to transparent" &gt;*/
GIMP_CUSTOM_MODE /*&lt; desc="Custom gradient" &gt;*/
} GimpBlendMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpBucketFillMode"/>enum GimpBucketFillMode</title>
<indexterm><primary>GimpBucketFillMode</primary></indexterm><programlisting>typedef enum
{
GIMP_FG_BUCKET_FILL, /*&lt; desc="FG color fill" &gt;*/
GIMP_BG_BUCKET_FILL, /*&lt; desc="BG color fill" &gt;*/
GIMP_PATTERN_BUCKET_FILL /*&lt; desc="Pattern fill" &gt;*/
} GimpBucketFillMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpChannelOps"/>enum GimpChannelOps</title>
<indexterm><primary>GimpChannelOps</primary></indexterm><programlisting>typedef enum
{
GIMP_CHANNEL_OP_ADD, /*&lt; desc="Add to the current selection" &gt;*/
GIMP_CHANNEL_OP_SUBTRACT, /*&lt; desc="Subtract from the current selection" &gt;*/
GIMP_CHANNEL_OP_REPLACE, /*&lt; desc="Replace the current selection" &gt;*/
GIMP_CHANNEL_OP_INTERSECT /*&lt; desc="Intersect with the current selection" &gt;*/
} GimpChannelOps;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpChannelType"/>enum GimpChannelType</title>
<indexterm><primary>GimpChannelType</primary></indexterm><programlisting>typedef enum
{
GIMP_RED_CHANNEL, /*&lt; desc="Red" &gt;*/
GIMP_GREEN_CHANNEL, /*&lt; desc="Green" &gt;*/
GIMP_BLUE_CHANNEL, /*&lt; desc="Blue" &gt;*/
GIMP_GRAY_CHANNEL, /*&lt; desc="Gray" &gt;*/
GIMP_INDEXED_CHANNEL, /*&lt; desc="Indexed" &gt;*/
GIMP_ALPHA_CHANNEL /*&lt; desc="Alpha" &gt;*/
} GimpChannelType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpCheckSize"/>enum GimpCheckSize</title>
<indexterm><primary>GimpCheckSize</primary></indexterm><programlisting>typedef enum /*&lt; pdb-skip &gt;*/
{
GIMP_CHECK_SIZE_SMALL_CHECKS = 0, /*&lt; desc="Small" &gt;*/
@ -66,22 +149,112 @@ Basic GIMP enumeration data types.
</para></refsect2>
<refsect2>
<title><anchor id="GimpCheckType" role="enum"/>enum GimpCheckType</title>
<title><anchor id="GimpCheckType"/>enum GimpCheckType</title>
<indexterm><primary>GimpCheckType</primary></indexterm><programlisting>typedef enum /*&lt; pdb-skip &gt;*/
{
GIMP_CHECK_TYPE_LIGHT_CHECKS = 0, /*&lt; desc="Light Checks" &gt;*/
GIMP_CHECK_TYPE_GRAY_CHECKS = 1, /*&lt; desc="Mid-Tone Checks" &gt;*/
GIMP_CHECK_TYPE_DARK_CHECKS = 2, /*&lt; desc="Dark Checks" &gt;*/
GIMP_CHECK_TYPE_WHITE_ONLY = 3, /*&lt; desc="White Only" &gt;*/
GIMP_CHECK_TYPE_GRAY_ONLY = 4, /*&lt; desc="Gray Only" &gt;*/
GIMP_CHECK_TYPE_BLACK_ONLY = 5 /*&lt; desc="Black Only" &gt;*/
GIMP_CHECK_TYPE_LIGHT_CHECKS = 0, /*&lt; desc="Light checks" &gt;*/
GIMP_CHECK_TYPE_GRAY_CHECKS = 1, /*&lt; desc="Mid-tone checks" &gt;*/
GIMP_CHECK_TYPE_DARK_CHECKS = 2, /*&lt; desc="Dark checks" &gt;*/
GIMP_CHECK_TYPE_WHITE_ONLY = 3, /*&lt; desc="White only" &gt;*/
GIMP_CHECK_TYPE_GRAY_ONLY = 4, /*&lt; desc="Gray only" &gt;*/
GIMP_CHECK_TYPE_BLACK_ONLY = 5 /*&lt; desc="Black only" &gt;*/
} GimpCheckType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpImageBaseType" role="enum"/>enum GimpImageBaseType</title>
<title><anchor id="GimpCloneType"/>enum GimpCloneType</title>
<indexterm><primary>GimpCloneType</primary></indexterm><programlisting>typedef enum
{
GIMP_IMAGE_CLONE, /*&lt; desc="Image source" &gt;*/
GIMP_PATTERN_CLONE /*&lt; desc="Pattern source" &gt;*/
} GimpCloneType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpDesaturateMode"/>enum GimpDesaturateMode</title>
<indexterm><primary>GimpDesaturateMode</primary></indexterm><programlisting>typedef enum
{
GIMP_DESATURATE_LIGHTNESS, /*&lt; desc="Lightness" &gt;*/
GIMP_DESATURATE_LUMINOSITY, /*&lt; desc="Luminosity" &gt;*/
GIMP_DESATURATE_AVERAGE /*&lt; desc="Average" &gt;*/
} GimpDesaturateMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpDodgeBurnType"/>enum GimpDodgeBurnType</title>
<indexterm><primary>GimpDodgeBurnType</primary></indexterm><programlisting>typedef enum
{
GIMP_DODGE, /*&lt; desc="Dodge" &gt;*/
GIMP_BURN /*&lt; desc="Burn" &gt;*/
} GimpDodgeBurnType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpForegroundExtractMode"/>enum GimpForegroundExtractMode</title>
<indexterm><primary>GimpForegroundExtractMode</primary></indexterm><programlisting>typedef enum
{
GIMP_FOREGROUND_EXTRACT_SIOX
} GimpForegroundExtractMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpGradientType"/>enum GimpGradientType</title>
<indexterm><primary>GimpGradientType</primary></indexterm><programlisting>typedef enum
{
GIMP_GRADIENT_LINEAR, /*&lt; desc="Linear" &gt;*/
GIMP_GRADIENT_BILINEAR, /*&lt; desc="Bi-linear" &gt;*/
GIMP_GRADIENT_RADIAL, /*&lt; desc="Radial" &gt;*/
GIMP_GRADIENT_SQUARE, /*&lt; desc="Square" &gt;*/
GIMP_GRADIENT_CONICAL_SYMMETRIC, /*&lt; desc="Conical (sym)" &gt;*/
GIMP_GRADIENT_CONICAL_ASYMMETRIC, /*&lt; desc="Conical (asym)" &gt;*/
GIMP_GRADIENT_SHAPEBURST_ANGULAR, /*&lt; desc="Shaped (angular)" &gt;*/
GIMP_GRADIENT_SHAPEBURST_SPHERICAL, /*&lt; desc="Shaped (spherical)"&gt;*/
GIMP_GRADIENT_SHAPEBURST_DIMPLED, /*&lt; desc="Shaped (dimpled)" &gt;*/
GIMP_GRADIENT_SPIRAL_CLOCKWISE, /*&lt; desc="Spiral (cw)" &gt;*/
GIMP_GRADIENT_SPIRAL_ANTICLOCKWISE /*&lt; desc="Spiral (ccw)" &gt;*/
} GimpGradientType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpGridStyle"/>enum GimpGridStyle</title>
<indexterm><primary>GimpGridStyle</primary></indexterm><programlisting>typedef enum
{
GIMP_GRID_DOTS, /*&lt; desc="Intersections (dots)" &gt;*/
GIMP_GRID_INTERSECTIONS, /*&lt; desc="Intersections (crosshairs)" &gt;*/
GIMP_GRID_ON_OFF_DASH, /*&lt; desc="Dashed" &gt;*/
GIMP_GRID_DOUBLE_DASH, /*&lt; desc="Double dashed" &gt;*/
GIMP_GRID_SOLID /*&lt; desc="Solid" &gt;*/
} GimpGridStyle;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpIconType"/>enum GimpIconType</title>
<indexterm><primary>GimpIconType</primary></indexterm><programlisting>typedef enum
{
GIMP_ICON_TYPE_STOCK_ID, /*&lt; desc="Stock ID" &gt;*/
GIMP_ICON_TYPE_INLINE_PIXBUF, /*&lt; desc="Inline pixbuf" &gt;*/
GIMP_ICON_TYPE_IMAGE_FILE /*&lt; desc="Image file" &gt;*/
} GimpIconType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpImageBaseType"/>enum GimpImageBaseType</title>
<indexterm><primary>GimpImageBaseType</primary></indexterm><programlisting>typedef enum
{
GIMP_RGB, /*&lt; desc="RGB color" &gt;*/
@ -93,7 +266,7 @@ Basic GIMP enumeration data types.
</para></refsect2>
<refsect2>
<title><anchor id="GimpImageType" role="enum"/>enum GimpImageType</title>
<title><anchor id="GimpImageType"/>enum GimpImageType</title>
<indexterm><primary>GimpImageType</primary></indexterm><programlisting>typedef enum
{
GIMP_RGB_IMAGE, /*&lt; desc="RGB" &gt;*/
@ -108,7 +281,20 @@ Basic GIMP enumeration data types.
</para></refsect2>
<refsect2>
<title><anchor id="GimpMessageHandlerType" role="enum"/>enum GimpMessageHandlerType</title>
<title><anchor id="GimpInterpolationType"/>enum GimpInterpolationType</title>
<indexterm><primary>GimpInterpolationType</primary></indexterm><programlisting>typedef enum
{
GIMP_INTERPOLATION_NONE, /*&lt; desc="None (Fastest)" &gt;*/
GIMP_INTERPOLATION_LINEAR, /*&lt; desc="Linear" &gt;*/
GIMP_INTERPOLATION_CUBIC, /*&lt; desc="Cubic" &gt;*/
GIMP_INTERPOLATION_LANCZOS /*&lt; desc="Lanczos (Best)" &gt;*/
} GimpInterpolationType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpMessageHandlerType"/>enum GimpMessageHandlerType</title>
<indexterm><primary>GimpMessageHandlerType</primary></indexterm><programlisting>typedef enum
{
GIMP_MESSAGE_BOX,
@ -120,7 +306,18 @@ Basic GIMP enumeration data types.
</para></refsect2>
<refsect2>
<title><anchor id="GimpPDBArgType" role="enum"/>enum GimpPDBArgType</title>
<title><anchor id="GimpPaintApplicationMode"/>enum GimpPaintApplicationMode</title>
<indexterm><primary>GimpPaintApplicationMode</primary></indexterm><programlisting>typedef enum
{
GIMP_PAINT_CONSTANT, /*&lt; desc="Constant" &gt;*/
GIMP_PAINT_INCREMENTAL /*&lt; desc="Incremental" &gt;*/
} GimpPaintApplicationMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpPDBArgType"/>enum GimpPDBArgType</title>
<indexterm><primary>GimpPDBArgType</primary></indexterm><programlisting>typedef enum
{
GIMP_PDB_INT32,
@ -152,20 +349,20 @@ Basic GIMP enumeration data types.
</para></refsect2>
<refsect2>
<title><anchor id="GimpPDBProcType" role="enum"/>enum GimpPDBProcType</title>
<title><anchor id="GimpPDBProcType"/>enum GimpPDBProcType</title>
<indexterm><primary>GimpPDBProcType</primary></indexterm><programlisting>typedef enum
{
GIMP_INTERNAL,
GIMP_PLUGIN,
GIMP_EXTENSION,
GIMP_TEMPORARY
GIMP_INTERNAL, /*&lt; desc="Internal GIMP procedure" &gt;*/
GIMP_PLUGIN, /*&lt; desc="GIMP Plug-In" &gt;*/
GIMP_EXTENSION, /*&lt; desc="GIMP Extension" &gt;*/
GIMP_TEMPORARY /*&lt; desc="Temporary Procedure" &gt;*/
} GimpPDBProcType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpPDBStatusType" role="enum"/>enum GimpPDBStatusType</title>
<title><anchor id="GimpPDBStatusType"/>enum GimpPDBStatusType</title>
<indexterm><primary>GimpPDBStatusType</primary></indexterm><programlisting>typedef enum
{
GIMP_PDB_EXECUTION_ERROR,
@ -179,20 +376,45 @@ Basic GIMP enumeration data types.
</para></refsect2>
<refsect2>
<title><anchor id="GimpProgressCommand" role="enum"/>enum GimpProgressCommand</title>
<title><anchor id="GimpProgressCommand"/>enum GimpProgressCommand</title>
<indexterm><primary>GimpProgressCommand</primary></indexterm><programlisting>typedef enum
{
GIMP_PROGRESS_COMMAND_START,
GIMP_PROGRESS_COMMAND_END,
GIMP_PROGRESS_COMMAND_SET_TEXT,
GIMP_PROGRESS_COMMAND_SET_VALUE
GIMP_PROGRESS_COMMAND_SET_VALUE,
GIMP_PROGRESS_COMMAND_PULSE,
GIMP_PROGRESS_COMMAND_GET_WINDOW
} GimpProgressCommand;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpStackTraceMode" role="enum"/>enum GimpStackTraceMode</title>
<title><anchor id="GimpRepeatMode"/>enum GimpRepeatMode</title>
<indexterm><primary>GimpRepeatMode</primary></indexterm><programlisting>typedef enum
{
GIMP_REPEAT_NONE, /*&lt; desc="None" &gt;*/
GIMP_REPEAT_SAWTOOTH, /*&lt; desc="Sawtooth wave" &gt;*/
GIMP_REPEAT_TRIANGULAR /*&lt; desc="Triangular wave" &gt;*/
} GimpRepeatMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpSizeType"/>enum GimpSizeType</title>
<indexterm><primary>GimpSizeType</primary></indexterm><programlisting>typedef enum
{
GIMP_PIXELS, /*&lt; desc="Pixels" &gt;*/
GIMP_POINTS /*&lt; desc="Points" &gt;*/
} GimpSizeType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpStackTraceMode"/>enum GimpStackTraceMode</title>
<indexterm><primary>GimpStackTraceMode</primary></indexterm><programlisting>typedef enum
{
GIMP_STACK_TRACE_NEVER,
@ -202,6 +424,29 @@ Basic GIMP enumeration data types.
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpTransferMode"/>enum GimpTransferMode</title>
<indexterm><primary>GimpTransferMode</primary></indexterm><programlisting>typedef enum
{
GIMP_SHADOWS, /*&lt; desc="Shadows" &gt;*/
GIMP_MIDTONES, /*&lt; desc="Midtones" &gt;*/
GIMP_HIGHLIGHTS /*&lt; desc="Highlights" &gt;*/
} GimpTransferMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpTransformDirection"/>enum GimpTransformDirection</title>
<indexterm><primary>GimpTransformDirection</primary></indexterm><programlisting>typedef enum
{
GIMP_TRANSFORM_FORWARD, /*&lt; desc="Forward" &gt;*/
GIMP_TRANSFORM_BACKWARD /*&lt; desc="Backward" &gt;*/
} GimpTransformDirection;
</programlisting>
<para>
</para></refsect2>
</refsect1>

109
devel-docs/libgimpbase/xml/gimpbasetypes.xml
View File

@ -4,35 +4,38 @@
<refentry id="libgimpbase-gimpbasetypes">
<refmeta>
<refentrytitle role="top_of_page">gimpbasetypes</refentrytitle>
<refentrytitle>gimpbasetypes</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpbasetypes</refname>
<refpurpose>Translation between gettext translation domain identifier and GType.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpbasetypes</refname><refpurpose>Translation between gettext translation domain identifier and GType.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="GimpEnumDesc">GimpEnumDesc</link>;
<link linkend="GimpFlagsDesc">GimpFlagsDesc</link>;
<link linkend="void">void</link> <link linkend="gimp-type-set-translation-domain">gimp_type_set_translation_domain</link> (<link linkend="GType">GType</link> type,
const <link linkend="gchar">gchar</link> *domain);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-type-get-translation-domain">gimp_type_get_translation_domain</link> (<link linkend="GType">GType</link> type);
<link linkend="void">void</link> <link linkend="gimp-enum-set-value-descriptions">gimp_enum_set_value_descriptions</link> (<link linkend="GType">GType</link> enum_type,
const <link linkend="GimpEnumDesc">GimpEnumDesc</link> *descriptions);
const <link linkend="GimpEnumDesc">GimpEnumDesc</link>* <link linkend="gimp-enum-get-value-descriptions">gimp_enum_get_value_descriptions</link> (<link linkend="GType">GType</link> enum_type);
const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* <link linkend="gimp-flags-get-value-descriptions">gimp_flags_get_value_descriptions</link> (<link linkend="GType">GType</link> flags_type);
<link linkend="void">void</link> <link linkend="gimp-flags-set-value-descriptions">gimp_flags_set_value_descriptions</link> (<link linkend="GType">GType</link> flags_type,
const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link> *descriptions);
<link linkend="GimpEnumDesc">GimpEnumDesc</link>;
<link linkend="GimpFlagsDesc">GimpFlagsDesc</link>;
<link linkend="void">void</link> <link linkend="gimp-type-set-translation-domain">gimp_type_set_translation_domain</link>
(<link linkend="GType">GType</link> type,
const <link linkend="gchar">gchar</link> *domain);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-type-get-translation-domain">gimp_type_get_translation_domain</link>
(<link linkend="GType">GType</link> type);
<link linkend="void">void</link> <link linkend="gimp-enum-set-value-descriptions">gimp_enum_set_value_descriptions</link>
(<link linkend="GType">GType</link> enum_type,
const <link linkend="GimpEnumDesc">GimpEnumDesc</link> *descriptions);
const <link linkend="GimpEnumDesc">GimpEnumDesc</link>* <link linkend="gimp-enum-get-value-descriptions">gimp_enum_get_value_descriptions</link>
(<link linkend="GType">GType</link> enum_type);
const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* <link linkend="gimp-flags-get-value-descriptions">gimp_flags_get_value_descriptions</link>
(<link linkend="GType">GType</link> flags_type);
<link linkend="void">void</link> <link linkend="gimp-flags-set-value-descriptions">gimp_flags_set_value_descriptions</link>
(<link linkend="GType">GType</link> flags_type,
const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link> *descriptions);
</synopsis>
</refsynopsisdiv>
@ -44,17 +47,17 @@ const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* <link linkend="gimp-fl
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Translation between gettext translation domain identifier and GType.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpEnumDesc" role="struct"/>GimpEnumDesc</title>
<title><anchor id="GimpEnumDesc"/>GimpEnumDesc</title>
<indexterm><primary>GimpEnumDesc</primary></indexterm><programlisting>typedef struct {
gint value;
gchar *value_desc;
@ -65,7 +68,7 @@ Translation between gettext translation domain identifier and GType.
</para></refsect2>
<refsect2>
<title><anchor id="GimpFlagsDesc" role="struct"/>GimpFlagsDesc</title>
<title><anchor id="GimpFlagsDesc"/>GimpFlagsDesc</title>
<indexterm><primary>GimpFlagsDesc</primary></indexterm><programlisting>typedef struct {
guint value;
gchar *value_desc;
@ -76,9 +79,10 @@ Translation between gettext translation domain identifier and GType.
</para></refsect2>
<refsect2>
<title><anchor id="gimp-type-set-translation-domain" role="function" condition="since:GIMP 2.2"/>gimp_type_set_translation_domain ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_type_set_translation_domain</primary></indexterm><programlisting><link linkend="void">void</link> gimp_type_set_translation_domain (<link linkend="GType">GType</link> type,
const <link linkend="gchar">gchar</link> *domain);</programlisting>
<title><anchor id="gimp-type-set-translation-domain"/>gimp_type_set_translation_domain ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_type_set_translation_domain</primary></indexterm><programlisting><link linkend="void">void</link> gimp_type_set_translation_domain
(<link linkend="GType">GType</link> type,
const <link linkend="gchar">gchar</link> *domain);</programlisting>
<para>
This function attaches a constant string as a gettext translation
domain identifier to a <link linkend="GType"><type>GType</type></link>. The only purpose of this function is
@ -91,13 +95,14 @@ names.</para>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>domain</parameter>&nbsp;:</term>
<listitem><simpara> a constant string that identifies a translation domain or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
<listitem><simpara> a constant string that identifies a translation domain or <literal>NULL</literal>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-type-get-translation-domain" role="function" condition="since:GIMP 2.2"/>gimp_type_get_translation_domain ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_type_get_translation_domain</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_type_get_translation_domain (<link linkend="GType">GType</link> type);</programlisting>
<title><anchor id="gimp-type-get-translation-domain"/>gimp_type_get_translation_domain ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_type_get_translation_domain</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_type_get_translation_domain
(<link linkend="GType">GType</link> type);</programlisting>
<para>
Retrieves the gettext translation domain identifier that has been
previously set using <link linkend="gimp-type-set-translation-domain"><function>gimp_type_set_translation_domain()</function></link>. You should
@ -110,15 +115,16 @@ or <link linkend="gimp-enum-value-get-name"><function>gimp_enum_value_get_name()
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translation domain associated with <parameter>type</parameter>
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if no domain was set
or <literal>NULL</literal> if no domain was set
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-set-value-descriptions" role="function" condition="since:GIMP 2.2"/>gimp_enum_set_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_set_value_descriptions</primary></indexterm><programlisting><link linkend="void">void</link> gimp_enum_set_value_descriptions (<link linkend="GType">GType</link> enum_type,
const <link linkend="GimpEnumDesc">GimpEnumDesc</link> *descriptions);</programlisting>
<title><anchor id="gimp-enum-set-value-descriptions"/>gimp_enum_set_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_set_value_descriptions</primary></indexterm><programlisting><link linkend="void">void</link> gimp_enum_set_value_descriptions
(<link linkend="GType">GType</link> enum_type,
const <link linkend="GimpEnumDesc">GimpEnumDesc</link> *descriptions);</programlisting>
<para>
Sets the array of human readable and translatable descriptions
and help texts for enum values.</para>
@ -129,13 +135,14 @@ and help texts for enum values.</para>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>descriptions</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated constant static array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
<listitem><simpara> a <literal>NULL</literal> terminated constant static array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-get-value-descriptions" role="function" condition="since:GIMP 2.2"/>gimp_enum_get_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_get_value_descriptions</primary></indexterm><programlisting>const <link linkend="GimpEnumDesc">GimpEnumDesc</link>* gimp_enum_get_value_descriptions (<link linkend="GType">GType</link> enum_type);</programlisting>
<title><anchor id="gimp-enum-get-value-descriptions"/>gimp_enum_get_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_get_value_descriptions</primary></indexterm><programlisting>const <link linkend="GimpEnumDesc">GimpEnumDesc</link>* gimp_enum_get_value_descriptions
(<link linkend="GType">GType</link> enum_type);</programlisting>
<para>
Retreives the array of human readable and translatable descriptions
and help texts for enum values.</para>
@ -145,14 +152,15 @@ and help texts for enum values.</para>
<varlistentry><term><parameter>enum_type</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated constant array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <literal>NULL</literal> terminated constant array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-get-value-descriptions" role="function" condition="since:GIMP 2.2"/>gimp_flags_get_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_get_value_descriptions</primary></indexterm><programlisting>const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* gimp_flags_get_value_descriptions (<link linkend="GType">GType</link> flags_type);</programlisting>
<title><anchor id="gimp-flags-get-value-descriptions"/>gimp_flags_get_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_get_value_descriptions</primary></indexterm><programlisting>const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* gimp_flags_get_value_descriptions
(<link linkend="GType">GType</link> flags_type);</programlisting>
<para>
Retreives the array of human readable and translatable descriptions
and help texts for flags values.</para>
@ -162,15 +170,16 @@ and help texts for flags values.</para>
<varlistentry><term><parameter>flags_type</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated constant array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <literal>NULL</literal> terminated constant array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-set-value-descriptions" role="function" condition="since:GIMP 2.2"/>gimp_flags_set_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_set_value_descriptions</primary></indexterm><programlisting><link linkend="void">void</link> gimp_flags_set_value_descriptions (<link linkend="GType">GType</link> flags_type,
const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link> *descriptions);</programlisting>
<title><anchor id="gimp-flags-set-value-descriptions"/>gimp_flags_set_value_descriptions ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_set_value_descriptions</primary></indexterm><programlisting><link linkend="void">void</link> gimp_flags_set_value_descriptions
(<link linkend="GType">GType</link> flags_type,
const <link linkend="GimpFlagsDesc">GimpFlagsDesc</link> *descriptions);</programlisting>
<para>
Sets the array of human readable and translatable descriptions
and help texts for flags values.</para>
@ -181,9 +190,9 @@ and help texts for flags values.</para>
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>descriptions</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated constant static array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
<listitem><simpara> a <literal>NULL</literal> terminated constant static array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>

49
devel-docs/libgimpbase/xml/gimpchecks.xml
View File

@ -4,31 +4,28 @@
<refentry id="libgimpbase-gimpchecks">
<refmeta>
<refentrytitle role="top_of_page">gimpchecks</refentrytitle>
<refentrytitle>gimpchecks</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpchecks</refname>
<refpurpose>Constants and functions related to rendering checkerboards.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpchecks</refname><refpurpose>Constants and functions related to rendering checkerboards.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
#define <link linkend="GIMP-CHECK-SIZE:CAPS">GIMP_CHECK_SIZE</link>
#define <link linkend="GIMP-CHECK-SIZE-SM:CAPS">GIMP_CHECK_SIZE_SM</link>
#define <link linkend="GIMP-CHECK-DARK:CAPS">GIMP_CHECK_DARK</link>
#define <link linkend="GIMP-CHECK-LIGHT:CAPS">GIMP_CHECK_LIGHT</link>
<link linkend="void">void</link> <link linkend="gimp-checks-get-shades">gimp_checks_get_shades</link> (<link linkend="GimpCheckType">GimpCheckType</link> type,
<link linkend="guchar">guchar</link> *light,
<link linkend="guchar">guchar</link> *dark);
#define <link linkend="GIMP-CHECK-SIZE:CAPS">GIMP_CHECK_SIZE</link>
#define <link linkend="GIMP-CHECK-SIZE-SM:CAPS">GIMP_CHECK_SIZE_SM</link>
#define <link linkend="GIMP-CHECK-DARK:CAPS">GIMP_CHECK_DARK</link>
#define <link linkend="GIMP-CHECK-LIGHT:CAPS">GIMP_CHECK_LIGHT</link>
<link linkend="void">void</link> <link linkend="gimp-checks-get-shades">gimp_checks_get_shades</link> (<link linkend="GimpCheckType">GimpCheckType</link> type,
<link linkend="guchar">guchar</link> *light,
<link linkend="guchar">guchar</link> *dark);
</synopsis>
</refsynopsisdiv>
@ -40,17 +37,17 @@
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Constants and functions related to rendering checkerboards.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GIMP-CHECK-SIZE:CAPS" role="macro"/>GIMP_CHECK_SIZE</title>
<title><anchor id="GIMP-CHECK-SIZE:CAPS"/>GIMP_CHECK_SIZE</title>
<indexterm><primary>GIMP_CHECK_SIZE</primary></indexterm><programlisting>#define GIMP_CHECK_SIZE 8
</programlisting>
<para>
@ -59,31 +56,31 @@ core but GIMP plug-ins can't access the user preference and should use
this constant instead.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-CHECK-SIZE-SM:CAPS" role="macro"/>GIMP_CHECK_SIZE_SM</title>
<title><anchor id="GIMP-CHECK-SIZE-SM:CAPS"/>GIMP_CHECK_SIZE_SM</title>
<indexterm><primary>GIMP_CHECK_SIZE_SM</primary></indexterm><programlisting>#define GIMP_CHECK_SIZE_SM 4
</programlisting>
<para>
The default small checkerboard size in pixels.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-CHECK-DARK:CAPS" role="macro"/>GIMP_CHECK_DARK</title>
<title><anchor id="GIMP-CHECK-DARK:CAPS"/>GIMP_CHECK_DARK</title>
<indexterm><primary>GIMP_CHECK_DARK</primary></indexterm><programlisting>#define GIMP_CHECK_DARK 0.4
</programlisting>
<para>
The dark gray value for the default checkerboard pattern.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-CHECK-LIGHT:CAPS" role="macro"/>GIMP_CHECK_LIGHT</title>
<title><anchor id="GIMP-CHECK-LIGHT:CAPS"/>GIMP_CHECK_LIGHT</title>
<indexterm><primary>GIMP_CHECK_LIGHT</primary></indexterm><programlisting>#define GIMP_CHECK_LIGHT 0.6
</programlisting>
<para>
The light gray value for the default checkerboard pattern.
</para></refsect2>
<refsect2>
<title><anchor id="gimp-checks-get-shades" role="function" condition="since:GIMP 2.2"/>gimp_checks_get_shades ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_checks_get_shades</primary></indexterm><programlisting><link linkend="void">void</link> gimp_checks_get_shades (<link linkend="GimpCheckType">GimpCheckType</link> type,
<link linkend="guchar">guchar</link> *light,
<link linkend="guchar">guchar</link> *dark);</programlisting>
<title><anchor id="gimp-checks-get-shades"/>gimp_checks_get_shades ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_checks_get_shades</primary></indexterm><programlisting><link linkend="void">void</link> gimp_checks_get_shades (<link linkend="GimpCheckType">GimpCheckType</link> type,
<link linkend="guchar">guchar</link> *light,
<link linkend="guchar">guchar</link> *dark);</programlisting>
<para>
Retrieves the actual shades of gray to use when drawing a
checkerboard for a certain <link linkend="GimpCheckType"><type>GimpCheckType</type></link>.</para>
@ -99,7 +96,7 @@ checkerboard for a certain <link linkend="GimpCheckType"><type>GimpCheckType</ty
<varlistentry><term><parameter>dark</parameter>&nbsp;:</term>
<listitem><simpara> return location for the dark shade
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>

59
devel-docs/libgimpbase/xml/gimpdatafiles.xml
View File

@ -4,33 +4,30 @@
<refentry id="libgimpbase-gimpdatafiles">
<refmeta>
<refentrytitle role="top_of_page">gimpdatafiles</refentrytitle>
<refentrytitle>gimpdatafiles</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpdatafiles</refname>
<refpurpose>Functions to handle GIMP data files.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpdatafiles</refname><refpurpose>Functions to handle GIMP data files.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="GimpDatafileData">GimpDatafileData</link>;
<link linkend="void">void</link> (<link linkend="GimpDatafileLoaderFunc">*GimpDatafileLoaderFunc</link>) (const <link linkend="GimpDatafileData">GimpDatafileData</link> *file_data,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-datafiles-check-extension">gimp_datafiles_check_extension</link> (const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *extension);
<link linkend="void">void</link> <link linkend="gimp-datafiles-read-directories">gimp_datafiles_read_directories</link> (const <link linkend="gchar">gchar</link> *path_str,
<link linkend="GFileTest">GFileTest</link> flags,
<link linkend="GimpDatafileLoaderFunc">GimpDatafileLoaderFunc</link> loader_func,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="GimpDatafileData">GimpDatafileData</link>;
<link linkend="void">void</link> (<link linkend="GimpDatafileLoaderFunc">*GimpDatafileLoaderFunc</link>) (const <link linkend="GimpDatafileData">GimpDatafileData</link> *file_data,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-datafiles-check-extension">gimp_datafiles_check_extension</link> (const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *extension);
<link linkend="void">void</link> <link linkend="gimp-datafiles-read-directories">gimp_datafiles_read_directories</link> (const <link linkend="gchar">gchar</link> *path_str,
<link linkend="GFileTest">GFileTest</link> flags,
<link linkend="GimpDatafileLoaderFunc">GimpDatafileLoaderFunc</link> loader_func,
<link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsynopsisdiv>
@ -42,17 +39,17 @@
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Functions to handle GIMP data files.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpDatafileData" role="struct"/>GimpDatafileData</title>
<title><anchor id="GimpDatafileData"/>GimpDatafileData</title>
<indexterm><primary>GimpDatafileData</primary></indexterm><programlisting>typedef struct {
const gchar *filename;
const gchar *dirname;
@ -67,9 +64,9 @@ Functions to handle GIMP data files.
</para></refsect2>
<refsect2>
<title><anchor id="GimpDatafileLoaderFunc" role="function"/>GimpDatafileLoaderFunc ()</title>
<indexterm><primary>GimpDatafileLoaderFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpDatafileLoaderFunc) (const <link linkend="GimpDatafileData">GimpDatafileData</link> *file_data,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="GimpDatafileLoaderFunc"/>GimpDatafileLoaderFunc ()</title>
<indexterm><primary>GimpDatafileLoaderFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpDatafileLoaderFunc) (const <link linkend="GimpDatafileData">GimpDatafileData</link> *file_data,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -83,9 +80,9 @@ Functions to handle GIMP data files.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-datafiles-check-extension" role="function"/>gimp_datafiles_check_extension ()</title>
<indexterm><primary>gimp_datafiles_check_extension</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_datafiles_check_extension (const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *extension);</programlisting>
<title><anchor id="gimp-datafiles-check-extension"/>gimp_datafiles_check_extension ()</title>
<indexterm><primary>gimp_datafiles_check_extension</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_datafiles_check_extension (const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *extension);</programlisting>
<para>
</para><variablelist role="params">
@ -101,11 +98,11 @@ Functions to handle GIMP data files.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-datafiles-read-directories" role="function"/>gimp_datafiles_read_directories ()</title>
<indexterm><primary>gimp_datafiles_read_directories</primary></indexterm><programlisting><link linkend="void">void</link> gimp_datafiles_read_directories (const <link linkend="gchar">gchar</link> *path_str,
<link linkend="GFileTest">GFileTest</link> flags,
<link linkend="GimpDatafileLoaderFunc">GimpDatafileLoaderFunc</link> loader_func,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gimp-datafiles-read-directories"/>gimp_datafiles_read_directories ()</title>
<indexterm><primary>gimp_datafiles_read_directories</primary></indexterm><programlisting><link linkend="void">void</link> gimp_datafiles_read_directories (const <link linkend="gchar">gchar</link> *path_str,
<link linkend="GFileTest">GFileTest</link> flags,
<link linkend="GimpDatafileLoaderFunc">GimpDatafileLoaderFunc</link> loader_func,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">

155
devel-docs/libgimpbase/xml/gimpenv.xml
View File

@ -4,38 +4,36 @@
<refentry id="libgimpbase-gimpenv">
<refmeta>
<refentrytitle role="top_of_page">gimpenv</refentrytitle>
<refentrytitle>gimpenv</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpenv</refname>
<refpurpose>Functions to access the GIMP environment.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpenv</refname><refpurpose>Functions to access the GIMP environment.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
const <link linkend="gchar">gchar</link>* <link linkend="gimp-directory">gimp_directory</link> (void);
<link linkend="gchar">gchar</link>* <link linkend="gimp-personal-rc-file">gimp_personal_rc_file</link> (const <link linkend="gchar">gchar</link> *basename);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-data-directory">gimp_data_directory</link> (void);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-locale-directory">gimp_locale_directory</link> (void);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-plug-in-directory">gimp_plug_in_directory</link> (void);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-sysconf-directory">gimp_sysconf_directory</link> (void);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-gtkrc">gimp_gtkrc</link> (void);
<link linkend="GList">GList</link>* <link linkend="gimp-path-parse">gimp_path_parse</link> (const <link linkend="gchar">gchar</link> *path,
<link linkend="gint">gint</link> max_paths,
<link linkend="gboolean">gboolean</link> check,
<link linkend="GList">GList</link> **check_failed);
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-to-str">gimp_path_to_str</link> (<link linkend="GList">GList</link> *path);
<link linkend="void">void</link> <link linkend="gimp-path-free">gimp_path_free</link> (<link linkend="GList">GList</link> *path);
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-get-user-writable-dir">gimp_path_get_user_writable_dir</link> (<link linkend="GList">GList</link> *path);
<link linkend="void">void</link> <link linkend="gimp-env-init">gimp_env_init</link> (<link linkend="gboolean">gboolean</link> plug_in);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-directory">gimp_directory</link> (void);
<link linkend="gchar">gchar</link>* <link linkend="gimp-personal-rc-file">gimp_personal_rc_file</link> (const <link linkend="gchar">gchar</link> *basename);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-data-directory">gimp_data_directory</link> (void);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-locale-directory">gimp_locale_directory</link> (void);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-plug-in-directory">gimp_plug_in_directory</link> (void);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-sysconf-directory">gimp_sysconf_directory</link> (void);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-gtkrc">gimp_gtkrc</link> (void);
<link linkend="GList">GList</link>* <link linkend="gimp-path-parse">gimp_path_parse</link> (const <link linkend="gchar">gchar</link> *path,
<link linkend="gint">gint</link> max_paths,
<link linkend="gboolean">gboolean</link> check,
<link linkend="GList">GList</link> **check_failed);
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-to-str">gimp_path_to_str</link> (<link linkend="GList">GList</link> *path);
<link linkend="void">void</link> <link linkend="gimp-path-free">gimp_path_free</link> (<link linkend="GList">GList</link> *path);
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-get-user-writable-dir">gimp_path_get_user_writable_dir</link> (<link linkend="GList">GList</link> *path);
</synopsis>
</refsynopsisdiv>
@ -47,19 +45,34 @@ const <link linkend="gchar">gchar</link>* <link linkend="gimp-gtkrc">gimp
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
A set of functions to find the locations of GIMP's data directories and
configuration files.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gimp-directory" role="function"/>gimp_directory ()</title>
<indexterm><primary>gimp_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_directory (void);</programlisting>
<title><anchor id="gimp-env-init"/>gimp_env_init ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_env_init</primary></indexterm><programlisting><link linkend="void">void</link> gimp_env_init (<link linkend="gboolean">gboolean</link> plug_in);</programlisting>
<para>
You don't need to care about this function. It is being called for
you automatically (by means of the <link linkend="MAIN:CAPS"><function>MAIN()</function></link> macro that every plug-in
runs). Calling it again will cause a fatal error.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plug_in</parameter>&nbsp;:</term>
<listitem><simpara> must be <literal>TRUE</literal> if this function is called from a plug-in
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-directory"/>gimp_directory ()</title>
<indexterm><primary>gimp_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_directory (void);</programlisting>
<para>
Returns the user-specific GIMP settings directory. If the
environment variable GIMP2_DIRECTORY exists, it is used. If it is
@ -77,10 +90,9 @@ return some non-empty string, whether it corresponds to an existing
directory or not.
</para>
<para>
The returned string is allocated just once, and should *NOT* be
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</para>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
<para>
</para><variablelist role="params">
@ -88,8 +100,8 @@ is on Windows).</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-personal-rc-file" role="function"/>gimp_personal_rc_file ()</title>
<indexterm><primary>gimp_personal_rc_file</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_personal_rc_file (const <link linkend="gchar">gchar</link> *basename);</programlisting>
<title><anchor id="gimp-personal-rc-file"/>gimp_personal_rc_file ()</title>
<indexterm><primary>gimp_personal_rc_file</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_personal_rc_file (const <link linkend="gchar">gchar</link> *basename);</programlisting>
<para>
Returns the name of a file in the user-specific GIMP settings directory.
</para>
@ -108,8 +120,8 @@ is on Windows).</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-data-directory" role="function"/>gimp_data_directory ()</title>
<indexterm><primary>gimp_data_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_data_directory (void);</programlisting>
<title><anchor id="gimp-data-directory"/>gimp_data_directory ()</title>
<indexterm><primary>gimp_data_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_data_directory (void);</programlisting>
<para>
Returns the top directory for GIMP data. If the environment
variable GIMP2_DATADIR exists, that is used. It should be an
@ -118,10 +130,9 @@ directory is used. On Win32, the installation directory as deduced
from the executable's name is used.
</para>
<para>
The returned string is allocated just once, and should *NOT* be
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</para>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
<para>
</para><variablelist role="params">
@ -129,8 +140,8 @@ is on Windows).</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-locale-directory" role="function"/>gimp_locale_directory ()</title>
<indexterm><primary>gimp_locale_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_locale_directory (void);</programlisting>
<title><anchor id="gimp-locale-directory"/>gimp_locale_directory ()</title>
<indexterm><primary>gimp_locale_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_locale_directory (void);</programlisting>
<para>
Returns the top directory for GIMP locale files. If the environment
variable GIMP2_LOCALEDIR exists, that is used. It should be an
@ -139,10 +150,9 @@ directory is used. On Win32, the installation directory as deduced
from the executable's name is used.
</para>
<para>
The returned string is allocated just once, and should *NOT* be
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</para>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
<para>
</para><variablelist role="params">
@ -150,8 +160,8 @@ is on Windows).</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-plug-in-directory" role="function"/>gimp_plug_in_directory ()</title>
<indexterm><primary>gimp_plug_in_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_plug_in_directory (void);</programlisting>
<title><anchor id="gimp-plug-in-directory"/>gimp_plug_in_directory ()</title>
<indexterm><primary>gimp_plug_in_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_plug_in_directory (void);</programlisting>
<para>
Returns the top directory for GIMP plug_ins and modules. If the
environment variable GIMP2_PLUGINDIR exists, that is used. It
@ -160,10 +170,9 @@ defined directory is used. On Win32, the installation directory as
deduced from the executable's name is used.
</para>
<para>
The returned string is allocated just once, and should *NOT* be
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</para>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
<para>
</para><variablelist role="params">
@ -171,8 +180,8 @@ is on Windows).</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-sysconf-directory" role="function"/>gimp_sysconf_directory ()</title>
<indexterm><primary>gimp_sysconf_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_sysconf_directory (void);</programlisting>
<title><anchor id="gimp-sysconf-directory"/>gimp_sysconf_directory ()</title>
<indexterm><primary>gimp_sysconf_directory</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_sysconf_directory (void);</programlisting>
<para>
Returns the top directory for GIMP config files. If the environment
variable GIMP2_SYSCONFDIR exists, that is used. It should be an
@ -181,10 +190,9 @@ directory is used. On Win32, the installation directory as deduced
from the executable's name is used.
</para>
<para>
The returned string is allocated just once, and should *NOT* be
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</para>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
<para>
</para><variablelist role="params">
@ -192,16 +200,15 @@ is on Windows).</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gtkrc" role="function"/>gimp_gtkrc ()</title>
<indexterm><primary>gimp_gtkrc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_gtkrc (void);</programlisting>
<title><anchor id="gimp-gtkrc"/>gimp_gtkrc ()</title>
<indexterm><primary>gimp_gtkrc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_gtkrc (void);</programlisting>
<para>
Returns the name of the GIMP's application-specific gtkrc file.
</para>
<para>
The returned string is allocated just once, and should *NOT* be
freed with <link linkend="g-free"><function>g_free()</function></link>. The returned string is in the encoding used
for filenames by the system, which isn't necessarily UTF-8 (never
is on Windows).</para>
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the system, which isn't necessarily UTF-8 (never is on Windows).</para>
<para>
</para><variablelist role="params">
@ -209,11 +216,11 @@ is on Windows).</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-path-parse" role="function"/>gimp_path_parse ()</title>
<indexterm><primary>gimp_path_parse</primary></indexterm><programlisting><link linkend="GList">GList</link>* gimp_path_parse (const <link linkend="gchar">gchar</link> *path,
<link linkend="gint">gint</link> max_paths,
<link linkend="gboolean">gboolean</link> check,
<link linkend="GList">GList</link> **check_failed);</programlisting>
<title><anchor id="gimp-path-parse"/>gimp_path_parse ()</title>
<indexterm><primary>gimp_path_parse</primary></indexterm><programlisting><link linkend="GList">GList</link>* gimp_path_parse (const <link linkend="gchar">gchar</link> *path,
<link linkend="gint">gint</link> max_paths,
<link linkend="gboolean">gboolean</link> check,
<link linkend="GList">GList</link> **check_failed);</programlisting>
<para>
</para>
<para>
@ -226,7 +233,7 @@ is on Windows).</para>
<listitem><simpara> The maximum number of directories to return.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>check</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if you want the directories to be checked.
<listitem><simpara> <literal>TRUE</literal> if you want the directories to be checked.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>check_failed</parameter>&nbsp;:</term>
<listitem><simpara> Returns a <link linkend="GList"><type>GList</type></link> of path elements for which the
@ -236,8 +243,8 @@ is on Windows).</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-path-to-str" role="function"/>gimp_path_to_str ()</title>
<indexterm><primary>gimp_path_to_str</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_to_str (<link linkend="GList">GList</link> *path);</programlisting>
<title><anchor id="gimp-path-to-str"/>gimp_path_to_str ()</title>
<indexterm><primary>gimp_path_to_str</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_to_str (<link linkend="GList">GList</link> *path);</programlisting>
<para>
</para>
<para>
@ -250,8 +257,8 @@ is on Windows).</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-path-free" role="function"/>gimp_path_free ()</title>
<indexterm><primary>gimp_path_free</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_free (<link linkend="GList">GList</link> *path);</programlisting>
<title><anchor id="gimp-path-free"/>gimp_path_free ()</title>
<indexterm><primary>gimp_path_free</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_free (<link linkend="GList">GList</link> *path);</programlisting>
<para>
This function frees the memory allocated for the list and the strings
it contains.</para>
@ -263,8 +270,8 @@ it contains.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-path-get-user-writable-dir" role="function"/>gimp_path_get_user_writable_dir ()</title>
<indexterm><primary>gimp_path_get_user_writable_dir</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_get_user_writable_dir (<link linkend="GList">GList</link> *path);</programlisting>
<title><anchor id="gimp-path-get-user-writable-dir"/>gimp_path_get_user_writable_dir ()</title>
<indexterm><primary>gimp_path_get_user_writable_dir</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_get_user_writable_dir (<link linkend="GList">GList</link> *path);</programlisting>
<para>
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.</para>
<para>

39
devel-docs/libgimpbase/xml/gimplimits.xml
View File

@ -4,29 +4,26 @@
<refentry id="libgimpbase-gimplimits">
<refmeta>
<refentrytitle role="top_of_page">gimplimits</refentrytitle>
<refentrytitle>gimplimits</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimplimits</refname>
<refpurpose>Boundaries of some GIMP data types and some global constants.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimplimits</refname><refpurpose>Boundaries of some GIMP data types and some global constants.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
#define <link linkend="GIMP-MIN-IMAGE-SIZE:CAPS">GIMP_MIN_IMAGE_SIZE</link>
#define <link linkend="GIMP-MAX-IMAGE-SIZE:CAPS">GIMP_MAX_IMAGE_SIZE</link>
#define <link linkend="GIMP-MIN-RESOLUTION:CAPS">GIMP_MIN_RESOLUTION</link>
#define <link linkend="GIMP-MAX-RESOLUTION:CAPS">GIMP_MAX_RESOLUTION</link>
#define <link linkend="GIMP-MAX-MEMSIZE:CAPS">GIMP_MAX_MEMSIZE</link>
#define <link linkend="GIMP-MIN-IMAGE-SIZE:CAPS">GIMP_MIN_IMAGE_SIZE</link>
#define <link linkend="GIMP-MAX-IMAGE-SIZE:CAPS">GIMP_MAX_IMAGE_SIZE</link>
#define <link linkend="GIMP-MIN-RESOLUTION:CAPS">GIMP_MIN_RESOLUTION</link>
#define <link linkend="GIMP-MAX-RESOLUTION:CAPS">GIMP_MAX_RESOLUTION</link>
#define <link linkend="GIMP-MAX-MEMSIZE:CAPS">GIMP_MAX_MEMSIZE</link>
</synopsis>
</refsynopsisdiv>
@ -38,25 +35,25 @@
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Boundaries of some GIMP data types and some global constants.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GIMP-MIN-IMAGE-SIZE:CAPS" role="macro"/>GIMP_MIN_IMAGE_SIZE</title>
<title><anchor id="GIMP-MIN-IMAGE-SIZE:CAPS"/>GIMP_MIN_IMAGE_SIZE</title>
<indexterm><primary>GIMP_MIN_IMAGE_SIZE</primary></indexterm><programlisting>#define GIMP_MIN_IMAGE_SIZE 1
</programlisting>
<para>
The minimum width and height of a GIMP image in pixels.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-MAX-IMAGE-SIZE:CAPS" role="macro"/>GIMP_MAX_IMAGE_SIZE</title>
<title><anchor id="GIMP-MAX-IMAGE-SIZE:CAPS"/>GIMP_MAX_IMAGE_SIZE</title>
<indexterm><primary>GIMP_MAX_IMAGE_SIZE</primary></indexterm><programlisting>#define GIMP_MAX_IMAGE_SIZE 262144 /* 2^18 */
</programlisting>
<para>
@ -65,7 +62,7 @@ somewhat arbitray value that can be used when an upper value for pixel
sizes is needed; for example to give a spin button an upper limit.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-MIN-RESOLUTION:CAPS" role="macro"/>GIMP_MIN_RESOLUTION</title>
<title><anchor id="GIMP-MIN-RESOLUTION:CAPS"/>GIMP_MIN_RESOLUTION</title>
<indexterm><primary>GIMP_MIN_RESOLUTION</primary></indexterm><programlisting>#define GIMP_MIN_RESOLUTION 5e-3 /* shouldn't display as 0.000 */
</programlisting>
<para>
@ -75,7 +72,7 @@ resolution is needed. GIMP will not accept resolutions smaller than
this value.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-MAX-RESOLUTION:CAPS" role="macro"/>GIMP_MAX_RESOLUTION</title>
<title><anchor id="GIMP-MAX-RESOLUTION:CAPS"/>GIMP_MAX_RESOLUTION</title>
<indexterm><primary>GIMP_MAX_RESOLUTION</primary></indexterm><programlisting>#define GIMP_MAX_RESOLUTION 65536.0
</programlisting>
<para>
@ -85,12 +82,12 @@ resolution is needed. GIMP will not accept resolutions larger than
this value.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-MAX-MEMSIZE:CAPS" role="macro"/>GIMP_MAX_MEMSIZE</title>
<title><anchor id="GIMP-MAX-MEMSIZE:CAPS"/>GIMP_MAX_MEMSIZE</title>
<indexterm><primary>GIMP_MAX_MEMSIZE</primary></indexterm><programlisting>#define GIMP_MAX_MEMSIZE ((guint64) 1 &lt;&lt; 42) /* 4 terabyte;
</programlisting>
<para>
A large but arbitrary value that can be used when an upper limit for a
memory size (in bytes) is needed. It is smaller than <link linkend="G-MAXDOUBLE:CAPS"><literal>G_MAXDOUBLE</literal></link> since
memory size (in bytes) is needed. It is smaller than <literal>G_MAXDOUBLE</literal> since
the <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link> doesn't handle larger values.
</para></refsect2>

125
devel-docs/libgimpbase/xml/gimpmemsize.xml
View File

@ -4,30 +4,36 @@
<refentry id="libgimpbase-gimpmemsize">
<refmeta>
<refentrytitle role="top_of_page">gimpmemsize</refentrytitle>
<refentrytitle>gimpmemsize</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpmemsize</refname>
<refpurpose>Functions to (de)serialize a given memory size.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpmemsize</refname><refpurpose>Functions to (de)serialize a given memory size.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="gchar">gchar</link>* <link linkend="gimp-memsize-serialize">gimp_memsize_serialize</link> (<link linkend="guint64">guint64</link> memsize);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-memsize-deserialize">gimp_memsize_deserialize</link> (const <link linkend="gchar">gchar</link> *string,
<link linkend="guint64">guint64</link> *memsize);
<link linkend="gchar">gchar</link>* <link linkend="gimp-memsize-to-string">gimp_memsize_to_string</link> (<link linkend="guint64">guint64</link> memsize);
#define <link linkend="GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</link>
#define <link linkend="GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</link> (value)
<link linkend="gchar">gchar</link>* <link linkend="gimp-memsize-serialize">gimp_memsize_serialize</link> (<link linkend="guint64">guint64</link> memsize);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-memsize-deserialize">gimp_memsize_deserialize</link> (const <link linkend="gchar">gchar</link> *string,
<link linkend="guint64">guint64</link> *memsize);
<link linkend="gchar">gchar</link>* <link linkend="gimp-memsize-to-string">gimp_memsize_to_string</link> (<link linkend="guint64">guint64</link> memsize);
#define <link linkend="GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</link>
#define <link linkend="GIMP-TYPE-PARAM-MEMSIZE:CAPS">GIMP_TYPE_PARAM_MEMSIZE</link>
#define <link linkend="GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS">GIMP_IS_PARAM_SPEC_MEMSIZE</link> (pspec)
<link linkend="GParamSpec">GParamSpec</link>* <link linkend="gimp-param-spec-memsize">gimp_param_spec_memsize</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *nick,
const <link linkend="gchar">gchar</link> *blurb,
<link linkend="guint64">guint64</link> minimum,
<link linkend="guint64">guint64</link> maximum,
<link linkend="guint64">guint64</link> default_value,
<link linkend="GParamFlags">GParamFlags</link> flags);
#define <link linkend="GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</link> (value)
</synopsis>
</refsynopsisdiv>
@ -40,18 +46,18 @@
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Functions to (de)serialize a given memory size.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gimp-memsize-serialize" role="function" condition="since:GIMP 2.2"/>gimp_memsize_serialize ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_memsize_serialize</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_memsize_serialize (<link linkend="guint64">guint64</link> memsize);</programlisting>
<title><anchor id="gimp-memsize-serialize"/>gimp_memsize_serialize ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_memsize_serialize</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_memsize_serialize (<link linkend="guint64">guint64</link> memsize);</programlisting>
<para>
Creates a string representation of a given memory size. This string
can be parsed by <link linkend="gimp-memsize-deserialize"><function>gimp_memsize_deserialize()</function></link> and can thus be used in
@ -66,12 +72,12 @@ nice human-readable string please use <link linkend="gimp-memsize-to-string"><fu
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A newly allocated string representation of <parameter>memsize</parameter>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-memsize-deserialize" role="function" condition="since:GIMP 2.2"/>gimp_memsize_deserialize ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_memsize_deserialize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_memsize_deserialize (const <link linkend="gchar">gchar</link> *string,
<link linkend="guint64">guint64</link> *memsize);</programlisting>
<title><anchor id="gimp-memsize-deserialize"/>gimp_memsize_deserialize ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_memsize_deserialize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_memsize_deserialize (const <link linkend="gchar">gchar</link> *string,
<link linkend="guint64">guint64</link> *memsize);</programlisting>
<para>
Parses a string representation of a memory size as returned by
<link linkend="gimp-memsize-serialize"><function>gimp_memsize_serialize()</function></link>.</para>
@ -84,15 +90,15 @@ Parses a string representation of a memory size as returned by
<varlistentry><term><parameter>memsize</parameter>&nbsp;:</term>
<listitem><simpara> return location for memory size in bytes
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the <parameter>string</parameter> was successfully parsed and
<parameter>memsize</parameter> has been set, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if the <parameter>string</parameter> was successfully parsed and
<parameter>memsize</parameter> has been set, <literal>FALSE</literal> otherwise.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-memsize-to-string" role="function"/>gimp_memsize_to_string ()</title>
<indexterm><primary>gimp_memsize_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_memsize_to_string (<link linkend="guint64">guint64</link> memsize);</programlisting>
<title><anchor id="gimp-memsize-to-string"/>gimp_memsize_to_string ()</title>
<indexterm><primary>gimp_memsize_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_memsize_to_string (<link linkend="guint64">guint64</link> memsize);</programlisting>
<para>
This function returns a human readable, translated representation
of the passed <parameter>memsize</parameter>. Large values are displayed using a
@ -108,14 +114,75 @@ becomes "4.4 KB" and so on.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GIMP-TYPE-MEMSIZE:CAPS" role="macro"/>GIMP_TYPE_MEMSIZE</title>
<title><anchor id="GIMP-TYPE-MEMSIZE:CAPS"/>GIMP_TYPE_MEMSIZE</title>
<indexterm><primary>GIMP_TYPE_MEMSIZE</primary></indexterm><programlisting>#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
</programlisting>
<para>
<link linkend="GIMP-TYPE-MEMSIZE:CAPS"><type>GIMP_TYPE_MEMSIZE</type></link> is a <link linkend="GType"><type>GType</type></link> derived from <link linkend="G-TYPE-UINT64:CAPS"><type>G_TYPE_UINT64</type></link>.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-VALUE-HOLDS-MEMSIZE:CAPS" role="macro"/>GIMP_VALUE_HOLDS_MEMSIZE()</title>
<title><anchor id="GIMP-TYPE-PARAM-MEMSIZE:CAPS"/>GIMP_TYPE_PARAM_MEMSIZE</title>
<indexterm><primary>GIMP_TYPE_PARAM_MEMSIZE</primary></indexterm><programlisting>#define GIMP_TYPE_PARAM_MEMSIZE (gimp_param_memsize_get_type ())
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS"/>GIMP_IS_PARAM_SPEC_MEMSIZE()</title>
<indexterm><primary>GIMP_IS_PARAM_SPEC_MEMSIZE</primary></indexterm><programlisting>#define GIMP_IS_PARAM_SPEC_MEMSIZE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_MEMSIZE))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pspec</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-param-spec-memsize"/>gimp_param_spec_memsize ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_param_spec_memsize</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link>* gimp_param_spec_memsize (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *nick,
const <link linkend="gchar">gchar</link> *blurb,
<link linkend="guint64">guint64</link> minimum,
<link linkend="guint64">guint64</link> maximum,
<link linkend="guint64">guint64</link> default_value,
<link linkend="GParamFlags">GParamFlags</link> flags);</programlisting>
<para>
Creates a param spec to hold a memory size value.
See <link linkend="g-param-spec-internal"><function>g_param_spec_internal()</function></link> for more information.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> Canonical name of the param
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nick</parameter>&nbsp;:</term>
<listitem><simpara> Nickname of the param
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>blurb</parameter>&nbsp;:</term>
<listitem><simpara> Brief desciption of param.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minimum</parameter>&nbsp;:</term>
<listitem><simpara> Smallest allowed value of the parameter.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>maximum</parameter>&nbsp;:</term>
<listitem><simpara> Largest allowed value of the parameter.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>default_value</parameter>&nbsp;:</term>
<listitem><simpara> Value to use if none is assigned.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> a combination of <link linkend="GParamFlags"><type>GParamFlags</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"/>GIMP_VALUE_HOLDS_MEMSIZE()</title>
<indexterm><primary>GIMP_VALUE_HOLDS_MEMSIZE</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
</programlisting>
<para>

149
devel-docs/libgimpbase/xml/gimpparasite.xml
View File

@ -4,51 +4,48 @@
<refentry id="libgimpbase-gimpparasite">
<refmeta>
<refentrytitle role="top_of_page">gimpparasite</refentrytitle>
<refentrytitle>gimpparasite</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpparasite</refname>
<refpurpose>Arbitrary pieces of data which can be attached to various GIMP objects.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpparasite</refname><refpurpose>Arbitrary pieces of data which can be attached to various GIMP objects.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="GimpParasite">GimpParasite</link>;
<link linkend="GimpParasite">GimpParasite</link>* <link linkend="gimp-parasite-new">gimp_parasite_new</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="guint32">guint32</link> flags,
<link linkend="guint32">guint32</link> size,
<link linkend="gconstpointer">gconstpointer</link> data);
<link linkend="void">void</link> <link linkend="gimp-parasite-free">gimp_parasite_free</link> (<link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="GimpParasite">GimpParasite</link>* <link linkend="gimp-parasite-copy">gimp_parasite_copy</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-compare">gimp_parasite_compare</link> (const <link linkend="GimpParasite">GimpParasite</link> *a,
const <link linkend="GimpParasite">GimpParasite</link> *b);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-is-type">gimp_parasite_is_type</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite,
const <link linkend="gchar">gchar</link> *name);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-is-persistent">gimp_parasite_is_persistent</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-is-undoable">gimp_parasite_is_undoable</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-has-flag">gimp_parasite_has_flag</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite,
<link linkend="gulong">gulong</link> flag);
<link linkend="gulong">gulong</link> <link linkend="gimp-parasite-flags">gimp_parasite_flags</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-parasite-name">gimp_parasite_name</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="gconstpointer">gconstpointer</link> <link linkend="gimp-parasite-data">gimp_parasite_data</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="glong">glong</link> <link linkend="gimp-parasite-data-size">gimp_parasite_data_size</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
#define <link linkend="GIMP-PARASITE-PERSISTENT:CAPS">GIMP_PARASITE_PERSISTENT</link>
#define <link linkend="GIMP-PARASITE-UNDOABLE:CAPS">GIMP_PARASITE_UNDOABLE</link>
#define <link linkend="GIMP-PARASITE-ATTACH-PARENT:CAPS">GIMP_PARASITE_ATTACH_PARENT</link>
#define <link linkend="GIMP-PARASITE-PARENT-PERSISTENT:CAPS">GIMP_PARASITE_PARENT_PERSISTENT</link>
#define <link linkend="GIMP-PARASITE-PARENT-UNDOABLE:CAPS">GIMP_PARASITE_PARENT_UNDOABLE</link>
#define <link linkend="GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS">GIMP_PARASITE_ATTACH_GRANDPARENT</link>
#define <link linkend="GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS">GIMP_PARASITE_GRANDPARENT_PERSISTENT</link>
#define <link linkend="GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS">GIMP_PARASITE_GRANDPARENT_UNDOABLE</link>
<link linkend="GimpParasite">GimpParasite</link>;
<link linkend="GimpParasite">GimpParasite</link>* <link linkend="gimp-parasite-new">gimp_parasite_new</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="guint32">guint32</link> flags,
<link linkend="guint32">guint32</link> size,
<link linkend="gconstpointer">gconstpointer</link> data);
<link linkend="void">void</link> <link linkend="gimp-parasite-free">gimp_parasite_free</link> (<link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="GimpParasite">GimpParasite</link>* <link linkend="gimp-parasite-copy">gimp_parasite_copy</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-compare">gimp_parasite_compare</link> (const <link linkend="GimpParasite">GimpParasite</link> *a,
const <link linkend="GimpParasite">GimpParasite</link> *b);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-is-type">gimp_parasite_is_type</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite,
const <link linkend="gchar">gchar</link> *name);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-is-persistent">gimp_parasite_is_persistent</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-is-undoable">gimp_parasite_is_undoable</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-parasite-has-flag">gimp_parasite_has_flag</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite,
<link linkend="gulong">gulong</link> flag);
<link linkend="gulong">gulong</link> <link linkend="gimp-parasite-flags">gimp_parasite_flags</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-parasite-name">gimp_parasite_name</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="gconstpointer">gconstpointer</link> <link linkend="gimp-parasite-data">gimp_parasite_data</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
<link linkend="glong">glong</link> <link linkend="gimp-parasite-data-size">gimp_parasite_data_size</link> (const <link linkend="GimpParasite">GimpParasite</link> *parasite);
#define <link linkend="GIMP-PARASITE-PERSISTENT:CAPS">GIMP_PARASITE_PERSISTENT</link>
#define <link linkend="GIMP-PARASITE-UNDOABLE:CAPS">GIMP_PARASITE_UNDOABLE</link>
#define <link linkend="GIMP-PARASITE-ATTACH-PARENT:CAPS">GIMP_PARASITE_ATTACH_PARENT</link>
#define <link linkend="GIMP-PARASITE-PARENT-PERSISTENT:CAPS">GIMP_PARASITE_PARENT_PERSISTENT</link>
#define <link linkend="GIMP-PARASITE-PARENT-UNDOABLE:CAPS">GIMP_PARASITE_PARENT_UNDOABLE</link>
#define <link linkend="GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS">GIMP_PARASITE_ATTACH_GRANDPARENT</link>
#define <link linkend="GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS">GIMP_PARASITE_GRANDPARENT_PERSISTENT</link>
#define <link linkend="GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS">GIMP_PARASITE_GRANDPARENT_UNDOABLE</link>
</synopsis>
</refsynopsisdiv>
@ -60,18 +57,18 @@ const <link linkend="gchar">gchar</link>* <link linkend="gimp-parasite-na
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Arbitrary pieces of data which can be attached to various GIMP objects.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpParasite" role="struct"/>GimpParasite</title>
<title><anchor id="GimpParasite"/>GimpParasite</title>
<indexterm><primary>GimpParasite</primary></indexterm><programlisting>typedef struct {
gchar *name; /* The name of the parasite. USE A UNIQUE PREFIX! */
guint32 flags; /* save Parasite in XCF file, etc. */
@ -84,11 +81,11 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</para></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-new" role="function"/>gimp_parasite_new ()</title>
<indexterm><primary>gimp_parasite_new</primary></indexterm><programlisting><link linkend="GimpParasite">GimpParasite</link>* gimp_parasite_new (const <link linkend="gchar">gchar</link> *name,
<link linkend="guint32">guint32</link> flags,
<link linkend="guint32">guint32</link> size,
<link linkend="gconstpointer">gconstpointer</link> data);</programlisting>
<title><anchor id="gimp-parasite-new"/>gimp_parasite_new ()</title>
<indexterm><primary>gimp_parasite_new</primary></indexterm><programlisting><link linkend="GimpParasite">GimpParasite</link>* gimp_parasite_new (const <link linkend="gchar">gchar</link> *name,
<link linkend="guint32">guint32</link> flags,
<link linkend="guint32">guint32</link> size,
<link linkend="gconstpointer">gconstpointer</link> data);</programlisting>
<para>
</para><variablelist role="params">
@ -110,8 +107,8 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-free" role="function"/>gimp_parasite_free ()</title>
<indexterm><primary>gimp_parasite_free</primary></indexterm><programlisting><link linkend="void">void</link> gimp_parasite_free (<link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<title><anchor id="gimp-parasite-free"/>gimp_parasite_free ()</title>
<indexterm><primary>gimp_parasite_free</primary></indexterm><programlisting><link linkend="void">void</link> gimp_parasite_free (<link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<para>
</para><variablelist role="params">
@ -122,8 +119,8 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-copy" role="function"/>gimp_parasite_copy ()</title>
<indexterm><primary>gimp_parasite_copy</primary></indexterm><programlisting><link linkend="GimpParasite">GimpParasite</link>* gimp_parasite_copy (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<title><anchor id="gimp-parasite-copy"/>gimp_parasite_copy ()</title>
<indexterm><primary>gimp_parasite_copy</primary></indexterm><programlisting><link linkend="GimpParasite">GimpParasite</link>* gimp_parasite_copy (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<para>
</para><variablelist role="params">
@ -136,9 +133,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-compare" role="function"/>gimp_parasite_compare ()</title>
<indexterm><primary>gimp_parasite_compare</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_compare (const <link linkend="GimpParasite">GimpParasite</link> *a,
const <link linkend="GimpParasite">GimpParasite</link> *b);</programlisting>
<title><anchor id="gimp-parasite-compare"/>gimp_parasite_compare ()</title>
<indexterm><primary>gimp_parasite_compare</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_compare (const <link linkend="GimpParasite">GimpParasite</link> *a,
const <link linkend="GimpParasite">GimpParasite</link> *b);</programlisting>
<para>
</para><variablelist role="params">
@ -154,9 +151,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-is-type" role="function"/>gimp_parasite_is_type ()</title>
<indexterm><primary>gimp_parasite_is_type</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_is_type (const <link linkend="GimpParasite">GimpParasite</link> *parasite,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<title><anchor id="gimp-parasite-is-type"/>gimp_parasite_is_type ()</title>
<indexterm><primary>gimp_parasite_is_type</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_is_type (const <link linkend="GimpParasite">GimpParasite</link> *parasite,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
</para><variablelist role="params">
@ -172,8 +169,8 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-is-persistent" role="function"/>gimp_parasite_is_persistent ()</title>
<indexterm><primary>gimp_parasite_is_persistent</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_is_persistent (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<title><anchor id="gimp-parasite-is-persistent"/>gimp_parasite_is_persistent ()</title>
<indexterm><primary>gimp_parasite_is_persistent</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_is_persistent (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<para>
</para><variablelist role="params">
@ -186,8 +183,8 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-is-undoable" role="function"/>gimp_parasite_is_undoable ()</title>
<indexterm><primary>gimp_parasite_is_undoable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_is_undoable (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<title><anchor id="gimp-parasite-is-undoable"/>gimp_parasite_is_undoable ()</title>
<indexterm><primary>gimp_parasite_is_undoable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_is_undoable (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<para>
</para><variablelist role="params">
@ -200,9 +197,9 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-has-flag" role="function"/>gimp_parasite_has_flag ()</title>
<indexterm><primary>gimp_parasite_has_flag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_has_flag (const <link linkend="GimpParasite">GimpParasite</link> *parasite,
<link linkend="gulong">gulong</link> flag);</programlisting>
<title><anchor id="gimp-parasite-has-flag"/>gimp_parasite_has_flag ()</title>
<indexterm><primary>gimp_parasite_has_flag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_parasite_has_flag (const <link linkend="GimpParasite">GimpParasite</link> *parasite,
<link linkend="gulong">gulong</link> flag);</programlisting>
<para>
</para><variablelist role="params">
@ -218,8 +215,8 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-flags" role="function"/>gimp_parasite_flags ()</title>
<indexterm><primary>gimp_parasite_flags</primary></indexterm><programlisting><link linkend="gulong">gulong</link> gimp_parasite_flags (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<title><anchor id="gimp-parasite-flags"/>gimp_parasite_flags ()</title>
<indexterm><primary>gimp_parasite_flags</primary></indexterm><programlisting><link linkend="gulong">gulong</link> gimp_parasite_flags (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<para>
</para><variablelist role="params">
@ -232,8 +229,8 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-name" role="function"/>gimp_parasite_name ()</title>
<indexterm><primary>gimp_parasite_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_parasite_name (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<title><anchor id="gimp-parasite-name"/>gimp_parasite_name ()</title>
<indexterm><primary>gimp_parasite_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_parasite_name (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<para>
</para><variablelist role="params">
@ -246,8 +243,8 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-data" role="function"/>gimp_parasite_data ()</title>
<indexterm><primary>gimp_parasite_data</primary></indexterm><programlisting><link linkend="gconstpointer">gconstpointer</link> gimp_parasite_data (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<title><anchor id="gimp-parasite-data"/>gimp_parasite_data ()</title>
<indexterm><primary>gimp_parasite_data</primary></indexterm><programlisting><link linkend="gconstpointer">gconstpointer</link> gimp_parasite_data (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<para>
</para><variablelist role="params">
@ -260,8 +257,8 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-parasite-data-size" role="function"/>gimp_parasite_data_size ()</title>
<indexterm><primary>gimp_parasite_data_size</primary></indexterm><programlisting><link linkend="glong">glong</link> gimp_parasite_data_size (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<title><anchor id="gimp-parasite-data-size"/>gimp_parasite_data_size ()</title>
<indexterm><primary>gimp_parasite_data_size</primary></indexterm><programlisting><link linkend="glong">glong</link> gimp_parasite_data_size (const <link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
<para>
</para><variablelist role="params">
@ -274,56 +271,56 @@ Arbitrary pieces of data which can be attached to various GIMP objects.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GIMP-PARASITE-PERSISTENT:CAPS" role="macro"/>GIMP_PARASITE_PERSISTENT</title>
<title><anchor id="GIMP-PARASITE-PERSISTENT:CAPS"/>GIMP_PARASITE_PERSISTENT</title>
<indexterm><primary>GIMP_PARASITE_PERSISTENT</primary></indexterm><programlisting>#define GIMP_PARASITE_PERSISTENT 1
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-PARASITE-UNDOABLE:CAPS" role="macro"/>GIMP_PARASITE_UNDOABLE</title>
<title><anchor id="GIMP-PARASITE-UNDOABLE:CAPS"/>GIMP_PARASITE_UNDOABLE</title>
<indexterm><primary>GIMP_PARASITE_UNDOABLE</primary></indexterm><programlisting>#define GIMP_PARASITE_UNDOABLE 2
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-PARASITE-ATTACH-PARENT:CAPS" role="macro"/>GIMP_PARASITE_ATTACH_PARENT</title>
<title><anchor id="GIMP-PARASITE-ATTACH-PARENT:CAPS"/>GIMP_PARASITE_ATTACH_PARENT</title>
<indexterm><primary>GIMP_PARASITE_ATTACH_PARENT</primary></indexterm><programlisting>#define GIMP_PARASITE_ATTACH_PARENT (0x80 &lt;&lt; 8)
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-PARASITE-PARENT-PERSISTENT:CAPS" role="macro"/>GIMP_PARASITE_PARENT_PERSISTENT</title>
<title><anchor id="GIMP-PARASITE-PARENT-PERSISTENT:CAPS"/>GIMP_PARASITE_PARENT_PERSISTENT</title>
<indexterm><primary>GIMP_PARASITE_PARENT_PERSISTENT</primary></indexterm><programlisting>#define GIMP_PARASITE_PARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT &lt;&lt; 8)
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-PARASITE-PARENT-UNDOABLE:CAPS" role="macro"/>GIMP_PARASITE_PARENT_UNDOABLE</title>
<title><anchor id="GIMP-PARASITE-PARENT-UNDOABLE:CAPS"/>GIMP_PARASITE_PARENT_UNDOABLE</title>
<indexterm><primary>GIMP_PARASITE_PARENT_UNDOABLE</primary></indexterm><programlisting>#define GIMP_PARASITE_PARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE &lt;&lt; 8)
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS" role="macro"/>GIMP_PARASITE_ATTACH_GRANDPARENT</title>
<title><anchor id="GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS"/>GIMP_PARASITE_ATTACH_GRANDPARENT</title>
<indexterm><primary>GIMP_PARASITE_ATTACH_GRANDPARENT</primary></indexterm><programlisting>#define GIMP_PARASITE_ATTACH_GRANDPARENT (0x80 &lt;&lt; 16)
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS" role="macro"/>GIMP_PARASITE_GRANDPARENT_PERSISTENT</title>
<title><anchor id="GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS"/>GIMP_PARASITE_GRANDPARENT_PERSISTENT</title>
<indexterm><primary>GIMP_PARASITE_GRANDPARENT_PERSISTENT</primary></indexterm><programlisting>#define GIMP_PARASITE_GRANDPARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT &lt;&lt; 16)
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS" role="macro"/>GIMP_PARASITE_GRANDPARENT_UNDOABLE</title>
<title><anchor id="GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS"/>GIMP_PARASITE_GRANDPARENT_UNDOABLE</title>
<indexterm><primary>GIMP_PARASITE_GRANDPARENT_UNDOABLE</primary></indexterm><programlisting>#define GIMP_PARASITE_GRANDPARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE &lt;&lt; 16)
</programlisting>
<para>

43
devel-docs/libgimpbase/xml/gimpparasiteio.xml
View File

@ -4,29 +4,26 @@
<refentry id="libgimpbase-gimpparasiteio">
<refmeta>
<refentrytitle role="top_of_page">gimpparasiteio</refentrytitle>
<refentrytitle>gimpparasiteio</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpparasiteio</refname>
<refpurpose>Utility functions to (de)serialize certain C structures to/from <link linkend="GimpParasite"><type>GimpParasite</type></link>'s.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpparasiteio</refname><refpurpose>Utility functions to (de)serialize certain C structures to/from <link linkend="GimpParasite"><type>GimpParasite</type></link>'s.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
#define <link linkend="GIMP-PIXPIPE-MAXDIM:CAPS">GIMP_PIXPIPE_MAXDIM</link>
<link linkend="void">void</link> <link linkend="gimp-pixpipe-params-init">gimp_pixpipe_params_init</link> (<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);
<link linkend="void">void</link> <link linkend="gimp-pixpipe-params-parse">gimp_pixpipe_params_parse</link> (const <link linkend="gchar">gchar</link> *parameters,
<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);
<link linkend="gchar">gchar</link>* <link linkend="gimp-pixpipe-params-build">gimp_pixpipe_params_build</link> (<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);
#define <link linkend="GIMP-PIXPIPE-MAXDIM:CAPS">GIMP_PIXPIPE_MAXDIM</link>
<link linkend="void">void</link> <link linkend="gimp-pixpipe-params-init">gimp_pixpipe_params_init</link> (<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);
<link linkend="void">void</link> <link linkend="gimp-pixpipe-params-parse">gimp_pixpipe_params_parse</link> (const <link linkend="gchar">gchar</link> *parameters,
<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);
<link linkend="gchar">gchar</link>* <link linkend="gimp-pixpipe-params-build">gimp_pixpipe_params_build</link> (<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);
</synopsis>
</refsynopsisdiv>
@ -38,26 +35,26 @@
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Utility functions to (de)serialize certain C structures to/from <link linkend="GimpParasite"><type>GimpParasite</type></link>'s.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GIMP-PIXPIPE-MAXDIM:CAPS" role="macro"/>GIMP_PIXPIPE_MAXDIM</title>
<title><anchor id="GIMP-PIXPIPE-MAXDIM:CAPS"/>GIMP_PIXPIPE_MAXDIM</title>
<indexterm><primary>GIMP_PIXPIPE_MAXDIM</primary></indexterm><programlisting>#define GIMP_PIXPIPE_MAXDIM 4
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-pixpipe-params-init" role="function"/>gimp_pixpipe_params_init ()</title>
<indexterm><primary>gimp_pixpipe_params_init</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixpipe_params_init (<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);</programlisting>
<title><anchor id="gimp-pixpipe-params-init"/>gimp_pixpipe_params_init ()</title>
<indexterm><primary>gimp_pixpipe_params_init</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixpipe_params_init (<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);</programlisting>
<para>
</para><variablelist role="params">
@ -68,9 +65,9 @@ Utility functions to (de)serialize certain C structures to/from <link linkend="G
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pixpipe-params-parse" role="function"/>gimp_pixpipe_params_parse ()</title>
<indexterm><primary>gimp_pixpipe_params_parse</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixpipe_params_parse (const <link linkend="gchar">gchar</link> *parameters,
<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);</programlisting>
<title><anchor id="gimp-pixpipe-params-parse"/>gimp_pixpipe_params_parse ()</title>
<indexterm><primary>gimp_pixpipe_params_parse</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixpipe_params_parse (const <link linkend="gchar">gchar</link> *parameters,
<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);</programlisting>
<para>
</para><variablelist role="params">
@ -84,8 +81,8 @@ Utility functions to (de)serialize certain C structures to/from <link linkend="G
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pixpipe-params-build" role="function"/>gimp_pixpipe_params_build ()</title>
<indexterm><primary>gimp_pixpipe_params_build</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_pixpipe_params_build (<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);</programlisting>
<title><anchor id="gimp-pixpipe-params-build"/>gimp_pixpipe_params_build ()</title>
<indexterm><primary>gimp_pixpipe_params_build</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_pixpipe_params_build (<link linkend="GimpPixPipeParams">GimpPixPipeParams</link> *params);</programlisting>
<para>
</para><variablelist role="params">

233
devel-docs/libgimpbase/xml/gimpprotocol.xml
View File

@ -4,71 +4,68 @@
<refentry id="libgimpbase-gimpprotocol">
<refmeta>
<refentrytitle role="top_of_page">gimpprotocol</refentrytitle>
<refentrytitle>gimpprotocol</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpprotocol</refname>
<refpurpose>The communication protocol between GIMP and it's plug-ins.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpprotocol</refname><refpurpose>The communication protocol between GIMP and it's plug-ins.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
#define <link linkend="GIMP-PROTOCOL-VERSION:CAPS">GIMP_PROTOCOL_VERSION</link>
<link linkend="GPConfig">GPConfig</link>;
<link linkend="GPTileReq">GPTileReq</link>;
<link linkend="GPTileAck">GPTileAck</link>;
<link linkend="GPTileData">GPTileData</link>;
<link linkend="GPParam">GPParam</link>;
<link linkend="GPParamDef">GPParamDef</link>;
<link linkend="GPProcRun">GPProcRun</link>;
<link linkend="GPProcReturn">GPProcReturn</link>;
<link linkend="GPProcInstall">GPProcInstall</link>;
<link linkend="GPProcUninstall">GPProcUninstall</link>;
<link linkend="void">void</link> <link linkend="gp-init">gp_init</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="gp-has-init-write">gp_has_init_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-quit-write">gp_quit_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-config-write">gp_config_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPConfig">GPConfig</link> *config,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-tile-req-write">gp_tile_req_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPTileReq">GPTileReq</link> *tile_req,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-tile-ack-write">gp_tile_ack_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-tile-data-write">gp_tile_data_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPTileData">GPTileData</link> *tile_data,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-proc-run-write">gp_proc_run_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcRun">GPProcRun</link> *proc_run,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-proc-return-write">gp_proc_return_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcReturn">GPProcReturn</link> *proc_return,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-temp-proc-run-write">gp_temp_proc_run_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcRun">GPProcRun</link> *proc_run,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-temp-proc-return-write">gp_temp_proc_return_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcReturn">GPProcReturn</link> *proc_return,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-proc-install-write">gp_proc_install_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcInstall">GPProcInstall</link> *proc_install,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-proc-uninstall-write">gp_proc_uninstall_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcUninstall">GPProcUninstall</link> *proc_uninstall,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-extension-ack-write">gp_extension_ack_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
#define <link linkend="GIMP-PROTOCOL-VERSION:CAPS">GIMP_PROTOCOL_VERSION</link>
<link linkend="GPConfig">GPConfig</link>;
<link linkend="GPTileReq">GPTileReq</link>;
<link linkend="GPTileAck">GPTileAck</link>;
<link linkend="GPTileData">GPTileData</link>;
<link linkend="GPParam">GPParam</link>;
<link linkend="GPParamDef">GPParamDef</link>;
<link linkend="GPProcRun">GPProcRun</link>;
<link linkend="GPProcReturn">GPProcReturn</link>;
<link linkend="GPProcInstall">GPProcInstall</link>;
<link linkend="GPProcUninstall">GPProcUninstall</link>;
<link linkend="void">void</link> <link linkend="gp-init">gp_init</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="gp-has-init-write">gp_has_init_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-quit-write">gp_quit_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-config-write">gp_config_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPConfig">GPConfig</link> *config,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-tile-req-write">gp_tile_req_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPTileReq">GPTileReq</link> *tile_req,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-tile-ack-write">gp_tile_ack_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-tile-data-write">gp_tile_data_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPTileData">GPTileData</link> *tile_data,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-proc-run-write">gp_proc_run_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcRun">GPProcRun</link> *proc_run,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-proc-return-write">gp_proc_return_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcReturn">GPProcReturn</link> *proc_return,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-temp-proc-run-write">gp_temp_proc_run_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcRun">GPProcRun</link> *proc_run,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-temp-proc-return-write">gp_temp_proc_return_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcReturn">GPProcReturn</link> *proc_return,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-proc-install-write">gp_proc_install_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcInstall">GPProcInstall</link> *proc_install,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-proc-uninstall-write">gp_proc_uninstall_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcUninstall">GPProcUninstall</link> *proc_uninstall,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="gp-extension-ack-write">gp_extension_ack_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsynopsisdiv>
@ -80,25 +77,25 @@
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
The communication protocol between GIMP and it's plug-ins.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GIMP-PROTOCOL-VERSION:CAPS" role="macro"/>GIMP_PROTOCOL_VERSION</title>
<title><anchor id="GIMP-PROTOCOL-VERSION:CAPS"/>GIMP_PROTOCOL_VERSION</title>
<indexterm><primary>GIMP_PROTOCOL_VERSION</primary></indexterm><programlisting>#define GIMP_PROTOCOL_VERSION 0x0011
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GPConfig" role="struct"/>GPConfig</title>
<title><anchor id="GPConfig"/>GPConfig</title>
<indexterm><primary>GPConfig</primary></indexterm><programlisting>typedef struct {
guint32 version;
guint32 tile_width;
@ -126,7 +123,7 @@ The communication protocol between GIMP and it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="GPTileReq" role="struct"/>GPTileReq</title>
<title><anchor id="GPTileReq"/>GPTileReq</title>
<indexterm><primary>GPTileReq</primary></indexterm><programlisting>typedef struct {
gint32 drawable_ID;
guint32 tile_num;
@ -137,13 +134,13 @@ The communication protocol between GIMP and it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="GPTileAck" role="struct"/>GPTileAck</title>
<title><anchor id="GPTileAck"/>GPTileAck</title>
<indexterm><primary>GPTileAck</primary></indexterm><programlisting>typedef struct _GPTileAck GPTileAck;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GPTileData" role="struct"/>GPTileData</title>
<title><anchor id="GPTileData"/>GPTileData</title>
<indexterm><primary>GPTileData</primary></indexterm><programlisting>typedef struct {
gint32 drawable_ID;
guint32 tile_num;
@ -159,7 +156,7 @@ The communication protocol between GIMP and it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="GPParam" role="struct"/>GPParam</title>
<title><anchor id="GPParam"/>GPParam</title>
<indexterm><primary>GPParam</primary></indexterm><programlisting>typedef struct {
guint32 type;
@ -206,7 +203,7 @@ The communication protocol between GIMP and it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="GPParamDef" role="struct"/>GPParamDef</title>
<title><anchor id="GPParamDef"/>GPParamDef</title>
<indexterm><primary>GPParamDef</primary></indexterm><programlisting>typedef struct {
guint32 type;
gchar *name;
@ -217,7 +214,7 @@ The communication protocol between GIMP and it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="GPProcRun" role="struct"/>GPProcRun</title>
<title><anchor id="GPProcRun"/>GPProcRun</title>
<indexterm><primary>GPProcRun</primary></indexterm><programlisting>typedef struct {
gchar *name;
guint32 nparams;
@ -228,7 +225,7 @@ The communication protocol between GIMP and it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="GPProcReturn" role="struct"/>GPProcReturn</title>
<title><anchor id="GPProcReturn"/>GPProcReturn</title>
<indexterm><primary>GPProcReturn</primary></indexterm><programlisting>typedef struct {
gchar *name;
guint32 nparams;
@ -239,7 +236,7 @@ The communication protocol between GIMP and it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="GPProcInstall" role="struct"/>GPProcInstall</title>
<title><anchor id="GPProcInstall"/>GPProcInstall</title>
<indexterm><primary>GPProcInstall</primary></indexterm><programlisting>typedef struct {
gchar *name;
gchar *blurb;
@ -260,7 +257,7 @@ The communication protocol between GIMP and it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="GPProcUninstall" role="struct"/>GPProcUninstall</title>
<title><anchor id="GPProcUninstall"/>GPProcUninstall</title>
<indexterm><primary>GPProcUninstall</primary></indexterm><programlisting>typedef struct {
gchar *name;
} GPProcUninstall;
@ -269,15 +266,15 @@ The communication protocol between GIMP and it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="gp-init" role="function"/>gp_init ()</title>
<indexterm><primary>gp_init</primary></indexterm><programlisting><link linkend="void">void</link> gp_init (void);</programlisting>
<title><anchor id="gp-init"/>gp_init ()</title>
<indexterm><primary>gp_init</primary></indexterm><programlisting><link linkend="void">void</link> gp_init (void);</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gp-has-init-write" role="function"/>gp_has_init_write ()</title>
<indexterm><primary>gp_has_init_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_has_init_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-has-init-write"/>gp_has_init_write ()</title>
<indexterm><primary>gp_has_init_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_has_init_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -293,9 +290,9 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-quit-write" role="function"/>gp_quit_write ()</title>
<indexterm><primary>gp_quit_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_quit_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-quit-write"/>gp_quit_write ()</title>
<indexterm><primary>gp_quit_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_quit_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -311,10 +308,10 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-config-write" role="function"/>gp_config_write ()</title>
<indexterm><primary>gp_config_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_config_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPConfig">GPConfig</link> *config,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-config-write"/>gp_config_write ()</title>
<indexterm><primary>gp_config_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_config_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPConfig">GPConfig</link> *config,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -333,10 +330,10 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-tile-req-write" role="function"/>gp_tile_req_write ()</title>
<indexterm><primary>gp_tile_req_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_tile_req_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPTileReq">GPTileReq</link> *tile_req,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-tile-req-write"/>gp_tile_req_write ()</title>
<indexterm><primary>gp_tile_req_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_tile_req_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPTileReq">GPTileReq</link> *tile_req,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -355,9 +352,9 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-tile-ack-write" role="function"/>gp_tile_ack_write ()</title>
<indexterm><primary>gp_tile_ack_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_tile_ack_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-tile-ack-write"/>gp_tile_ack_write ()</title>
<indexterm><primary>gp_tile_ack_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_tile_ack_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -373,10 +370,10 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-tile-data-write" role="function"/>gp_tile_data_write ()</title>
<indexterm><primary>gp_tile_data_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_tile_data_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPTileData">GPTileData</link> *tile_data,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-tile-data-write"/>gp_tile_data_write ()</title>
<indexterm><primary>gp_tile_data_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_tile_data_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPTileData">GPTileData</link> *tile_data,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -395,10 +392,10 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-proc-run-write" role="function"/>gp_proc_run_write ()</title>
<indexterm><primary>gp_proc_run_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_proc_run_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcRun">GPProcRun</link> *proc_run,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-proc-run-write"/>gp_proc_run_write ()</title>
<indexterm><primary>gp_proc_run_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_proc_run_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcRun">GPProcRun</link> *proc_run,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -417,10 +414,10 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-proc-return-write" role="function"/>gp_proc_return_write ()</title>
<indexterm><primary>gp_proc_return_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_proc_return_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcReturn">GPProcReturn</link> *proc_return,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-proc-return-write"/>gp_proc_return_write ()</title>
<indexterm><primary>gp_proc_return_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_proc_return_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcReturn">GPProcReturn</link> *proc_return,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -439,10 +436,10 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-temp-proc-run-write" role="function"/>gp_temp_proc_run_write ()</title>
<indexterm><primary>gp_temp_proc_run_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_temp_proc_run_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcRun">GPProcRun</link> *proc_run,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-temp-proc-run-write"/>gp_temp_proc_run_write ()</title>
<indexterm><primary>gp_temp_proc_run_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_temp_proc_run_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcRun">GPProcRun</link> *proc_run,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -461,10 +458,10 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-temp-proc-return-write" role="function"/>gp_temp_proc_return_write ()</title>
<indexterm><primary>gp_temp_proc_return_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_temp_proc_return_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcReturn">GPProcReturn</link> *proc_return,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-temp-proc-return-write"/>gp_temp_proc_return_write ()</title>
<indexterm><primary>gp_temp_proc_return_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_temp_proc_return_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcReturn">GPProcReturn</link> *proc_return,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -483,10 +480,10 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-proc-install-write" role="function"/>gp_proc_install_write ()</title>
<indexterm><primary>gp_proc_install_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_proc_install_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcInstall">GPProcInstall</link> *proc_install,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-proc-install-write"/>gp_proc_install_write ()</title>
<indexterm><primary>gp_proc_install_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_proc_install_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcInstall">GPProcInstall</link> *proc_install,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -505,10 +502,10 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-proc-uninstall-write" role="function"/>gp_proc_uninstall_write ()</title>
<indexterm><primary>gp_proc_uninstall_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_proc_uninstall_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcUninstall">GPProcUninstall</link> *proc_uninstall,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-proc-uninstall-write"/>gp_proc_uninstall_write ()</title>
<indexterm><primary>gp_proc_uninstall_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_proc_uninstall_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="GPProcUninstall">GPProcUninstall</link> *proc_uninstall,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -527,9 +524,9 @@ The communication protocol between GIMP and it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gp-extension-ack-write" role="function"/>gp_extension_ack_write ()</title>
<indexterm><primary>gp_extension_ack_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_extension_ack_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="gp-extension-ack-write"/>gp_extension_ack_write ()</title>
<indexterm><primary>gp_extension_ack_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gp_extension_ack_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">

37
devel-docs/libgimpbase/xml/gimpsignal.xml
View File

@ -4,28 +4,25 @@
<refentry id="libgimpbase-gimpsignal">
<refmeta>
<refentrytitle role="top_of_page">gimpsignal</refentrytitle>
<refentrytitle>gimpsignal</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpsignal</refname>
<refpurpose>Portable signal handling.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimpsignal</refname><refpurpose>Portable signal handling.</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="void">void</link> (<link linkend="GimpSignalHandlerFunc">*GimpSignalHandlerFunc</link>) (<link linkend="gint">gint</link> signum);
<link linkend="GimpSignalHandlerFunc">GimpSignalHandlerFunc</link> <link linkend="gimp-signal-private">gimp_signal_private</link> (<link linkend="gint">gint</link> signum,
<link linkend="GimpSignalHandlerFunc">GimpSignalHandlerFunc</link> handler,
<link linkend="gint">gint</link> flags);
<link linkend="void">void</link> (<link linkend="GimpSignalHandlerFunc">*GimpSignalHandlerFunc</link>) (<link linkend="gint">gint</link> signum);
<link linkend="GimpSignalHandlerFunc">GimpSignalHandlerFunc</link> <link linkend="gimp-signal-private">gimp_signal_private</link> (<link linkend="gint">gint</link> signum,
<link linkend="GimpSignalHandlerFunc">GimpSignalHandlerFunc</link> handler,
<link linkend="gint">gint</link> flags);
</synopsis>
</refsynopsisdiv>
@ -37,19 +34,19 @@
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Portable signal handling.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpSignalHandlerFunc" role="function"/>GimpSignalHandlerFunc ()</title>
<indexterm><primary>GimpSignalHandlerFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpSignalHandlerFunc) (<link linkend="gint">gint</link> signum);</programlisting>
<title><anchor id="GimpSignalHandlerFunc"/>GimpSignalHandlerFunc ()</title>
<indexterm><primary>GimpSignalHandlerFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpSignalHandlerFunc) (<link linkend="gint">gint</link> signum);</programlisting>
<para>
A prototype for signal handler functions. Note that each function which
takes or returns a variable of this type also accepts or may return
@ -64,10 +61,10 @@ special values defined by your system's signal.h header file (like
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-signal-private" role="function"/>gimp_signal_private ()</title>
<indexterm><primary>gimp_signal_private</primary></indexterm><programlisting><link linkend="GimpSignalHandlerFunc">GimpSignalHandlerFunc</link> gimp_signal_private (<link linkend="gint">gint</link> signum,
<link linkend="GimpSignalHandlerFunc">GimpSignalHandlerFunc</link> handler,
<link linkend="gint">gint</link> flags);</programlisting>
<title><anchor id="gimp-signal-private"/>gimp_signal_private ()</title>
<indexterm><primary>gimp_signal_private</primary></indexterm><programlisting><link linkend="GimpSignalHandlerFunc">GimpSignalHandlerFunc</link> gimp_signal_private (<link linkend="gint">gint</link> signum,
<link linkend="GimpSignalHandlerFunc">GimpSignalHandlerFunc</link> handler,
<link linkend="gint">gint</link> flags);</programlisting>
<para>
This function furnishes a workalike for signal(2) but
which internally invokes sigaction(2) after certain

207
devel-docs/libgimpbase/xml/gimpunit.xml
View File

@ -4,48 +4,54 @@
<refentry id="libgimpbase-gimpunit">
<refmeta>
<refentrytitle role="top_of_page">gimpunit</refentrytitle>
<refentrytitle>gimpunit</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpunit</refname>
<refpurpose>Provides a collection of predefined units and functions for creating
<refname>gimpunit</refname><refpurpose>Provides a collection of predefined units and functions for creating
user-defined units.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
enum <link linkend="GimpUnit">GimpUnit</link>;
<link linkend="gint">gint</link> <link linkend="gimp-unit-get-number-of-units">gimp_unit_get_number_of_units</link> (void);
<link linkend="gint">gint</link> <link linkend="gimp-unit-get-number-of-built-in-units">gimp_unit_get_number_of_built_in_units</link>
(void);
<link linkend="GimpUnit">GimpUnit</link> <link linkend="gimp-unit-new">gimp_unit_new</link> (<link linkend="gchar">gchar</link> *identifier,
<link linkend="gdouble">gdouble</link> factor,
<link linkend="gint">gint</link> digits,
<link linkend="gchar">gchar</link> *symbol,
<link linkend="gchar">gchar</link> *abbreviation,
<link linkend="gchar">gchar</link> *singular,
<link linkend="gchar">gchar</link> *plural);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-unit-get-deletion-flag">gimp_unit_get_deletion_flag</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
<link linkend="void">void</link> <link linkend="gimp-unit-set-deletion-flag">gimp_unit_set_deletion_flag</link> (<link linkend="GimpUnit">GimpUnit</link> unit,
<link linkend="gboolean">gboolean</link> deletion_flag);
<link linkend="gdouble">gdouble</link> <link linkend="gimp-unit-get-factor">gimp_unit_get_factor</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
<link linkend="gint">gint</link> <link linkend="gimp-unit-get-digits">gimp_unit_get_digits</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-identifier">gimp_unit_get_identifier</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-symbol">gimp_unit_get_symbol</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-abbreviation">gimp_unit_get_abbreviation</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-singular">gimp_unit_get_singular</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-plural">gimp_unit_get_plural</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
#define <link linkend="GIMP-TYPE-UNIT:CAPS">GIMP_TYPE_UNIT</link>
#define <link linkend="GIMP-VALUE-HOLDS-UNIT:CAPS">GIMP_VALUE_HOLDS_UNIT</link> (value)
enum <link linkend="GimpUnit">GimpUnit</link>;
<link linkend="gint">gint</link> <link linkend="gimp-unit-get-number-of-units">gimp_unit_get_number_of_units</link> (void);
<link linkend="gint">gint</link> <link linkend="gimp-unit-get-number-of-built-in-units">gimp_unit_get_number_of_built_in_units</link>
(void);
<link linkend="GimpUnit">GimpUnit</link> <link linkend="gimp-unit-new">gimp_unit_new</link> (<link linkend="gchar">gchar</link> *identifier,
<link linkend="gdouble">gdouble</link> factor,
<link linkend="gint">gint</link> digits,
<link linkend="gchar">gchar</link> *symbol,
<link linkend="gchar">gchar</link> *abbreviation,
<link linkend="gchar">gchar</link> *singular,
<link linkend="gchar">gchar</link> *plural);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-unit-get-deletion-flag">gimp_unit_get_deletion_flag</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
<link linkend="void">void</link> <link linkend="gimp-unit-set-deletion-flag">gimp_unit_set_deletion_flag</link> (<link linkend="GimpUnit">GimpUnit</link> unit,
<link linkend="gboolean">gboolean</link> deletion_flag);
<link linkend="gdouble">gdouble</link> <link linkend="gimp-unit-get-factor">gimp_unit_get_factor</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
<link linkend="gint">gint</link> <link linkend="gimp-unit-get-digits">gimp_unit_get_digits</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-identifier">gimp_unit_get_identifier</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-symbol">gimp_unit_get_symbol</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-abbreviation">gimp_unit_get_abbreviation</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-singular">gimp_unit_get_singular</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-plural">gimp_unit_get_plural</link> (<link linkend="GimpUnit">GimpUnit</link> unit);
#define <link linkend="GIMP-TYPE-UNIT:CAPS">GIMP_TYPE_UNIT</link>
#define <link linkend="GIMP-TYPE-PARAM-UNIT:CAPS">GIMP_TYPE_PARAM_UNIT</link>
#define <link linkend="GIMP-IS-PARAM-SPEC-UNIT:CAPS">GIMP_IS_PARAM_SPEC_UNIT</link> (pspec)
<link linkend="GParamSpec">GParamSpec</link>* <link linkend="gimp-param-spec-unit">gimp_param_spec_unit</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *nick,
const <link linkend="gchar">gchar</link> *blurb,
<link linkend="gboolean">gboolean</link> allow_pixels,
<link linkend="gboolean">gboolean</link> allow_percent,
<link linkend="GimpUnit">GimpUnit</link> default_value,
<link linkend="GParamFlags">GParamFlags</link> flags);
#define <link linkend="GIMP-VALUE-HOLDS-UNIT:CAPS">GIMP_VALUE_HOLDS_UNIT</link> (value)
</synopsis>
</refsynopsisdiv>
@ -58,8 +64,8 @@ const <link linkend="gchar">gchar</link>* <link linkend="gimp-unit-get-pl
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Provides a collection of predefined units and functions for creating
user-defined units.
@ -67,10 +73,10 @@ user-defined units.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpUnit" role="enum"/>enum GimpUnit</title>
<title><anchor id="GimpUnit"/>enum GimpUnit</title>
<indexterm><primary>GimpUnit</primary></indexterm><programlisting>typedef enum /*&lt; skip &gt;*/
{
GIMP_UNIT_PIXEL = 0,
@ -89,8 +95,8 @@ user-defined units.
</para></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-number-of-units" role="function"/>gimp_unit_get_number_of_units ()</title>
<indexterm><primary>gimp_unit_get_number_of_units</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_unit_get_number_of_units (void);</programlisting>
<title><anchor id="gimp-unit-get-number-of-units"/>gimp_unit_get_number_of_units ()</title>
<indexterm><primary>gimp_unit_get_number_of_units</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_unit_get_number_of_units (void);</programlisting>
<para>
Returns the number of units which are known to the <link linkend="GimpUnit"><type>GimpUnit</type></link> system.</para>
<para>
@ -100,9 +106,9 @@ Returns the number of units which are known to the <link linkend="GimpUnit"><typ
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-number-of-built-in-units" role="function"/>gimp_unit_get_number_of_built_in_units ()</title>
<indexterm><primary>gimp_unit_get_number_of_built_in_units</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_unit_get_number_of_built_in_units
(void);</programlisting>
<title><anchor id="gimp-unit-get-number-of-built-in-units"/>gimp_unit_get_number_of_built_in_units ()</title>
<indexterm><primary>gimp_unit_get_number_of_built_in_units</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_unit_get_number_of_built_in_units
(void);</programlisting>
<para>
Returns the number of <link linkend="GimpUnit"><type>GimpUnit</type></link>'s which are hardcoded in the unit system
(UNIT_INCH, UNIT_MM, UNIT_POINT, UNIT_PICA and the two "pseudo unit"
@ -114,20 +120,20 @@ Returns the number of <link linkend="GimpUnit"><type>GimpUnit</type></link>'s wh
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-new" role="function"/>gimp_unit_new ()</title>
<indexterm><primary>gimp_unit_new</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link> gimp_unit_new (<link linkend="gchar">gchar</link> *identifier,
<link linkend="gdouble">gdouble</link> factor,
<link linkend="gint">gint</link> digits,
<link linkend="gchar">gchar</link> *symbol,
<link linkend="gchar">gchar</link> *abbreviation,
<link linkend="gchar">gchar</link> *singular,
<link linkend="gchar">gchar</link> *plural);</programlisting>
<title><anchor id="gimp-unit-new"/>gimp_unit_new ()</title>
<indexterm><primary>gimp_unit_new</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link> gimp_unit_new (<link linkend="gchar">gchar</link> *identifier,
<link linkend="gdouble">gdouble</link> factor,
<link linkend="gint">gint</link> digits,
<link linkend="gchar">gchar</link> *symbol,
<link linkend="gchar">gchar</link> *abbreviation,
<link linkend="gchar">gchar</link> *singular,
<link linkend="gchar">gchar</link> *plural);</programlisting>
<para>
Returns the integer ID of the new <link linkend="GimpUnit"><type>GimpUnit</type></link>.
</para>
<para>
Note that a new unit is always created with it's deletion flag
set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. You will have to set it to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with
set to <literal>TRUE</literal>. You will have to set it to <literal>FALSE</literal> with
<link linkend="gimp-unit-set-deletion-flag"><function>gimp_unit_set_deletion_flag()</function></link> to make the unit definition persistent.</para>
<para>
@ -157,8 +163,8 @@ set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. You will have t
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-deletion-flag" role="function"/>gimp_unit_get_deletion_flag ()</title>
<indexterm><primary>gimp_unit_get_deletion_flag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_unit_get_deletion_flag (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<title><anchor id="gimp-unit-get-deletion-flag"/>gimp_unit_get_deletion_flag ()</title>
<indexterm><primary>gimp_unit_get_deletion_flag</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_unit_get_deletion_flag (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<para>
</para>
<para>
@ -171,12 +177,12 @@ set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. You will have t
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-set-deletion-flag" role="function"/>gimp_unit_set_deletion_flag ()</title>
<indexterm><primary>gimp_unit_set_deletion_flag</primary></indexterm><programlisting><link linkend="void">void</link> gimp_unit_set_deletion_flag (<link linkend="GimpUnit">GimpUnit</link> unit,
<link linkend="gboolean">gboolean</link> deletion_flag);</programlisting>
<title><anchor id="gimp-unit-set-deletion-flag"/>gimp_unit_set_deletion_flag ()</title>
<indexterm><primary>gimp_unit_set_deletion_flag</primary></indexterm><programlisting><link linkend="void">void</link> gimp_unit_set_deletion_flag (<link linkend="GimpUnit">GimpUnit</link> unit,
<link linkend="gboolean">gboolean</link> deletion_flag);</programlisting>
<para>
Sets a <link linkend="GimpUnit"><type>GimpUnit</type></link>'s <parameter>deletion_flag</parameter>. If the <parameter>deletion_flag</parameter> of a unit is
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> when GIMP exits, this unit will not be saved in the users's
<literal>TRUE</literal> when GIMP exits, this unit will not be saved in the users's
"unitrc" file.
</para>
<para>
@ -193,8 +199,8 @@ ignored.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-factor" role="function"/>gimp_unit_get_factor ()</title>
<indexterm><primary>gimp_unit_get_factor</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_unit_get_factor (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<title><anchor id="gimp-unit-get-factor"/>gimp_unit_get_factor ()</title>
<indexterm><primary>gimp_unit_get_factor</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_unit_get_factor (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<para>
A <link linkend="GimpUnit"><type>GimpUnit</type></link>'s <parameter>factor</parameter> is defined to be:
</para>
@ -213,8 +219,8 @@ Returns 0 for <parameter>unit</parameter> == GIMP_UNIT_PIXEL.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-digits" role="function"/>gimp_unit_get_digits ()</title>
<indexterm><primary>gimp_unit_get_digits</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_unit_get_digits (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<title><anchor id="gimp-unit-get-digits"/>gimp_unit_get_digits ()</title>
<indexterm><primary>gimp_unit_get_digits</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_unit_get_digits (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<para>
Returns the number of digits an entry field should provide to get
approximately the same accuracy as an inch input field with two digits.
@ -231,8 +237,8 @@ Returns 0 for <parameter>unit</parameter> == GIMP_UNIT_PIXEL.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-identifier" role="function"/>gimp_unit_get_identifier ()</title>
<indexterm><primary>gimp_unit_get_identifier</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_identifier (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<title><anchor id="gimp-unit-get-identifier"/>gimp_unit_get_identifier ()</title>
<indexterm><primary>gimp_unit_get_identifier</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_identifier (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<para>
This is an unstranslated string and must not be changed or freed.</para>
<para>
@ -245,8 +251,8 @@ This is an unstranslated string and must not be changed or freed.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-symbol" role="function"/>gimp_unit_get_symbol ()</title>
<indexterm><primary>gimp_unit_get_symbol</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_symbol (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<title><anchor id="gimp-unit-get-symbol"/>gimp_unit_get_symbol ()</title>
<indexterm><primary>gimp_unit_get_symbol</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_symbol (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<para>
This is e.g. "''" for UNIT_INCH.
</para>
@ -262,8 +268,8 @@ NOTE: This string must not be changed or freed.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-abbreviation" role="function"/>gimp_unit_get_abbreviation ()</title>
<indexterm><primary>gimp_unit_get_abbreviation</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_abbreviation (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<title><anchor id="gimp-unit-get-abbreviation"/>gimp_unit_get_abbreviation ()</title>
<indexterm><primary>gimp_unit_get_abbreviation</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_abbreviation (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<para>
For built-in units, this function returns the translated abbreviation
of the unit.
@ -280,8 +286,8 @@ NOTE: This string must not be changed or freed.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-singular" role="function"/>gimp_unit_get_singular ()</title>
<indexterm><primary>gimp_unit_get_singular</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_singular (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<title><anchor id="gimp-unit-get-singular"/>gimp_unit_get_singular ()</title>
<indexterm><primary>gimp_unit_get_singular</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_singular (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<para>
For built-in units, this function returns the translated singular form
of the unit's name.
@ -298,8 +304,8 @@ NOTE: This string must not be changed or freed.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-unit-get-plural" role="function"/>gimp_unit_get_plural ()</title>
<indexterm><primary>gimp_unit_get_plural</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_plural (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<title><anchor id="gimp-unit-get-plural"/>gimp_unit_get_plural ()</title>
<indexterm><primary>gimp_unit_get_plural</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_unit_get_plural (<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
<para>
For built-in units, this function returns the translated plural form
of the unit's name.
@ -316,14 +322,75 @@ NOTE: This string must not be changed or freed.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GIMP-TYPE-UNIT:CAPS" role="macro"/>GIMP_TYPE_UNIT</title>
<title><anchor id="GIMP-TYPE-UNIT:CAPS"/>GIMP_TYPE_UNIT</title>
<indexterm><primary>GIMP_TYPE_UNIT</primary></indexterm><programlisting>#define GIMP_TYPE_UNIT (gimp_unit_get_type ())
</programlisting>
<para>
<link linkend="GIMP-TYPE-UNIT:CAPS"><type>GIMP_TYPE_UNIT</type></link> is a <link linkend="GType"><type>GType</type></link> derived from <link linkend="G-TYPE-INT:CAPS"><type>G_TYPE_INT</type></link>.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-VALUE-HOLDS-UNIT:CAPS" role="macro"/>GIMP_VALUE_HOLDS_UNIT()</title>
<title><anchor id="GIMP-TYPE-PARAM-UNIT:CAPS"/>GIMP_TYPE_PARAM_UNIT</title>
<indexterm><primary>GIMP_TYPE_PARAM_UNIT</primary></indexterm><programlisting>#define GIMP_TYPE_PARAM_UNIT (gimp_param_unit_get_type ())
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-IS-PARAM-SPEC-UNIT:CAPS"/>GIMP_IS_PARAM_SPEC_UNIT()</title>
<indexterm><primary>GIMP_IS_PARAM_SPEC_UNIT</primary></indexterm><programlisting>#define GIMP_IS_PARAM_SPEC_UNIT(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_UNIT))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pspec</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-param-spec-unit"/>gimp_param_spec_unit ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_param_spec_unit</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link>* gimp_param_spec_unit (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *nick,
const <link linkend="gchar">gchar</link> *blurb,
<link linkend="gboolean">gboolean</link> allow_pixels,
<link linkend="gboolean">gboolean</link> allow_percent,
<link linkend="GimpUnit">GimpUnit</link> default_value,
<link linkend="GParamFlags">GParamFlags</link> flags);</programlisting>
<para>
Creates a param spec to hold a units param.
See <link linkend="g-param-spec-internal"><function>g_param_spec_internal()</function></link> for more information.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> Canonical name of the param
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nick</parameter>&nbsp;:</term>
<listitem><simpara> Nickname of the param
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>blurb</parameter>&nbsp;:</term>
<listitem><simpara> Brief desciption of param.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>allow_pixels</parameter>&nbsp;:</term>
<listitem><simpara> Whether "pixels" is an allowed unit.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>allow_percent</parameter>&nbsp;:</term>
<listitem><simpara> Whether "perecent" is an allowed unit.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>default_value</parameter>&nbsp;:</term>
<listitem><simpara> Unit to use if none is assigned.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
<listitem><simpara> a combination of <link linkend="GParamFlags"><type>GParamFlags</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-VALUE-HOLDS-UNIT:CAPS"/>GIMP_VALUE_HOLDS_UNIT()</title>
<indexterm><primary>GIMP_VALUE_HOLDS_UNIT</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_UNIT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_UNIT))
</programlisting>
<para>

255
devel-docs/libgimpbase/xml/gimputils.xml
View File

@ -4,57 +4,55 @@
<refentry id="libgimpbase-gimputils">
<refmeta>
<refentrytitle role="top_of_page">gimputils</refentrytitle>
<refentrytitle>gimputils</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimputils</refname>
<refpurpose>Utilities of general interest</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
<refname>gimputils</refname><refpurpose>Utilities of general interest</refpurpose>
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="gchar">gchar</link>* <link linkend="gimp-any-to-utf8">gimp_any_to_utf8</link> (const <link linkend="gchar">gchar</link> *str,
<link linkend="gssize">gssize</link> len,
const <link linkend="gchar">gchar</link> *warning_format,
...);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-filename-to-utf8">gimp_filename_to_utf8</link> (const <link linkend="gchar">gchar</link> *filename);
<link linkend="gchar">gchar</link>* <link linkend="gimp-utf8-strtrim">gimp_utf8_strtrim</link> (const <link linkend="gchar">gchar</link> *str,
<link linkend="gint">gint</link> max_chars);
<link linkend="gchar">gchar</link>* <link linkend="gimp-escape-uline">gimp_escape_uline</link> (const <link linkend="gchar">gchar</link> *str);
<link linkend="gchar">gchar</link>* <link linkend="gimp-strip-uline">gimp_strip_uline</link> (const <link linkend="gchar">gchar</link> *str);
<link linkend="GimpEnumDesc">GimpEnumDesc</link>* <link linkend="gimp-enum-get-desc">gimp_enum_get_desc</link> (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="gint">gint</link> value);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-enum-get-value">gimp_enum_get_value</link> (<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> value,
const <link linkend="gchar">gchar</link> **value_name,
const <link linkend="gchar">gchar</link> **value_nick,
const <link linkend="gchar">gchar</link> **value_desc,
const <link linkend="gchar">gchar</link> **value_help);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-enum-value-get-desc">gimp_enum_value_get_desc</link> (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="GEnumValue">GEnumValue</link> *enum_value);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-enum-value-get-help">gimp_enum_value_get_help</link> (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="GEnumValue">GEnumValue</link> *enum_value);
<link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* <link linkend="gimp-flags-get-first-desc">gimp_flags_get_first_desc</link> (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="guint">guint</link> value);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-flags-get-first-value">gimp_flags_get_first_value</link> (<link linkend="GType">GType</link> flags_type,
<link linkend="guint">guint</link> value,
const <link linkend="gchar">gchar</link> **value_name,
const <link linkend="gchar">gchar</link> **value_nick,
const <link linkend="gchar">gchar</link> **value_desc,
const <link linkend="gchar">gchar</link> **value_help);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-flags-value-get-desc">gimp_flags_value_get_desc</link> (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-flags-value-get-help">gimp_flags_value_get_help</link> (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
<link linkend="gchar">gchar</link>* <link linkend="gimp-any-to-utf8">gimp_any_to_utf8</link> (const <link linkend="gchar">gchar</link> *str,
<link linkend="gssize">gssize</link> len,
const <link linkend="gchar">gchar</link> *warning_format,
...);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-filename-to-utf8">gimp_filename_to_utf8</link> (const <link linkend="gchar">gchar</link> *filename);
<link linkend="gchar">gchar</link>* <link linkend="gimp-utf8-strtrim">gimp_utf8_strtrim</link> (const <link linkend="gchar">gchar</link> *str,
<link linkend="gint">gint</link> max_chars);
<link linkend="gchar">gchar</link>* <link linkend="gimp-escape-uline">gimp_escape_uline</link> (const <link linkend="gchar">gchar</link> *str);
<link linkend="gchar">gchar</link>* <link linkend="gimp-strip-uline">gimp_strip_uline</link> (const <link linkend="gchar">gchar</link> *str);
<link linkend="gchar">gchar</link>* <link linkend="gimp-canonicalize-identifier">gimp_canonicalize_identifier</link> (const <link linkend="gchar">gchar</link> *identifier);
<link linkend="GimpEnumDesc">GimpEnumDesc</link>* <link linkend="gimp-enum-get-desc">gimp_enum_get_desc</link> (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="gint">gint</link> value);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-enum-get-value">gimp_enum_get_value</link> (<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> value,
const <link linkend="gchar">gchar</link> **value_name,
const <link linkend="gchar">gchar</link> **value_nick,
const <link linkend="gchar">gchar</link> **value_desc,
const <link linkend="gchar">gchar</link> **value_help);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-enum-value-get-desc">gimp_enum_value_get_desc</link> (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="GEnumValue">GEnumValue</link> *enum_value);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-enum-value-get-help">gimp_enum_value_get_help</link> (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="GEnumValue">GEnumValue</link> *enum_value);
<link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* <link linkend="gimp-flags-get-first-desc">gimp_flags_get_first_desc</link> (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="guint">guint</link> value);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-flags-get-first-value">gimp_flags_get_first_value</link> (<link linkend="GType">GType</link> flags_type,
<link linkend="guint">guint</link> value,
const <link linkend="gchar">gchar</link> **value_name,
const <link linkend="gchar">gchar</link> **value_nick,
const <link linkend="gchar">gchar</link> **value_desc,
const <link linkend="gchar">gchar</link> **value_help);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-flags-value-get-desc">gimp_flags_value_get_desc</link> (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-flags-value-get-help">gimp_flags_value_get_help</link> (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="GFlagsValue">GFlagsValue</link> *flags_value);
</synopsis>
</refsynopsisdiv>
@ -66,21 +64,21 @@ const <link linkend="gchar">gchar</link>* <link linkend="gimp-flags-value
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gimp-any-to-utf8" role="function"/>gimp_any_to_utf8 ()</title>
<indexterm><primary>gimp_any_to_utf8</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_any_to_utf8 (const <link linkend="gchar">gchar</link> *str,
<link linkend="gssize">gssize</link> len,
const <link linkend="gchar">gchar</link> *warning_format,
...);</programlisting>
<title><anchor id="gimp-any-to-utf8"/>gimp_any_to_utf8 ()</title>
<indexterm><primary>gimp_any_to_utf8</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_any_to_utf8 (const <link linkend="gchar">gchar</link> *str,
<link linkend="gssize">gssize</link> len,
const <link linkend="gchar">gchar</link> *warning_format,
...);</programlisting>
<para>
This function takes any string (UTF-8 or not) and always returns a valid
UTF-8 string.
@ -118,8 +116,8 @@ of <parameter>str</parameter> is valid UTF-8, only "(invalid UTF-8 string)" is r
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-filename-to-utf8" role="function"/>gimp_filename_to_utf8 ()</title>
<indexterm><primary>gimp_filename_to_utf8</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_filename_to_utf8 (const <link linkend="gchar">gchar</link> *filename);</programlisting>
<title><anchor id="gimp-filename-to-utf8"/>gimp_filename_to_utf8 ()</title>
<indexterm><primary>gimp_filename_to_utf8</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_filename_to_utf8 (const <link linkend="gchar">gchar</link> *filename);</programlisting>
<para>
Convert a filename in the filesystem's encoding to UTF-8
temporarily. The return value is a pointer to a string that is
@ -141,9 +139,9 @@ UTF-8 encoded filename.</para>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-utf8-strtrim" role="function"/>gimp_utf8_strtrim ()</title>
<indexterm><primary>gimp_utf8_strtrim</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_utf8_strtrim (const <link linkend="gchar">gchar</link> *str,
<link linkend="gint">gint</link> max_chars);</programlisting>
<title><anchor id="gimp-utf8-strtrim"/>gimp_utf8_strtrim ()</title>
<indexterm><primary>gimp_utf8_strtrim</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_utf8_strtrim (const <link linkend="gchar">gchar</link> *str,
<link linkend="gint">gint</link> max_chars);</programlisting>
<para>
Creates a (possibly trimmed) copy of <parameter>str</parameter>. The string is cut if it
exceeds <parameter>max_chars</parameter> characters or on the first newline. The fact
@ -152,7 +150,7 @@ that the string was trimmed is indicated by appending an ellipsis.</para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> an UTF-8 encoded string (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> an UTF-8 encoded string (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_chars</parameter>&nbsp;:</term>
<listitem><simpara> the maximum number of characters before the string get
@ -163,8 +161,8 @@ using <link linkend="g-free"><function>g_free()</function></link> when it is not
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-escape-uline" role="function" condition="since:GIMP 2.2"/>gimp_escape_uline ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_escape_uline</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_escape_uline (const <link linkend="gchar">gchar</link> *str);</programlisting>
<title><anchor id="gimp-escape-uline"/>gimp_escape_uline ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_escape_uline</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_escape_uline (const <link linkend="gchar">gchar</link> *str);</programlisting>
<para>
This function returns a copy of <parameter>str</parameter> with all underline converted
to two adjacent underlines. This comes in handy when needing to display
@ -174,17 +172,17 @@ them to mnemonics.</para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> Underline infested string (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> Underline infested string (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A (possibly escaped) copy of <parameter>str</parameter> which should be
freed using <link linkend="g-free"><function>g_free()</function></link> when it is not needed any longer.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-strip-uline" role="function"/>gimp_strip_uline ()</title>
<indexterm><primary>gimp_strip_uline</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_strip_uline (const <link linkend="gchar">gchar</link> *str);</programlisting>
<title><anchor id="gimp-strip-uline"/>gimp_strip_uline ()</title>
<indexterm><primary>gimp_strip_uline</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_strip_uline (const <link linkend="gchar">gchar</link> *str);</programlisting>
<para>
This function returns a copy of <parameter>str</parameter> stripped of underline
characters. This comes in handy when needing to strip mnemonics
@ -199,18 +197,41 @@ rid of the mnemonic (see bug <link linkend="157561:CAPS"><type>157561</type></li
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> underline infested string (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> underline infested string (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A (possibly stripped) copy of <parameter>str</parameter> which should be
freed using <link linkend="g-free"><function>g_free()</function></link> when it is not needed any longer.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-enum-get-desc" role="function" condition="since:GIMP 2.2"/>gimp_enum_get_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_get_desc</primary></indexterm><programlisting><link linkend="GimpEnumDesc">GimpEnumDesc</link>* gimp_enum_get_desc (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="gint">gint</link> value);</programlisting>
<title><anchor id="gimp-canonicalize-identifier"/>gimp_canonicalize_identifier ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_canonicalize_identifier</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_canonicalize_identifier (const <link linkend="gchar">gchar</link> *identifier);</programlisting>
<para>
Retrieves <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link> associated with the given value, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
Turns any input string into a canonicalized string.
</para>
<para>
Canonical identifiers are e.g. expected by the PDB for procedure
and parameter names. Every character of the input string that is
not either '-', 'a-z', 'A-Z' or '0-9' will be replaced by a '-'.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>identifier</parameter>&nbsp;:</term>
<listitem><simpara> The identifier string to canonicalize.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The canonicalized identifier. This is a newly
allocated string that should be freed with <link linkend="g-free"><function>g_free()</function></link>
when no longer needed.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-get-desc"/>gimp_enum_get_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_get_desc</primary></indexterm><programlisting><link linkend="GimpEnumDesc">GimpEnumDesc</link>* gimp_enum_get_desc (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="gint">gint</link> value);</programlisting>
<para>
Retrieves <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link> associated with the given value, or <literal>NULL</literal>.</para>
<para>
</para><variablelist role="params">
@ -223,21 +244,21 @@ Retrieves <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link> associat
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the value's <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-get-value" role="function" condition="since:GIMP 2.2"/>gimp_enum_get_value ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_get_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_enum_get_value (<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> value,
const <link linkend="gchar">gchar</link> **value_name,
const <link linkend="gchar">gchar</link> **value_nick,
const <link linkend="gchar">gchar</link> **value_desc,
const <link linkend="gchar">gchar</link> **value_help);</programlisting>
<title><anchor id="gimp-enum-get-value"/>gimp_enum_get_value ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_get_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_enum_get_value (<link linkend="GType">GType</link> enum_type,
<link linkend="gint">gint</link> value,
const <link linkend="gchar">gchar</link> **value_name,
const <link linkend="gchar">gchar</link> **value_nick,
const <link linkend="gchar">gchar</link> **value_desc,
const <link linkend="gchar">gchar</link> **value_help);</programlisting>
<para>
Checks if <parameter>value</parameter> is valid for the enum registered as <parameter>enum_type</parameter>.
If the value exists in that enum, its name, nick and its translated
desc and help are returned (if <parameter>value_name</parameter>, <parameter>value_nick</parameter>, <parameter>value_desc</parameter>
and <parameter>value_help</parameter> are not <link linkend="NULL:CAPS"><literal>NULL</literal></link>).</para>
and <parameter>value_help</parameter> are not <literal>NULL</literal>).</para>
<para>
</para><variablelist role="params">
@ -248,27 +269,27 @@ and <parameter>value_help</parameter> are not <link linkend="NULL:CAPS"><literal
<listitem><simpara> an integer value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_name</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's name (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> return location for the value's name (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_nick</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's nick (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> return location for the value's nick (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_desc</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's translated desc (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> return location for the value's translated desc (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_help</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's translated help (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> return location for the value's translated help (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>value</parameter> is valid for the <parameter>enum_type</parameter>,
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if <parameter>value</parameter> is valid for the <parameter>enum_type</parameter>,
<literal>FALSE</literal> otherwise
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-value-get-desc" role="function" condition="since:GIMP 2.2"/>gimp_enum_value_get_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_value_get_desc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_enum_value_get_desc (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
<title><anchor id="gimp-enum-value-get-desc"/>gimp_enum_value_get_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_value_get_desc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_enum_value_get_desc (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
<para>
Retrieves the translated desc for a given <parameter>enum_value</parameter>.</para>
<para>
@ -283,12 +304,12 @@ Retrieves the translated desc for a given <parameter>enum_value</parameter>.</pa
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated desc of the enum value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enum-value-get-help" role="function" condition="since:GIMP 2.2"/>gimp_enum_value_get_help ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_value_get_help</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_enum_value_get_help (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
<title><anchor id="gimp-enum-value-get-help"/>gimp_enum_value_get_help ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_enum_value_get_help</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_enum_value_get_help (<link linkend="GEnumClass">GEnumClass</link> *enum_class,
<link linkend="GEnumValue">GEnumValue</link> *enum_value);</programlisting>
<para>
Retrieves the translated help for a given <parameter>enum_value</parameter>.</para>
<para>
@ -303,14 +324,14 @@ Retrieves the translated help for a given <parameter>enum_value</parameter>.</pa
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated help of the enum value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-get-first-desc" role="function" condition="since:GIMP 2.2"/>gimp_flags_get_first_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_get_first_desc</primary></indexterm><programlisting><link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* gimp_flags_get_first_desc (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="guint">guint</link> value);</programlisting>
<title><anchor id="gimp-flags-get-first-desc"/>gimp_flags_get_first_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_get_first_desc</primary></indexterm><programlisting><link linkend="GimpFlagsDesc">GimpFlagsDesc</link>* gimp_flags_get_first_desc (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="guint">guint</link> value);</programlisting>
<para>
Retrieves the first <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link> that matches the given value, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
Retrieves the first <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link> that matches the given value, or <literal>NULL</literal>.</para>
<para>
</para><variablelist role="params">
@ -323,21 +344,21 @@ Retrieves the first <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></li
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the value's <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-get-first-value" role="function" condition="since:GIMP 2.2"/>gimp_flags_get_first_value ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_get_first_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_flags_get_first_value (<link linkend="GType">GType</link> flags_type,
<link linkend="guint">guint</link> value,
const <link linkend="gchar">gchar</link> **value_name,
const <link linkend="gchar">gchar</link> **value_nick,
const <link linkend="gchar">gchar</link> **value_desc,
const <link linkend="gchar">gchar</link> **value_help);</programlisting>
<title><anchor id="gimp-flags-get-first-value"/>gimp_flags_get_first_value ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_get_first_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_flags_get_first_value (<link linkend="GType">GType</link> flags_type,
<link linkend="guint">guint</link> value,
const <link linkend="gchar">gchar</link> **value_name,
const <link linkend="gchar">gchar</link> **value_nick,
const <link linkend="gchar">gchar</link> **value_desc,
const <link linkend="gchar">gchar</link> **value_help);</programlisting>
<para>
Checks if <parameter>value</parameter> is valid for the flags registered as <parameter>flags_type</parameter>.
If the value exists in that flags, its name, nick and its translated
desc and help are returned (if <parameter>value_name</parameter>, <parameter>value_nick</parameter>, <parameter>value_desc</parameter>
and <parameter>value_help</parameter> are not <link linkend="NULL:CAPS"><literal>NULL</literal></link>).</para>
and <parameter>value_help</parameter> are not <literal>NULL</literal>).</para>
<para>
</para><variablelist role="params">
@ -348,27 +369,27 @@ and <parameter>value_help</parameter> are not <link linkend="NULL:CAPS"><literal
<listitem><simpara> an integer value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_name</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's name (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> return location for the value's name (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_nick</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's nick (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> return location for the value's nick (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_desc</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's translated desc (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> return location for the value's translated desc (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value_help</parameter>&nbsp;:</term>
<listitem><simpara> return location for the value's translated help (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
<listitem><simpara> return location for the value's translated help (or <literal>NULL</literal>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>value</parameter> is valid for the <parameter>flags_type</parameter>,
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if <parameter>value</parameter> is valid for the <parameter>flags_type</parameter>,
<literal>FALSE</literal> otherwise
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-value-get-desc" role="function" condition="since:GIMP 2.2"/>gimp_flags_value_get_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_value_get_desc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_flags_value_get_desc (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
<title><anchor id="gimp-flags-value-get-desc"/>gimp_flags_value_get_desc ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_value_get_desc</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_flags_value_get_desc (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
<para>
Retrieves the translated desc for a given <parameter>flags_value</parameter>.</para>
<para>
@ -383,12 +404,12 @@ Retrieves the translated desc for a given <parameter>flags_value</parameter>.</p
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated desc of the flags value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-flags-value-get-help" role="function" condition="since:GIMP 2.2"/>gimp_flags_value_get_help ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_value_get_help</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_flags_value_get_help (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
<title><anchor id="gimp-flags-value-get-help"/>gimp_flags_value_get_help ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_flags_value_get_help</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_flags_value_get_help (<link linkend="GFlagsClass">GFlagsClass</link> *flags_class,
<link linkend="GFlagsValue">GFlagsValue</link> *flags_value);</programlisting>
<para>
Retrieves the translated help for a given <parameter>flags_value</parameter>.</para>
<para>
@ -403,7 +424,7 @@ Retrieves the translated help for a given <parameter>flags_value</parameter>.</p
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the translated help of the flags value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.2
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>

49
devel-docs/libgimpbase/xml/gimpversion.xml
View File

@ -4,31 +4,28 @@
<refentry id="libgimpbase-gimpversion">
<refmeta>
<refentrytitle role="top_of_page">gimpversion</refentrytitle>
<refentrytitle>gimpversion</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpversion</refname>
<refpurpose>Macros and constants useful for determining GIMP's version number and
<refname>gimpversion</refname><refpurpose>Macros and constants useful for determining GIMP's version number and
capabilities.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
#define <link linkend="GIMP-MAJOR-VERSION:CAPS">GIMP_MAJOR_VERSION</link>
#define <link linkend="GIMP-MINOR-VERSION:CAPS">GIMP_MINOR_VERSION</link>
#define <link linkend="GIMP-MICRO-VERSION:CAPS">GIMP_MICRO_VERSION</link>
#define <link linkend="GIMP-VERSION:CAPS">GIMP_VERSION</link>
#define <link linkend="GIMP-API-VERSION:CAPS">GIMP_API_VERSION</link>
#define <link linkend="GIMP-CHECK-VERSION:CAPS">GIMP_CHECK_VERSION</link> (major, minor, micro)
#define <link linkend="GIMP-MAJOR-VERSION:CAPS">GIMP_MAJOR_VERSION</link>
#define <link linkend="GIMP-MINOR-VERSION:CAPS">GIMP_MINOR_VERSION</link>
#define <link linkend="GIMP-MICRO-VERSION:CAPS">GIMP_MICRO_VERSION</link>
#define <link linkend="GIMP-VERSION:CAPS">GIMP_VERSION</link>
#define <link linkend="GIMP-API-VERSION:CAPS">GIMP_API_VERSION</link>
#define <link linkend="GIMP-CHECK-VERSION:CAPS">GIMP_CHECK_VERSION</link> (major, minor, micro)
</synopsis>
</refsynopsisdiv>
@ -40,8 +37,8 @@ capabilities.</refpurpose>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
Macros and constants useful for determining GIMP's version number and
capabilities.
@ -49,46 +46,46 @@ capabilities.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GIMP-MAJOR-VERSION:CAPS" role="macro"/>GIMP_MAJOR_VERSION</title>
<title><anchor id="GIMP-MAJOR-VERSION:CAPS"/>GIMP_MAJOR_VERSION</title>
<indexterm><primary>GIMP_MAJOR_VERSION</primary></indexterm><programlisting>#define GIMP_MAJOR_VERSION (2)
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-MINOR-VERSION:CAPS" role="macro"/>GIMP_MINOR_VERSION</title>
<indexterm><primary>GIMP_MINOR_VERSION</primary></indexterm><programlisting>#define GIMP_MINOR_VERSION (2)
<title><anchor id="GIMP-MINOR-VERSION:CAPS"/>GIMP_MINOR_VERSION</title>
<indexterm><primary>GIMP_MINOR_VERSION</primary></indexterm><programlisting>#define GIMP_MINOR_VERSION (3)
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-MICRO-VERSION:CAPS" role="macro"/>GIMP_MICRO_VERSION</title>
<indexterm><primary>GIMP_MICRO_VERSION</primary></indexterm><programlisting>#define GIMP_MICRO_VERSION (17)
<title><anchor id="GIMP-MICRO-VERSION:CAPS"/>GIMP_MICRO_VERSION</title>
<indexterm><primary>GIMP_MICRO_VERSION</primary></indexterm><programlisting>#define GIMP_MICRO_VERSION (6)
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-VERSION:CAPS" role="macro"/>GIMP_VERSION</title>
<indexterm><primary>GIMP_VERSION</primary></indexterm><programlisting>#define GIMP_VERSION "2.2.17"
<title><anchor id="GIMP-VERSION:CAPS"/>GIMP_VERSION</title>
<indexterm><primary>GIMP_VERSION</primary></indexterm><programlisting>#define GIMP_VERSION "2.3.6"
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-API-VERSION:CAPS" role="macro"/>GIMP_API_VERSION</title>
<title><anchor id="GIMP-API-VERSION:CAPS"/>GIMP_API_VERSION</title>
<indexterm><primary>GIMP_API_VERSION</primary></indexterm><programlisting>#define GIMP_API_VERSION "2.0"
</programlisting>
<para>
Since: GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-CHECK-VERSION:CAPS" role="macro"/>GIMP_CHECK_VERSION()</title>
<indexterm><primary>GIMP_CHECK_VERSION</primary></indexterm><programlisting>#define GIMP_CHECK_VERSION(major, minor, micro)</programlisting>
<title><anchor id="GIMP-CHECK-VERSION:CAPS"/>GIMP_CHECK_VERSION()</title>
<indexterm><primary>GIMP_CHECK_VERSION</primary></indexterm><programlisting>#define GIMP_CHECK_VERSION(major, minor, micro)</programlisting>
<para>
</para><variablelist role="params">

391
devel-docs/libgimpbase/xml/gimpwire.xml
View File

@ -4,105 +4,102 @@
<refentry id="libgimpbase-gimpwire">
<refmeta>
<refentrytitle role="top_of_page">gimpwire</refentrytitle>
<refentrytitle>gimpwire</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpwire</refname>
<refpurpose>The lowlevel I/O protocol used for communication between GIMP and
<refname>gimpwire</refname><refpurpose>The lowlevel I/O protocol used for communication between GIMP and
it's plug-ins.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="WireMessage">WireMessage</link>;
<link linkend="void">void</link> (<link linkend="WireReadFunc">*WireReadFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> (<link linkend="WireWriteFunc">*WireWriteFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> (<link linkend="WireDestroyFunc">*WireDestroyFunc</link>) (<link linkend="WireMessage">WireMessage</link> *msg);
<link linkend="gboolean">gboolean</link> (<link linkend="WireIOFunc">*WireIOFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gulong">gulong</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> (<link linkend="WireFlushFunc">*WireFlushFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="wire-register">wire_register</link> (<link linkend="guint32">guint32</link> type,
<link linkend="WireReadFunc">WireReadFunc</link> read_func,
<link linkend="WireWriteFunc">WireWriteFunc</link> write_func,
<link linkend="WireDestroyFunc">WireDestroyFunc</link> destroy_func);
<link linkend="void">void</link> <link linkend="wire-set-reader">wire_set_reader</link> (<link linkend="WireIOFunc">WireIOFunc</link> read_func);
<link linkend="void">void</link> <link linkend="wire-set-writer">wire_set_writer</link> (<link linkend="WireIOFunc">WireIOFunc</link> write_func);
<link linkend="void">void</link> <link linkend="wire-set-flusher">wire_set_flusher</link> (<link linkend="WireFlushFunc">WireFlushFunc</link> flush_func);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read">wire_read</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gsize">gsize</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write">wire_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gsize">gsize</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-flush">wire_flush</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-error">wire_error</link> (void);
<link linkend="void">void</link> <link linkend="wire-clear-error">wire_clear_error</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-msg">wire_read_msg</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-msg">wire_write_msg</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="wire-destroy">wire_destroy</link> (<link linkend="WireMessage">WireMessage</link> *msg);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-int32">wire_read_int32</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint32">guint32</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-int16">wire_read_int16</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint16">guint16</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-int8">wire_read_int8</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-double">wire_read_double</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gdouble">gdouble</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-string">wire_read_string</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gchar">gchar</link> **data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-int32">wire_write_int32</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint32">guint32</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-int16">wire_write_int16</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint16">guint16</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-int8">wire_write_int8</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-double">wire_write_double</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gdouble">gdouble</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-string">wire_write_string</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gchar">gchar</link> **data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="WireMessage">WireMessage</link>;
<link linkend="void">void</link> (<link linkend="WireReadFunc">*WireReadFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> (<link linkend="WireWriteFunc">*WireWriteFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> (<link linkend="WireDestroyFunc">*WireDestroyFunc</link>) (<link linkend="WireMessage">WireMessage</link> *msg);
<link linkend="gboolean">gboolean</link> (<link linkend="WireIOFunc">*WireIOFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gulong">gulong</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> (<link linkend="WireFlushFunc">*WireFlushFunc</link>) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="wire-register">wire_register</link> (<link linkend="guint32">guint32</link> type,
<link linkend="WireReadFunc">WireReadFunc</link> read_func,
<link linkend="WireWriteFunc">WireWriteFunc</link> write_func,
<link linkend="WireDestroyFunc">WireDestroyFunc</link> destroy_func);
<link linkend="void">void</link> <link linkend="wire-set-reader">wire_set_reader</link> (<link linkend="WireIOFunc">WireIOFunc</link> read_func);
<link linkend="void">void</link> <link linkend="wire-set-writer">wire_set_writer</link> (<link linkend="WireIOFunc">WireIOFunc</link> write_func);
<link linkend="void">void</link> <link linkend="wire-set-flusher">wire_set_flusher</link> (<link linkend="WireFlushFunc">WireFlushFunc</link> flush_func);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read">wire_read</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gsize">gsize</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write">wire_write</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gsize">gsize</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-flush">wire_flush</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-error">wire_error</link> (void);
<link linkend="void">void</link> <link linkend="wire-clear-error">wire_clear_error</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-msg">wire_read_msg</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-msg">wire_write_msg</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="wire-destroy">wire_destroy</link> (<link linkend="WireMessage">WireMessage</link> *msg);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-int32">wire_read_int32</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint32">guint32</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-int16">wire_read_int16</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint16">guint16</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-int8">wire_read_int8</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-double">wire_read_double</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gdouble">gdouble</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-read-string">wire_read_string</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gchar">gchar</link> **data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-int32">wire_write_int32</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint32">guint32</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-int16">wire_write_int16</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint16">guint16</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-int8">wire_write_int8</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-double">wire_write_double</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gdouble">gdouble</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link> <link linkend="wire-write-string">wire_write_string</link> (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gchar">gchar</link> **data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsynopsisdiv>
@ -114,8 +111,8 @@ it's plug-ins.</refpurpose>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<refsect1>
<title>Description</title>
<para>
The lowlevel I/O protocol used for communication between GIMP and
it's plug-ins.
@ -123,10 +120,10 @@ it's plug-ins.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="WireMessage" role="struct"/>WireMessage</title>
<title><anchor id="WireMessage"/>WireMessage</title>
<indexterm><primary>WireMessage</primary></indexterm><programlisting>typedef struct {
guint32 type;
gpointer data;
@ -136,10 +133,10 @@ it's plug-ins.
</para></refsect2>
<refsect2>
<title><anchor id="WireReadFunc" role="function"/>WireReadFunc ()</title>
<indexterm><primary>WireReadFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*WireReadFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="WireReadFunc"/>WireReadFunc ()</title>
<indexterm><primary>WireReadFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*WireReadFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -156,10 +153,10 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="WireWriteFunc" role="function"/>WireWriteFunc ()</title>
<indexterm><primary>WireWriteFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*WireWriteFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="WireWriteFunc"/>WireWriteFunc ()</title>
<indexterm><primary>WireWriteFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*WireWriteFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -176,8 +173,8 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="WireDestroyFunc" role="function"/>WireDestroyFunc ()</title>
<indexterm><primary>WireDestroyFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*WireDestroyFunc) (<link linkend="WireMessage">WireMessage</link> *msg);</programlisting>
<title><anchor id="WireDestroyFunc"/>WireDestroyFunc ()</title>
<indexterm><primary>WireDestroyFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*WireDestroyFunc) (<link linkend="WireMessage">WireMessage</link> *msg);</programlisting>
<para>
</para><variablelist role="params">
@ -188,11 +185,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="WireIOFunc" role="function"/>WireIOFunc ()</title>
<indexterm><primary>WireIOFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*WireIOFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gulong">gulong</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="WireIOFunc"/>WireIOFunc ()</title>
<indexterm><primary>WireIOFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*WireIOFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gulong">gulong</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -214,9 +211,9 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="WireFlushFunc" role="function"/>WireFlushFunc ()</title>
<indexterm><primary>WireFlushFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*WireFlushFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="WireFlushFunc"/>WireFlushFunc ()</title>
<indexterm><primary>WireFlushFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*WireFlushFunc) (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -232,11 +229,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-register" role="function"/>wire_register ()</title>
<indexterm><primary>wire_register</primary></indexterm><programlisting><link linkend="void">void</link> wire_register (<link linkend="guint32">guint32</link> type,
<link linkend="WireReadFunc">WireReadFunc</link> read_func,
<link linkend="WireWriteFunc">WireWriteFunc</link> write_func,
<link linkend="WireDestroyFunc">WireDestroyFunc</link> destroy_func);</programlisting>
<title><anchor id="wire-register"/>wire_register ()</title>
<indexterm><primary>wire_register</primary></indexterm><programlisting><link linkend="void">void</link> wire_register (<link linkend="guint32">guint32</link> type,
<link linkend="WireReadFunc">WireReadFunc</link> read_func,
<link linkend="WireWriteFunc">WireWriteFunc</link> write_func,
<link linkend="WireDestroyFunc">WireDestroyFunc</link> destroy_func);</programlisting>
<para>
</para><variablelist role="params">
@ -256,8 +253,8 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-set-reader" role="function"/>wire_set_reader ()</title>
<indexterm><primary>wire_set_reader</primary></indexterm><programlisting><link linkend="void">void</link> wire_set_reader (<link linkend="WireIOFunc">WireIOFunc</link> read_func);</programlisting>
<title><anchor id="wire-set-reader"/>wire_set_reader ()</title>
<indexterm><primary>wire_set_reader</primary></indexterm><programlisting><link linkend="void">void</link> wire_set_reader (<link linkend="WireIOFunc">WireIOFunc</link> read_func);</programlisting>
<para>
</para><variablelist role="params">
@ -268,8 +265,8 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-set-writer" role="function"/>wire_set_writer ()</title>
<indexterm><primary>wire_set_writer</primary></indexterm><programlisting><link linkend="void">void</link> wire_set_writer (<link linkend="WireIOFunc">WireIOFunc</link> write_func);</programlisting>
<title><anchor id="wire-set-writer"/>wire_set_writer ()</title>
<indexterm><primary>wire_set_writer</primary></indexterm><programlisting><link linkend="void">void</link> wire_set_writer (<link linkend="WireIOFunc">WireIOFunc</link> write_func);</programlisting>
<para>
</para><variablelist role="params">
@ -280,8 +277,8 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-set-flusher" role="function"/>wire_set_flusher ()</title>
<indexterm><primary>wire_set_flusher</primary></indexterm><programlisting><link linkend="void">void</link> wire_set_flusher (<link linkend="WireFlushFunc">WireFlushFunc</link> flush_func);</programlisting>
<title><anchor id="wire-set-flusher"/>wire_set_flusher ()</title>
<indexterm><primary>wire_set_flusher</primary></indexterm><programlisting><link linkend="void">void</link> wire_set_flusher (<link linkend="WireFlushFunc">WireFlushFunc</link> flush_func);</programlisting>
<para>
</para><variablelist role="params">
@ -292,11 +289,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-read" role="function"/>wire_read ()</title>
<indexterm><primary>wire_read</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gsize">gsize</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-read"/>wire_read ()</title>
<indexterm><primary>wire_read</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gsize">gsize</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -318,11 +315,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-write" role="function"/>wire_write ()</title>
<indexterm><primary>wire_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gsize">gsize</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-write"/>wire_write ()</title>
<indexterm><primary>wire_write</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *buf,
<link linkend="gsize">gsize</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -344,9 +341,9 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-flush" role="function"/>wire_flush ()</title>
<indexterm><primary>wire_flush</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_flush (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-flush"/>wire_flush ()</title>
<indexterm><primary>wire_flush</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_flush (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -362,8 +359,8 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-error" role="function"/>wire_error ()</title>
<indexterm><primary>wire_error</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_error (void);</programlisting>
<title><anchor id="wire-error"/>wire_error ()</title>
<indexterm><primary>wire_error</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_error (void);</programlisting>
<para>
</para><variablelist role="params">
@ -373,16 +370,16 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-clear-error" role="function"/>wire_clear_error ()</title>
<indexterm><primary>wire_clear_error</primary></indexterm><programlisting><link linkend="void">void</link> wire_clear_error (void);</programlisting>
<title><anchor id="wire-clear-error"/>wire_clear_error ()</title>
<indexterm><primary>wire_clear_error</primary></indexterm><programlisting><link linkend="void">void</link> wire_clear_error (void);</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="wire-read-msg" role="function"/>wire_read_msg ()</title>
<indexterm><primary>wire_read_msg</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_msg (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-read-msg"/>wire_read_msg ()</title>
<indexterm><primary>wire_read_msg</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_msg (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -401,10 +398,10 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-write-msg" role="function"/>wire_write_msg ()</title>
<indexterm><primary>wire_write_msg</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_msg (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-write-msg"/>wire_write_msg ()</title>
<indexterm><primary>wire_write_msg</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_msg (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="WireMessage">WireMessage</link> *msg,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -423,8 +420,8 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-destroy" role="function"/>wire_destroy ()</title>
<indexterm><primary>wire_destroy</primary></indexterm><programlisting><link linkend="void">void</link> wire_destroy (<link linkend="WireMessage">WireMessage</link> *msg);</programlisting>
<title><anchor id="wire-destroy"/>wire_destroy ()</title>
<indexterm><primary>wire_destroy</primary></indexterm><programlisting><link linkend="void">void</link> wire_destroy (<link linkend="WireMessage">WireMessage</link> *msg);</programlisting>
<para>
</para><variablelist role="params">
@ -435,11 +432,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-read-int32" role="function"/>wire_read_int32 ()</title>
<indexterm><primary>wire_read_int32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_int32 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint32">guint32</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-read-int32"/>wire_read_int32 ()</title>
<indexterm><primary>wire_read_int32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_int32 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint32">guint32</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -461,11 +458,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-read-int16" role="function"/>wire_read_int16 ()</title>
<indexterm><primary>wire_read_int16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_int16 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint16">guint16</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-read-int16"/>wire_read_int16 ()</title>
<indexterm><primary>wire_read_int16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_int16 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint16">guint16</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -487,11 +484,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-read-int8" role="function"/>wire_read_int8 ()</title>
<indexterm><primary>wire_read_int8</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_int8 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-read-int8"/>wire_read_int8 ()</title>
<indexterm><primary>wire_read_int8</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_int8 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -513,11 +510,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-read-double" role="function"/>wire_read_double ()</title>
<indexterm><primary>wire_read_double</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_double (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gdouble">gdouble</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-read-double"/>wire_read_double ()</title>
<indexterm><primary>wire_read_double</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_double (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gdouble">gdouble</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -539,11 +536,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-read-string" role="function"/>wire_read_string ()</title>
<indexterm><primary>wire_read_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_string (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gchar">gchar</link> **data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-read-string"/>wire_read_string ()</title>
<indexterm><primary>wire_read_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_read_string (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gchar">gchar</link> **data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -565,11 +562,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-write-int32" role="function"/>wire_write_int32 ()</title>
<indexterm><primary>wire_write_int32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_int32 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint32">guint32</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-write-int32"/>wire_write_int32 ()</title>
<indexterm><primary>wire_write_int32</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_int32 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint32">guint32</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -591,11 +588,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-write-int16" role="function"/>wire_write_int16 ()</title>
<indexterm><primary>wire_write_int16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_int16 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint16">guint16</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-write-int16"/>wire_write_int16 ()</title>
<indexterm><primary>wire_write_int16</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_int16 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint16">guint16</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -617,11 +614,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-write-int8" role="function"/>wire_write_int8 ()</title>
<indexterm><primary>wire_write_int8</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_int8 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-write-int8"/>wire_write_int8 ()</title>
<indexterm><primary>wire_write_int8</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_int8 (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="guint8">guint8</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -643,11 +640,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-write-double" role="function"/>wire_write_double ()</title>
<indexterm><primary>wire_write_double</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_double (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gdouble">gdouble</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-write-double"/>wire_write_double ()</title>
<indexterm><primary>wire_write_double</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_double (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gdouble">gdouble</link> *data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
@ -669,11 +666,11 @@ it's plug-ins.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="wire-write-string" role="function"/>wire_write_string ()</title>
<indexterm><primary>wire_write_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_string (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gchar">gchar</link> **data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<title><anchor id="wire-write-string"/>wire_write_string ()</title>
<indexterm><primary>wire_write_string</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> wire_write_string (<link linkend="GIOChannel">GIOChannel</link> *channel,
<link linkend="gchar">gchar</link> **data,
<link linkend="gint">gint</link> count,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">