Imported Upstream version 2.2.4
This commit is contained in:
Ari Pollak
54
devel-docs/libgimpbase/Makefile.am
Normal file
54
devel-docs/libgimpbase/Makefile.am
Normal file
@ -0,0 +1,54 @@
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
AUTOMAKE_OPTIONS = 1.6
|
||||
|
||||
# The name of the module.
|
||||
DOC_MODULE = libgimpbase
|
||||
|
||||
# The top-level SGML file.
|
||||
DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
|
||||
|
||||
# The directory containing the source code.
|
||||
DOC_SOURCE_DIR = $(top_srcdir)/$(DOC_MODULE)
|
||||
|
||||
# Extra options to pass to gtkdoc-scangobj
|
||||
SCANGOBJ_OPTIONS =
|
||||
|
||||
# Extra options to supply to gtkdoc-scan
|
||||
SCAN_OPTIONS =
|
||||
|
||||
# Extra options to supply to gtkdoc-mkdb
|
||||
MKDB_OPTIONS = --sgml-mode --output-format=xml
|
||||
|
||||
# Extra options to supply to gtkdoc-fixref
|
||||
FIXXREF_OPTIONS =
|
||||
|
||||
# Used for dependencies
|
||||
HFILE_GLOB = $(DOC_SOURCE_DIR)/*.h
|
||||
CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c
|
||||
|
||||
# Header files to ignore when scanning
|
||||
IGNORE_HFILES = \
|
||||
gimpbase.h \
|
||||
gimpbase-private.h \
|
||||
gimpwin32-io.h
|
||||
|
||||
# Images to copy into HTML directory
|
||||
HTML_IMAGES=
|
||||
|
||||
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
|
||||
content_files =
|
||||
|
||||
# Other files to distribute
|
||||
extra_files =
|
||||
|
||||
# CFLAGS and LDFLAGS for compiling scan program. Only needed
|
||||
# if $(DOC_MODULE).types is non-empty.
|
||||
GTKDOC_CFLAGS =
|
||||
GTKDOC_LIBS =
|
||||
|
||||
|
||||
include $(top_srcdir)/gtk-doc.make
|
||||
|
||||
# Other files to distribute
|
||||
EXTRA_DIST += version.in
|
||||
724
devel-docs/libgimpbase/Makefile.in
Normal file
724
devel-docs/libgimpbase/Makefile.in
Normal file
@ -0,0 +1,724 @@
|
||||
# Makefile.in generated by automake 1.7.9 from Makefile.am.
|
||||
# @configure_input@
|
||||
|
||||
# Copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
|
||||
# Free Software Foundation, Inc.
|
||||
# This Makefile.in is free software; the Free Software Foundation
|
||||
# gives unlimited permission to copy and/or distribute it,
|
||||
# with or without modifications, as long as this notice is preserved.
|
||||
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
|
||||
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
|
||||
# PARTICULAR PURPOSE.
|
||||
|
||||
@SET_MAKE@
|
||||
|
||||
# -*- mode: makefile -*-
|
||||
|
||||
####################################
|
||||
# Everything below here is generic #
|
||||
####################################
|
||||
|
||||
srcdir = @srcdir@
|
||||
top_srcdir = @top_srcdir@
|
||||
VPATH = @srcdir@
|
||||
pkgdatadir = $(datadir)/@PACKAGE@
|
||||
pkglibdir = $(libdir)/@PACKAGE@
|
||||
pkgincludedir = $(includedir)/@PACKAGE@
|
||||
top_builddir = ../..
|
||||
|
||||
am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd
|
||||
INSTALL = @INSTALL@
|
||||
install_sh_DATA = $(install_sh) -c -m 644
|
||||
install_sh_PROGRAM = $(install_sh) -c
|
||||
install_sh_SCRIPT = $(install_sh) -c
|
||||
INSTALL_HEADER = $(INSTALL_DATA)
|
||||
transform = $(program_transform_name)
|
||||
NORMAL_INSTALL = :
|
||||
PRE_INSTALL = :
|
||||
POST_INSTALL = :
|
||||
NORMAL_UNINSTALL = :
|
||||
PRE_UNINSTALL = :
|
||||
POST_UNINSTALL = :
|
||||
host_triplet = @host@
|
||||
AA = @AA@
|
||||
ACLOCAL = @ACLOCAL@
|
||||
ALLOCA = @ALLOCA@
|
||||
ALSA_CFLAGS = @ALSA_CFLAGS@
|
||||
ALSA_LIBS = @ALSA_LIBS@
|
||||
AMDEP_FALSE = @AMDEP_FALSE@
|
||||
AMDEP_TRUE = @AMDEP_TRUE@
|
||||
AMTAR = @AMTAR@
|
||||
AR = @AR@
|
||||
AS = @AS@
|
||||
AUTOCONF = @AUTOCONF@
|
||||
AUTOHEADER = @AUTOHEADER@
|
||||
AUTOMAKE = @AUTOMAKE@
|
||||
AWK = @AWK@
|
||||
BUILD_HELPBROWSER_FALSE = @BUILD_HELPBROWSER_FALSE@
|
||||
BUILD_HELPBROWSER_TRUE = @BUILD_HELPBROWSER_TRUE@
|
||||
BUILD_PRINT_FALSE = @BUILD_PRINT_FALSE@
|
||||
BUILD_PRINT_TRUE = @BUILD_PRINT_TRUE@
|
||||
BUILD_PYTHON_FALSE = @BUILD_PYTHON_FALSE@
|
||||
BUILD_PYTHON_TRUE = @BUILD_PYTHON_TRUE@
|
||||
BUILD_XJT_FALSE = @BUILD_XJT_FALSE@
|
||||
BUILD_XJT_TRUE = @BUILD_XJT_TRUE@
|
||||
CATALOGS = @CATALOGS@
|
||||
CATOBJEXT = @CATOBJEXT@
|
||||
CC = @CC@
|
||||
CCAS = @CCAS@
|
||||
CCASFLAGS = @CCASFLAGS@
|
||||
CCDEPMODE = @CCDEPMODE@
|
||||
CFLAGS = @CFLAGS@
|
||||
CPP = @CPP@
|
||||
CPPFLAGS = @CPPFLAGS@
|
||||
CXX = @CXX@
|
||||
CXXCPP = @CXXCPP@
|
||||
CXXDEPMODE = @CXXDEPMODE@
|
||||
CXXFLAGS = @CXXFLAGS@
|
||||
CYGPATH_W = @CYGPATH_W@
|
||||
DATADIRNAME = @DATADIRNAME@
|
||||
DEFAULT_BINARY_FALSE = @DEFAULT_BINARY_FALSE@
|
||||
DEFAULT_BINARY_TRUE = @DEFAULT_BINARY_TRUE@
|
||||
DEFS = @DEFS@
|
||||
DEPDIR = @DEPDIR@
|
||||
DESKTOP_DATADIR = @DESKTOP_DATADIR@
|
||||
DESKTOP_DATADIR_FALSE = @DESKTOP_DATADIR_FALSE@
|
||||
DESKTOP_DATADIR_TRUE = @DESKTOP_DATADIR_TRUE@
|
||||
DLLTOOL = @DLLTOOL@
|
||||
ECHO = @ECHO@
|
||||
ECHO_C = @ECHO_C@
|
||||
ECHO_N = @ECHO_N@
|
||||
ECHO_T = @ECHO_T@
|
||||
EGREP = @EGREP@
|
||||
ENABLE_GIMP_CONSOLE_FALSE = @ENABLE_GIMP_CONSOLE_FALSE@
|
||||
ENABLE_GIMP_CONSOLE_TRUE = @ENABLE_GIMP_CONSOLE_TRUE@
|
||||
ENABLE_GTK_DOC_FALSE = @ENABLE_GTK_DOC_FALSE@
|
||||
ENABLE_GTK_DOC_TRUE = @ENABLE_GTK_DOC_TRUE@
|
||||
EXEEXT = @EXEEXT@
|
||||
EXIF_CFLAGS = @EXIF_CFLAGS@
|
||||
EXIF_LIBS = @EXIF_LIBS@
|
||||
F77 = @F77@
|
||||
FFLAGS = @FFLAGS@
|
||||
FONTCONFIG_CFLAGS = @FONTCONFIG_CFLAGS@
|
||||
FONTCONFIG_LIBS = @FONTCONFIG_LIBS@
|
||||
FONTCONFIG_REQUIRED_VERSION = @FONTCONFIG_REQUIRED_VERSION@
|
||||
FREETYPE_CONFIG = @FREETYPE_CONFIG@
|
||||
FREETYPE_LIBS = @FREETYPE_LIBS@
|
||||
GDK_PIXBUF_CFLAGS = @GDK_PIXBUF_CFLAGS@
|
||||
GDK_PIXBUF_CSOURCE = @GDK_PIXBUF_CSOURCE@
|
||||
GDK_PIXBUF_LIBS = @GDK_PIXBUF_LIBS@
|
||||
GDK_PIXBUF_REQUIRED_VERSION = @GDK_PIXBUF_REQUIRED_VERSION@
|
||||
GETTEXT_PACKAGE = @GETTEXT_PACKAGE@
|
||||
GIMPINSTALL = @GIMPINSTALL@
|
||||
GIMPPRINT_CFLAGS = @GIMPPRINT_CFLAGS@
|
||||
GIMPPRINT_CONFIG = @GIMPPRINT_CONFIG@
|
||||
GIMPPRINT_LIBS = @GIMPPRINT_LIBS@
|
||||
GIMPPRINT_REQUIRED_VERSION = @GIMPPRINT_REQUIRED_VERSION@
|
||||
GIMPPRINT_TOONEW_VERSION = @GIMPPRINT_TOONEW_VERSION@
|
||||
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@
|
||||
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_USER_VERSION = @GIMP_USER_VERSION@
|
||||
GIMP_VERSION = @GIMP_VERSION@
|
||||
GLIB_CFLAGS = @GLIB_CFLAGS@
|
||||
GLIB_GENMARSHAL = @GLIB_GENMARSHAL@
|
||||
GLIB_LIBS = @GLIB_LIBS@
|
||||
GLIB_MKENUMS = @GLIB_MKENUMS@
|
||||
GLIB_REQUIRED_VERSION = @GLIB_REQUIRED_VERSION@
|
||||
GMODULE_CFLAGS = @GMODULE_CFLAGS@
|
||||
GMODULE_LIBS = @GMODULE_LIBS@
|
||||
GMOFILES = @GMOFILES@
|
||||
GMSGFMT = @GMSGFMT@
|
||||
GOBJECT_QUERY = @GOBJECT_QUERY@
|
||||
GTKDOC_REQUIRED_VERSION = @GTKDOC_REQUIRED_VERSION@
|
||||
GTKHTML2_CFLAGS = @GTKHTML2_CFLAGS@
|
||||
GTKHTML2_LIBS = @GTKHTML2_LIBS@
|
||||
GTKHTML2_REQUIRED_VERSION = @GTKHTML2_REQUIRED_VERSION@
|
||||
GTK_CFLAGS = @GTK_CFLAGS@
|
||||
GTK_DOC_USE_LIBTOOL_FALSE = @GTK_DOC_USE_LIBTOOL_FALSE@
|
||||
GTK_DOC_USE_LIBTOOL_TRUE = @GTK_DOC_USE_LIBTOOL_TRUE@
|
||||
GTK_LIBS = @GTK_LIBS@
|
||||
GTK_REQUIRED_VERSION = @GTK_REQUIRED_VERSION@
|
||||
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_ISFINITE = @HAVE_ISFINITE@
|
||||
HAVE_LCMS_FALSE = @HAVE_LCMS_FALSE@
|
||||
HAVE_LCMS_TRUE = @HAVE_LCMS_TRUE@
|
||||
HAVE_LINUX_INPUT_FALSE = @HAVE_LINUX_INPUT_FALSE@
|
||||
HAVE_LINUX_INPUT_TRUE = @HAVE_LINUX_INPUT_TRUE@
|
||||
HAVE_MAC_TWAIN_FALSE = @HAVE_MAC_TWAIN_FALSE@
|
||||
HAVE_MAC_TWAIN_TRUE = @HAVE_MAC_TWAIN_TRUE@
|
||||
HAVE_WINDRES_FALSE = @HAVE_WINDRES_FALSE@
|
||||
HAVE_WINDRES_TRUE = @HAVE_WINDRES_TRUE@
|
||||
HAVE_XMLLINT_FALSE = @HAVE_XMLLINT_FALSE@
|
||||
HAVE_XMLLINT_TRUE = @HAVE_XMLLINT_TRUE@
|
||||
HAVE_XSLTPROC_FALSE = @HAVE_XSLTPROC_FALSE@
|
||||
HAVE_XSLTPROC_TRUE = @HAVE_XSLTPROC_TRUE@
|
||||
HTML_DIR = @HTML_DIR@
|
||||
INSTALL_DATA = @INSTALL_DATA@
|
||||
INSTALL_PROGRAM = @INSTALL_PROGRAM@
|
||||
INSTALL_SCRIPT = @INSTALL_SCRIPT@
|
||||
INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
|
||||
INSTOBJEXT = @INSTOBJEXT@
|
||||
INTLLIBS = @INTLLIBS@
|
||||
INTLTOOL_CAVES_RULE = @INTLTOOL_CAVES_RULE@
|
||||
INTLTOOL_DESKTOP_RULE = @INTLTOOL_DESKTOP_RULE@
|
||||
INTLTOOL_DIRECTORY_RULE = @INTLTOOL_DIRECTORY_RULE@
|
||||
INTLTOOL_EXTRACT = @INTLTOOL_EXTRACT@
|
||||
INTLTOOL_ICONV = @INTLTOOL_ICONV@
|
||||
INTLTOOL_KBD_RULE = @INTLTOOL_KBD_RULE@
|
||||
INTLTOOL_KEYS_RULE = @INTLTOOL_KEYS_RULE@
|
||||
INTLTOOL_MERGE = @INTLTOOL_MERGE@
|
||||
INTLTOOL_MSGFMT = @INTLTOOL_MSGFMT@
|
||||
INTLTOOL_MSGMERGE = @INTLTOOL_MSGMERGE@
|
||||
INTLTOOL_OAF_RULE = @INTLTOOL_OAF_RULE@
|
||||
INTLTOOL_PERL = @INTLTOOL_PERL@
|
||||
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_SHEET_RULE = @INTLTOOL_SHEET_RULE@
|
||||
INTLTOOL_SOUNDLIST_RULE = @INTLTOOL_SOUNDLIST_RULE@
|
||||
INTLTOOL_THEME_RULE = @INTLTOOL_THEME_RULE@
|
||||
INTLTOOL_UI_RULE = @INTLTOOL_UI_RULE@
|
||||
INTLTOOL_UPDATE = @INTLTOOL_UPDATE@
|
||||
INTLTOOL_XAM_RULE = @INTLTOOL_XAM_RULE@
|
||||
INTLTOOL_XGETTEXT = @INTLTOOL_XGETTEXT@
|
||||
INTLTOOL_XML_NOMERGE_RULE = @INTLTOOL_XML_NOMERGE_RULE@
|
||||
INTLTOOL_XML_RULE = @INTLTOOL_XML_RULE@
|
||||
JPEG = @JPEG@
|
||||
LCMS_LIBS = @LCMS_LIBS@
|
||||
LDFLAGS = @LDFLAGS@
|
||||
LIBAA = @LIBAA@
|
||||
LIBART_CFLAGS = @LIBART_CFLAGS@
|
||||
LIBART_LIBS = @LIBART_LIBS@
|
||||
LIBJPEG = @LIBJPEG@
|
||||
LIBMNG = @LIBMNG@
|
||||
LIBOBJS = @LIBOBJS@
|
||||
LIBPNG = @LIBPNG@
|
||||
LIBS = @LIBS@
|
||||
LIBSCREENSHOT = @LIBSCREENSHOT@
|
||||
LIBSVG = @LIBSVG@
|
||||
LIBTIFF = @LIBTIFF@
|
||||
LIBTOOL = @LIBTOOL@
|
||||
LIBWMF = @LIBWMF@
|
||||
LIBXMU = @LIBXMU@
|
||||
LIBXPM = @LIBXPM@
|
||||
LIBZ = @LIBZ@
|
||||
LN_S = @LN_S@
|
||||
LTLIBOBJS = @LTLIBOBJS@
|
||||
LT_CURRENT_MINUS_AGE = @LT_CURRENT_MINUS_AGE@
|
||||
LT_VERSION_INFO = @LT_VERSION_INFO@
|
||||
MAIL = @MAIL@
|
||||
MAINT = @MAINT@
|
||||
MAINTAINER_MODE_FALSE = @MAINTAINER_MODE_FALSE@
|
||||
MAINTAINER_MODE_TRUE = @MAINTAINER_MODE_TRUE@
|
||||
MAKEINFO = @MAKEINFO@
|
||||
MKINSTALLDIRS = @MKINSTALLDIRS@
|
||||
MNG = @MNG@
|
||||
MSGFMT = @MSGFMT@
|
||||
MS_LIB_AVAILABLE_FALSE = @MS_LIB_AVAILABLE_FALSE@
|
||||
MS_LIB_AVAILABLE_TRUE = @MS_LIB_AVAILABLE_TRUE@
|
||||
OBJDUMP = @OBJDUMP@
|
||||
OBJEXT = @OBJEXT@
|
||||
OS_UNIX_FALSE = @OS_UNIX_FALSE@
|
||||
OS_UNIX_TRUE = @OS_UNIX_TRUE@
|
||||
OS_WIN32_FALSE = @OS_WIN32_FALSE@
|
||||
OS_WIN32_TRUE = @OS_WIN32_TRUE@
|
||||
PACKAGE = @PACKAGE@
|
||||
PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@
|
||||
PACKAGE_NAME = @PACKAGE_NAME@
|
||||
PACKAGE_STRING = @PACKAGE_STRING@
|
||||
PACKAGE_TARNAME = @PACKAGE_TARNAME@
|
||||
PACKAGE_VERSION = @PACKAGE_VERSION@
|
||||
PANGOFT2_CFLAGS = @PANGOFT2_CFLAGS@
|
||||
PANGOFT2_LIBS = @PANGOFT2_LIBS@
|
||||
PANGOFT2_REQUIRED_VERSION = @PANGOFT2_REQUIRED_VERSION@
|
||||
PATHSEP = @PATHSEP@
|
||||
PATH_SEPARATOR = @PATH_SEPARATOR@
|
||||
PERL = @PERL@
|
||||
PKG_CONFIG = @PKG_CONFIG@
|
||||
PLATFORM_WIN32_FALSE = @PLATFORM_WIN32_FALSE@
|
||||
PLATFORM_WIN32_TRUE = @PLATFORM_WIN32_TRUE@
|
||||
PNG = @PNG@
|
||||
POFILES = @POFILES@
|
||||
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@
|
||||
PYGIMP_EXTRA_CFLAGS = @PYGIMP_EXTRA_CFLAGS@
|
||||
PYGTK_CFLAGS = @PYGTK_CFLAGS@
|
||||
PYGTK_LIBS = @PYGTK_LIBS@
|
||||
PYTHON = @PYTHON@
|
||||
PYTHON_EXEC_PREFIX = @PYTHON_EXEC_PREFIX@
|
||||
PYTHON_INCLUDES = @PYTHON_INCLUDES@
|
||||
PYTHON_PLATFORM = @PYTHON_PLATFORM@
|
||||
PYTHON_PREFIX = @PYTHON_PREFIX@
|
||||
PYTHON_VERSION = @PYTHON_VERSION@
|
||||
RANLIB = @RANLIB@
|
||||
RSVG_REQUIRED_VERSION = @RSVG_REQUIRED_VERSION@
|
||||
RT_LIBS = @RT_LIBS@
|
||||
SCREENSHOT = @SCREENSHOT@
|
||||
SENDMAIL = @SENDMAIL@
|
||||
SET_MAKE = @SET_MAKE@
|
||||
SHELL = @SHELL@
|
||||
SOCKET_LIBS = @SOCKET_LIBS@
|
||||
STATICLIBS_FALSE = @STATICLIBS_FALSE@
|
||||
STATICLIBS_TRUE = @STATICLIBS_TRUE@
|
||||
STRIP = @STRIP@
|
||||
SVG = @SVG@
|
||||
SVG_CFLAGS = @SVG_CFLAGS@
|
||||
SVG_LIBS = @SVG_LIBS@
|
||||
SYMPREFIX = @SYMPREFIX@
|
||||
TIFF = @TIFF@
|
||||
URL = @URL@
|
||||
USE_NLS = @USE_NLS@
|
||||
VERSION = @VERSION@
|
||||
WINCLIPBOARD = @WINCLIPBOARD@
|
||||
WINDRES = @WINDRES@
|
||||
WINPRINT = @WINPRINT@
|
||||
WITH_PDBGEN_FALSE = @WITH_PDBGEN_FALSE@
|
||||
WITH_PDBGEN_TRUE = @WITH_PDBGEN_TRUE@
|
||||
WMF = @WMF@
|
||||
WMF_CFLAGS = @WMF_CFLAGS@
|
||||
WMF_CONFIG = @WMF_CONFIG@
|
||||
WMF_REQUIRED_VERSION = @WMF_REQUIRED_VERSION@
|
||||
XGETTEXT = @XGETTEXT@
|
||||
XMLLINT = @XMLLINT@
|
||||
XPM = @XPM@
|
||||
XSLTPROC = @XSLTPROC@
|
||||
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@
|
||||
am__fastdepCC_FALSE = @am__fastdepCC_FALSE@
|
||||
am__fastdepCC_TRUE = @am__fastdepCC_TRUE@
|
||||
am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@
|
||||
am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@
|
||||
am__include = @am__include@
|
||||
am__leading_dot = @am__leading_dot@
|
||||
am__quote = @am__quote@
|
||||
bindir = @bindir@
|
||||
build = @build@
|
||||
build_alias = @build_alias@
|
||||
build_cpu = @build_cpu@
|
||||
build_os = @build_os@
|
||||
build_vendor = @build_vendor@
|
||||
datadir = @datadir@
|
||||
exec_prefix = @exec_prefix@
|
||||
gimpdatadir = @gimpdatadir@
|
||||
gimpdir = @gimpdir@
|
||||
gimpplugindir = @gimpplugindir@
|
||||
gimpsysconfdir = @gimpsysconfdir@
|
||||
host = @host@
|
||||
host_alias = @host_alias@
|
||||
host_cpu = @host_cpu@
|
||||
host_os = @host_os@
|
||||
host_vendor = @host_vendor@
|
||||
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@
|
||||
pkgpyexecdir = @pkgpyexecdir@
|
||||
pkgpythondir = @pkgpythondir@
|
||||
prefix = @prefix@
|
||||
program_transform_name = @program_transform_name@
|
||||
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
|
||||
|
||||
# The top-level SGML file.
|
||||
DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
|
||||
|
||||
# The directory containing the source code.
|
||||
DOC_SOURCE_DIR = $(top_srcdir)/$(DOC_MODULE)
|
||||
|
||||
# Extra options to pass to gtkdoc-scangobj
|
||||
SCANGOBJ_OPTIONS =
|
||||
|
||||
# Extra options to supply to gtkdoc-scan
|
||||
SCAN_OPTIONS =
|
||||
|
||||
# Extra options to supply to gtkdoc-mkdb
|
||||
MKDB_OPTIONS = --sgml-mode --output-format=xml
|
||||
|
||||
# Extra options to supply to gtkdoc-fixref
|
||||
FIXXREF_OPTIONS =
|
||||
|
||||
# Used for dependencies
|
||||
HFILE_GLOB = $(DOC_SOURCE_DIR)/*.h
|
||||
CFILE_GLOB = $(DOC_SOURCE_DIR)/*.c
|
||||
|
||||
# Header files to ignore when scanning
|
||||
IGNORE_HFILES = \
|
||||
gimpbase.h \
|
||||
gimpbase-private.h \
|
||||
gimpwin32-io.h
|
||||
|
||||
|
||||
# Images to copy into HTML directory
|
||||
HTML_IMAGES =
|
||||
|
||||
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
|
||||
content_files =
|
||||
|
||||
# Other files to distribute
|
||||
extra_files =
|
||||
|
||||
# CFLAGS and LDFLAGS for compiling scan program. Only needed
|
||||
# if $(DOC_MODULE).types is non-empty.
|
||||
GTKDOC_CFLAGS =
|
||||
GTKDOC_LIBS =
|
||||
@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS)
|
||||
|
||||
@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS)
|
||||
@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS)
|
||||
@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS)
|
||||
|
||||
# We set GPATH here; this gives us semantics for GNU make
|
||||
# which are more like other make's VPATH, when it comes to
|
||||
# whether a source that is a target of one rule is then
|
||||
# searched for in VPATH/GPATH.
|
||||
#
|
||||
GPATH = $(srcdir)
|
||||
|
||||
TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE)
|
||||
|
||||
|
||||
# Other files to distribute
|
||||
EXTRA_DIST = \
|
||||
$(content_files) \
|
||||
$(HTML_IMAGES) \
|
||||
$(DOC_MAIN_SGML_FILE) \
|
||||
$(DOC_MODULE).types \
|
||||
$(DOC_MODULE)-sections.txt \
|
||||
$(DOC_MODULE)-overrides.txt\
|
||||
version.in
|
||||
|
||||
DOC_STAMPS = scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
|
||||
$(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
|
||||
|
||||
|
||||
SCANOBJ_FILES = \
|
||||
$(DOC_MODULE).args \
|
||||
$(DOC_MODULE).hierarchy \
|
||||
$(DOC_MODULE).interfaces \
|
||||
$(DOC_MODULE).prerequisites \
|
||||
$(DOC_MODULE).signals
|
||||
|
||||
|
||||
CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
|
||||
subdir = devel-docs/libgimpbase
|
||||
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
|
||||
mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
|
||||
CONFIG_HEADER = $(top_builddir)/config.h
|
||||
CONFIG_CLEAN_FILES = version
|
||||
DIST_SOURCES =
|
||||
DIST_COMMON = $(srcdir)/Makefile.in $(top_srcdir)/gtk-doc.make \
|
||||
Makefile.am version.in
|
||||
all: all-am
|
||||
|
||||
.SUFFIXES:
|
||||
$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ Makefile.am $(top_srcdir)/gtk-doc.make $(top_srcdir)/configure.in $(ACLOCAL_M4)
|
||||
cd $(top_srcdir) && \
|
||||
$(AUTOMAKE) --gnu devel-docs/libgimpbase/Makefile
|
||||
Makefile: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.in $(top_builddir)/config.status
|
||||
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)
|
||||
version: $(top_builddir)/config.status version.in
|
||||
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@
|
||||
|
||||
mostlyclean-libtool:
|
||||
-rm -f *.lo
|
||||
|
||||
clean-libtool:
|
||||
-rm -rf .libs _libs
|
||||
|
||||
distclean-libtool:
|
||||
-rm -f libtool
|
||||
uninstall-info-am:
|
||||
tags: TAGS
|
||||
TAGS:
|
||||
|
||||
ctags: CTAGS
|
||||
CTAGS:
|
||||
|
||||
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
|
||||
|
||||
top_distdir = ../..
|
||||
distdir = $(top_distdir)/$(PACKAGE)-$(VERSION)
|
||||
|
||||
distdir: $(DISTFILES)
|
||||
$(mkinstalldirs) $(distdir)/../..
|
||||
@srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \
|
||||
topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \
|
||||
list='$(DISTFILES)'; for file in $$list; do \
|
||||
case $$file in \
|
||||
$(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \
|
||||
$(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \
|
||||
esac; \
|
||||
if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \
|
||||
dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \
|
||||
if test "$$dir" != "$$file" && test "$$dir" != "."; then \
|
||||
dir="/$$dir"; \
|
||||
$(mkinstalldirs) "$(distdir)$$dir"; \
|
||||
else \
|
||||
dir=''; \
|
||||
fi; \
|
||||
if test -d $$d/$$file; then \
|
||||
if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \
|
||||
cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \
|
||||
fi; \
|
||||
cp -pR $$d/$$file $(distdir)$$dir || exit 1; \
|
||||
else \
|
||||
test -f $(distdir)/$$file \
|
||||
|| cp -p $$d/$$file $(distdir)/$$file \
|
||||
|| exit 1; \
|
||||
fi; \
|
||||
done
|
||||
$(MAKE) $(AM_MAKEFLAGS) \
|
||||
top_distdir="$(top_distdir)" distdir="$(distdir)" \
|
||||
dist-hook
|
||||
check-am: all-am
|
||||
check: check-am
|
||||
all-am: Makefile all-local
|
||||
|
||||
installdirs:
|
||||
install: install-am
|
||||
install-exec: install-exec-am
|
||||
install-data: install-data-am
|
||||
uninstall: uninstall-am
|
||||
|
||||
install-am: all-am
|
||||
@$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
|
||||
|
||||
installcheck: installcheck-am
|
||||
install-strip:
|
||||
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
|
||||
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
|
||||
`test -z '$(STRIP)' || \
|
||||
echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
|
||||
mostlyclean-generic:
|
||||
|
||||
clean-generic:
|
||||
-test -z "$(CLEANFILES)" || rm -f $(CLEANFILES)
|
||||
|
||||
distclean-generic:
|
||||
-rm -f $(CONFIG_CLEAN_FILES)
|
||||
|
||||
maintainer-clean-generic:
|
||||
@echo "This command is intended for maintainers to use"
|
||||
@echo "it deletes files that may require special tools to rebuild."
|
||||
clean: clean-am
|
||||
|
||||
clean-am: clean-generic clean-libtool clean-local mostlyclean-am
|
||||
|
||||
distclean: distclean-am
|
||||
-rm -f Makefile
|
||||
distclean-am: clean-am distclean-generic distclean-libtool
|
||||
|
||||
dvi: dvi-am
|
||||
|
||||
dvi-am:
|
||||
|
||||
info: info-am
|
||||
|
||||
info-am:
|
||||
|
||||
install-data-am: install-data-local
|
||||
|
||||
install-exec-am:
|
||||
|
||||
install-info: install-info-am
|
||||
|
||||
install-man:
|
||||
|
||||
installcheck-am:
|
||||
|
||||
maintainer-clean: maintainer-clean-am
|
||||
-rm -f Makefile
|
||||
maintainer-clean-am: distclean-am maintainer-clean-generic \
|
||||
maintainer-clean-local
|
||||
|
||||
mostlyclean: mostlyclean-am
|
||||
|
||||
mostlyclean-am: mostlyclean-generic mostlyclean-libtool
|
||||
|
||||
pdf: pdf-am
|
||||
|
||||
pdf-am:
|
||||
|
||||
ps: ps-am
|
||||
|
||||
ps-am:
|
||||
|
||||
uninstall-am: uninstall-info-am uninstall-local
|
||||
|
||||
.PHONY: all all-am all-local check check-am clean clean-generic \
|
||||
clean-libtool clean-local distclean distclean-generic \
|
||||
distclean-libtool distdir dvi dvi-am info info-am install \
|
||||
install-am install-data install-data-am install-data-local \
|
||||
install-exec install-exec-am install-info install-info-am \
|
||||
install-man install-strip installcheck installcheck-am \
|
||||
installdirs maintainer-clean maintainer-clean-generic \
|
||||
maintainer-clean-local mostlyclean mostlyclean-generic \
|
||||
mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \
|
||||
uninstall-info-am uninstall-local
|
||||
|
||||
|
||||
@ENABLE_GTK_DOC_TRUE@all-local: html-build.stamp
|
||||
|
||||
#### scan ####
|
||||
|
||||
@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 ; 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
|
||||
|
||||
@ENABLE_GTK_DOC_TRUE@$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
|
||||
@ENABLE_GTK_DOC_TRUE@ @true
|
||||
|
||||
#### templates ####
|
||||
|
||||
@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)
|
||||
@ENABLE_GTK_DOC_TRUE@ touch tmpl-build.stamp
|
||||
|
||||
@ENABLE_GTK_DOC_TRUE@tmpl.stamp: tmpl-build.stamp
|
||||
@ENABLE_GTK_DOC_TRUE@ @true
|
||||
|
||||
#### xml ####
|
||||
|
||||
@ENABLE_GTK_DOC_TRUE@sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
|
||||
@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 $(MKDB_OPTIONS)
|
||||
@ENABLE_GTK_DOC_TRUE@ touch sgml-build.stamp
|
||||
|
||||
@ENABLE_GTK_DOC_TRUE@sgml.stamp: sgml-build.stamp
|
||||
@ENABLE_GTK_DOC_TRUE@ @true
|
||||
|
||||
#### html ####
|
||||
|
||||
@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:
|
||||
|
||||
##############
|
||||
|
||||
clean-local:
|
||||
rm -f *~ *.bak
|
||||
rm -rf .libs
|
||||
|
||||
maintainer-clean-local: clean
|
||||
cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
|
||||
|
||||
install-data-local:
|
||||
installfiles=`echo $(srcdir)/html/*`; \
|
||||
if test "$$installfiles" = '$(srcdir)/html/*'; \
|
||||
then echo '-- Nothing to install' ; \
|
||||
else \
|
||||
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
|
||||
for i in $$installfiles; do \
|
||||
echo '-- Installing '$$i ; \
|
||||
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
|
||||
done; \
|
||||
echo '-- Installing $(srcdir)/html/index.sgml' ; \
|
||||
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || :; \
|
||||
fi
|
||||
|
||||
uninstall-local:
|
||||
rm -f $(DESTDIR)$(TARGET_DIR)/*
|
||||
|
||||
#
|
||||
# Require gtk-doc when making dist
|
||||
#
|
||||
@ENABLE_GTK_DOC_TRUE@dist-check-gtkdoc:
|
||||
@ENABLE_GTK_DOC_FALSE@dist-check-gtkdoc:
|
||||
@ENABLE_GTK_DOC_FALSE@ @echo "*** gtk-doc must be installed and enabled in order to make dist"
|
||||
@ENABLE_GTK_DOC_FALSE@ @false
|
||||
|
||||
dist-hook: dist-check-gtkdoc dist-hook-local
|
||||
mkdir $(distdir)/tmpl
|
||||
mkdir $(distdir)/xml
|
||||
mkdir $(distdir)/html
|
||||
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
|
||||
-cp $(srcdir)/xml/*.xml $(distdir)/xml
|
||||
-cp $(srcdir)/html/* $(distdir)/html
|
||||
|
||||
.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:
|
||||
BIN
devel-docs/libgimpbase/html/home.png
Normal file
BIN
devel-docs/libgimpbase/html/home.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 654 B |
7
devel-docs/libgimpbase/html/index.html
Normal file
7
devel-docs/libgimpbase/html/index.html
Normal file
@ -0,0 +1,7 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GIMP Base Library Reference Manual</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="next" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><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.1
|
||||
|
||||
</p></div></div><hr></div><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><a href="libgimpbase-gimpbaseenums.html">gimpbaseenums</a> - Basic GIMP enumeration data types.</dt><dt><a href="libgimpbase-gimpbasetypes.html">gimpbasetypes</a> - Translation between gettext translation domain identifier and GType.</dt><dt><a href="libgimpbase-gimpversion.html">gimpversion</a> - Macros and constants useful for determining GIMP's version number and
|
||||
capabilities.</dt><dt><a href="libgimpbase-gimplimits.html">gimplimits</a> - Boundaries of some GIMP data types and some global constants.</dt><dt><a href="libgimpbase-gimpchecks.html">gimpchecks</a> - Constants and functions related to rendering checkerboards.</dt><dt><a href="libgimpbase-gimpdatafiles.html">gimpdatafiles</a> - Functions to handle GIMP data files.</dt><dt><a href="libgimpbase-gimpenv.html">gimpenv</a> - Functions to access the GIMP environment.</dt><dt><a href="libgimpbase-gimpmemsize.html">gimpmemsize</a> - Functions to (de)serialize a given memory size.</dt><dt><a href="libgimpbase-gimpparasite.html">gimpparasite</a> - Arbitrary pieces of data which can be attached to various GIMP objects.</dt><dt><a href="libgimpbase-gimpparasiteio.html">gimpparasiteio</a> - Utility functions to (de)serialize certain C structures to/from GimpParasite's.</dt><dt><a href="libgimpbase-gimpsignal.html">gimpsignal</a> - Portable signal handling.</dt><dt><a href="libgimpbase-gimpunit.html">gimpunit</a> - Provides a collection of predefined units and functions for creating
|
||||
user-defined units.</dt><dt><a href="libgimpbase-gimputils.html">gimputils</a> - Utilities of general interest</dt><dt><a href="libgimpbase-gimpprotocol.html">gimpprotocol</a> - The communication protocol between GIMP and it's plug-ins.</dt><dt><a href="libgimpbase-gimpwire.html">gimpwire</a> - The lowlevel I/O protocol used for communication between GIMP and
|
||||
it's plug-ins.</dt></dl></dd></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<EFBFBD>I.<2E>GIMP Base Library<72>>></b></a></td></tr></table></body></html>
|
||||
177
devel-docs/libgimpbase/html/index.sgml
Normal file
177
devel-docs/libgimpbase/html/index.sgml
Normal file
@ -0,0 +1,177 @@
|
||||
<ANCHOR id="libgimpbase-gimpbaseenums" href="libgimpbase/libgimpbase-gimpbaseenums.html">
|
||||
<ANCHOR id="GimpCheckSize" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize">
|
||||
<ANCHOR id="GimpCheckType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType">
|
||||
<ANCHOR id="GimpImageBaseType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType">
|
||||
<ANCHOR id="GimpImageType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType">
|
||||
<ANCHOR id="GimpMessageHandlerType" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpMessageHandlerType">
|
||||
<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="GimpStackTraceMode" href="libgimpbase/libgimpbase-gimpbaseenums.html#GimpStackTraceMode">
|
||||
<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">
|
||||
<ANCHOR id="gimp-type-set-translation-domain" href="libgimpbase/libgimpbase-gimpbasetypes.html#gimp-type-set-translation-domain">
|
||||
<ANCHOR id="gimp-type-get-translation-domain" href="libgimpbase/libgimpbase-gimpbasetypes.html#gimp-type-get-translation-domain">
|
||||
<ANCHOR id="gimp-enum-set-value-descriptions" href="libgimpbase/libgimpbase-gimpbasetypes.html#gimp-enum-set-value-descriptions">
|
||||
<ANCHOR id="gimp-enum-get-value-descriptions" href="libgimpbase/libgimpbase-gimpbasetypes.html#gimp-enum-get-value-descriptions">
|
||||
<ANCHOR id="gimp-flags-get-value-descriptions" href="libgimpbase/libgimpbase-gimpbasetypes.html#gimp-flags-get-value-descriptions">
|
||||
<ANCHOR id="gimp-flags-set-value-descriptions" href="libgimpbase/libgimpbase-gimpbasetypes.html#gimp-flags-set-value-descriptions">
|
||||
<ANCHOR id="libgimpbase-gimpversion" href="libgimpbase/libgimpbase-gimpversion.html">
|
||||
<ANCHOR id="GIMP-MAJOR-VERSION:CAPS" href="libgimpbase/libgimpbase-gimpversion.html#GIMP-MAJOR-VERSION:CAPS">
|
||||
<ANCHOR id="GIMP-MINOR-VERSION:CAPS" href="libgimpbase/libgimpbase-gimpversion.html#GIMP-MINOR-VERSION:CAPS">
|
||||
<ANCHOR id="GIMP-MICRO-VERSION:CAPS" href="libgimpbase/libgimpbase-gimpversion.html#GIMP-MICRO-VERSION:CAPS">
|
||||
<ANCHOR id="GIMP-VERSION:CAPS" href="libgimpbase/libgimpbase-gimpversion.html#GIMP-VERSION:CAPS">
|
||||
<ANCHOR id="GIMP-API-VERSION:CAPS" href="libgimpbase/libgimpbase-gimpversion.html#GIMP-API-VERSION:CAPS">
|
||||
<ANCHOR id="GIMP-CHECK-VERSION:CAPS" href="libgimpbase/libgimpbase-gimpversion.html#GIMP-CHECK-VERSION:CAPS">
|
||||
<ANCHOR id="libgimpbase-gimplimits" href="libgimpbase/libgimpbase-gimplimits.html">
|
||||
<ANCHOR id="GIMP-MIN-IMAGE-SIZE:CAPS" href="libgimpbase/libgimpbase-gimplimits.html#GIMP-MIN-IMAGE-SIZE:CAPS">
|
||||
<ANCHOR id="GIMP-MAX-IMAGE-SIZE:CAPS" href="libgimpbase/libgimpbase-gimplimits.html#GIMP-MAX-IMAGE-SIZE:CAPS">
|
||||
<ANCHOR id="GIMP-MIN-RESOLUTION:CAPS" href="libgimpbase/libgimpbase-gimplimits.html#GIMP-MIN-RESOLUTION:CAPS">
|
||||
<ANCHOR id="GIMP-MAX-RESOLUTION:CAPS" href="libgimpbase/libgimpbase-gimplimits.html#GIMP-MAX-RESOLUTION:CAPS">
|
||||
<ANCHOR id="GIMP-MAX-MEMSIZE:CAPS" href="libgimpbase/libgimpbase-gimplimits.html#GIMP-MAX-MEMSIZE:CAPS">
|
||||
<ANCHOR id="libgimpbase-gimpchecks" href="libgimpbase/libgimpbase-gimpchecks.html">
|
||||
<ANCHOR id="GIMP-CHECK-SIZE:CAPS" href="libgimpbase/libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE:CAPS">
|
||||
<ANCHOR id="GIMP-CHECK-SIZE-SM:CAPS" href="libgimpbase/libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE-SM:CAPS">
|
||||
<ANCHOR id="GIMP-CHECK-DARK:CAPS" href="libgimpbase/libgimpbase-gimpchecks.html#GIMP-CHECK-DARK:CAPS">
|
||||
<ANCHOR id="GIMP-CHECK-LIGHT:CAPS" href="libgimpbase/libgimpbase-gimpchecks.html#GIMP-CHECK-LIGHT:CAPS">
|
||||
<ANCHOR id="gimp-checks-get-shades" href="libgimpbase/libgimpbase-gimpchecks.html#gimp-checks-get-shades">
|
||||
<ANCHOR id="libgimpbase-gimpdatafiles" href="libgimpbase/libgimpbase-gimpdatafiles.html">
|
||||
<ANCHOR id="GimpDatafileData" href="libgimpbase/libgimpbase-gimpdatafiles.html#GimpDatafileData">
|
||||
<ANCHOR id="GimpDatafileLoaderFunc" href="libgimpbase/libgimpbase-gimpdatafiles.html#GimpDatafileLoaderFunc">
|
||||
<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-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">
|
||||
<ANCHOR id="gimp-locale-directory" href="libgimpbase/libgimpbase-gimpenv.html#gimp-locale-directory">
|
||||
<ANCHOR id="gimp-plug-in-directory" href="libgimpbase/libgimpbase-gimpenv.html#gimp-plug-in-directory">
|
||||
<ANCHOR id="gimp-sysconf-directory" href="libgimpbase/libgimpbase-gimpenv.html#gimp-sysconf-directory">
|
||||
<ANCHOR id="gimp-gtkrc" href="libgimpbase/libgimpbase-gimpenv.html#gimp-gtkrc">
|
||||
<ANCHOR id="gimp-path-parse" href="libgimpbase/libgimpbase-gimpenv.html#gimp-path-parse">
|
||||
<ANCHOR id="gimp-path-to-str" href="libgimpbase/libgimpbase-gimpenv.html#gimp-path-to-str">
|
||||
<ANCHOR id="gimp-path-free" href="libgimpbase/libgimpbase-gimpenv.html#gimp-path-free">
|
||||
<ANCHOR id="gimp-path-get-user-writable-dir" href="libgimpbase/libgimpbase-gimpenv.html#gimp-path-get-user-writable-dir">
|
||||
<ANCHOR id="libgimpbase-gimpmemsize" href="libgimpbase/libgimpbase-gimpmemsize.html">
|
||||
<ANCHOR id="gimp-memsize-serialize" href="libgimpbase/libgimpbase-gimpmemsize.html#gimp-memsize-serialize">
|
||||
<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-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">
|
||||
<ANCHOR id="gimp-parasite-new" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-new">
|
||||
<ANCHOR id="gimp-parasite-free" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-free">
|
||||
<ANCHOR id="gimp-parasite-copy" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-copy">
|
||||
<ANCHOR id="gimp-parasite-compare" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-compare">
|
||||
<ANCHOR id="gimp-parasite-is-type" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-is-type">
|
||||
<ANCHOR id="gimp-parasite-is-persistent" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-is-persistent">
|
||||
<ANCHOR id="gimp-parasite-is-undoable" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-is-undoable">
|
||||
<ANCHOR id="gimp-parasite-has-flag" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-has-flag">
|
||||
<ANCHOR id="gimp-parasite-flags" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-flags">
|
||||
<ANCHOR id="gimp-parasite-name" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-name">
|
||||
<ANCHOR id="gimp-parasite-data" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-data">
|
||||
<ANCHOR id="gimp-parasite-data-size" href="libgimpbase/libgimpbase-gimpparasite.html#gimp-parasite-data-size">
|
||||
<ANCHOR id="GIMP-PARASITE-PERSISTENT:CAPS" href="libgimpbase/libgimpbase-gimpparasite.html#GIMP-PARASITE-PERSISTENT:CAPS">
|
||||
<ANCHOR id="GIMP-PARASITE-UNDOABLE:CAPS" href="libgimpbase/libgimpbase-gimpparasite.html#GIMP-PARASITE-UNDOABLE:CAPS">
|
||||
<ANCHOR id="GIMP-PARASITE-ATTACH-PARENT:CAPS" href="libgimpbase/libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-PARENT:CAPS">
|
||||
<ANCHOR id="GIMP-PARASITE-PARENT-PERSISTENT:CAPS" href="libgimpbase/libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-PERSISTENT:CAPS">
|
||||
<ANCHOR id="GIMP-PARASITE-PARENT-UNDOABLE:CAPS" href="libgimpbase/libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-UNDOABLE:CAPS">
|
||||
<ANCHOR id="GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS" href="libgimpbase/libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS">
|
||||
<ANCHOR id="GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS" href="libgimpbase/libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS">
|
||||
<ANCHOR id="GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS" href="libgimpbase/libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS">
|
||||
<ANCHOR id="libgimpbase-gimpparasiteio" href="libgimpbase/libgimpbase-gimpparasiteio.html">
|
||||
<ANCHOR id="GIMP-PIXPIPE-MAXDIM:CAPS" href="libgimpbase/libgimpbase-gimpparasiteio.html#GIMP-PIXPIPE-MAXDIM:CAPS">
|
||||
<ANCHOR id="gimp-pixpipe-params-init" href="libgimpbase/libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-init">
|
||||
<ANCHOR id="gimp-pixpipe-params-parse" href="libgimpbase/libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-parse">
|
||||
<ANCHOR id="gimp-pixpipe-params-build" href="libgimpbase/libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-build">
|
||||
<ANCHOR id="libgimpbase-gimpsignal" href="libgimpbase/libgimpbase-gimpsignal.html">
|
||||
<ANCHOR id="GimpSignalHandlerFunc" href="libgimpbase/libgimpbase-gimpsignal.html#GimpSignalHandlerFunc">
|
||||
<ANCHOR id="gimp-signal-private" href="libgimpbase/libgimpbase-gimpsignal.html#gimp-signal-private">
|
||||
<ANCHOR id="libgimpbase-gimpunit" href="libgimpbase/libgimpbase-gimpunit.html">
|
||||
<ANCHOR id="GimpUnit" href="libgimpbase/libgimpbase-gimpunit.html#GimpUnit">
|
||||
<ANCHOR id="gimp-unit-get-number-of-units" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-number-of-units">
|
||||
<ANCHOR id="gimp-unit-get-number-of-built-in-units" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-number-of-built-in-units">
|
||||
<ANCHOR id="gimp-unit-new" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-new">
|
||||
<ANCHOR id="gimp-unit-get-deletion-flag" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-deletion-flag">
|
||||
<ANCHOR id="gimp-unit-set-deletion-flag" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag">
|
||||
<ANCHOR id="gimp-unit-get-factor" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-factor">
|
||||
<ANCHOR id="gimp-unit-get-digits" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-digits">
|
||||
<ANCHOR id="gimp-unit-get-identifier" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-identifier">
|
||||
<ANCHOR id="gimp-unit-get-symbol" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-symbol">
|
||||
<ANCHOR id="gimp-unit-get-abbreviation" href="libgimpbase/libgimpbase-gimpunit.html#gimp-unit-get-abbreviation">
|
||||
<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-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">
|
||||
<ANCHOR id="gimp-filename-to-utf8" href="libgimpbase/libgimpbase-gimputils.html#gimp-filename-to-utf8">
|
||||
<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-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">
|
||||
<ANCHOR id="gimp-enum-value-get-help" href="libgimpbase/libgimpbase-gimputils.html#gimp-enum-value-get-help">
|
||||
<ANCHOR id="gimp-flags-get-first-desc" href="libgimpbase/libgimpbase-gimputils.html#gimp-flags-get-first-desc">
|
||||
<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">
|
||||
BIN
devel-docs/libgimpbase/html/left.png
Normal file
BIN
devel-docs/libgimpbase/html/left.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 459 B |
128
devel-docs/libgimpbase/html/libgimpbase-gimpbaseenums.html
Normal file
128
devel-docs/libgimpbase/html/libgimpbase-gimpbaseenums.html
Normal file
@ -0,0 +1,128 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpbaseenums</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"><link rel="prev" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"><link rel="next" href="libgimpbase-gimpbasetypes.html" title="gimpbasetypes"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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.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></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><span class="refentrytitle">gimpbaseenums</span></h2><p>gimpbaseenums — Basic GIMP enumeration data types.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
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>;
|
||||
|
||||
</pre></div><div class="refsect1" lang="en"><a name="id2469773"></a><h2>Description</h2><p>
|
||||
Basic GIMP enumeration data types.
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2469782"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2469788"></a><h3><a name="GimpCheckSize"></a>enum GimpCheckSize</h3><a class="indexterm" name="id2469796"></a><pre class="programlisting">typedef enum /*< pdb-skip >*/
|
||||
{
|
||||
GIMP_CHECK_SIZE_SMALL_CHECKS = 0, /*< desc="Small" >*/
|
||||
GIMP_CHECK_SIZE_MEDIUM_CHECKS = 1, /*< desc="Medium" >*/
|
||||
GIMP_CHECK_SIZE_LARGE_CHECKS = 2 /*< desc="Large" >*/
|
||||
} GimpCheckSize;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2469810"></a><h3><a name="GimpCheckType"></a>enum GimpCheckType</h3><a class="indexterm" name="id2469818"></a><pre class="programlisting">typedef enum /*< pdb-skip >*/
|
||||
{
|
||||
GIMP_CHECK_TYPE_LIGHT_CHECKS = 0, /*< desc="Light Checks" >*/
|
||||
GIMP_CHECK_TYPE_GRAY_CHECKS = 1, /*< desc="Mid-Tone Checks" >*/
|
||||
GIMP_CHECK_TYPE_DARK_CHECKS = 2, /*< desc="Dark Checks" >*/
|
||||
GIMP_CHECK_TYPE_WHITE_ONLY = 3, /*< desc="White Only" >*/
|
||||
GIMP_CHECK_TYPE_GRAY_ONLY = 4, /*< desc="Gray Only" >*/
|
||||
GIMP_CHECK_TYPE_BLACK_ONLY = 5 /*< desc="Black Only" >*/
|
||||
} GimpCheckType;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2469836"></a><h3><a name="GimpImageBaseType"></a>enum GimpImageBaseType</h3><a class="indexterm" name="id2469844"></a><pre class="programlisting">typedef enum
|
||||
{
|
||||
GIMP_RGB, /*< desc="RGB color" >*/
|
||||
GIMP_GRAY, /*< desc="Grayscale" >*/
|
||||
GIMP_INDEXED /*< desc="Indexed color" >*/
|
||||
} GimpImageBaseType;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2468338"></a><h3><a name="GimpImageType"></a>enum GimpImageType</h3><a class="indexterm" name="id2468346"></a><pre class="programlisting">typedef enum
|
||||
{
|
||||
GIMP_RGB_IMAGE, /*< desc="RGB" >*/
|
||||
GIMP_RGBA_IMAGE, /*< desc="RGB-alpha" >*/
|
||||
GIMP_GRAY_IMAGE, /*< desc="Grayscale" >*/
|
||||
GIMP_GRAYA_IMAGE, /*< desc="Grayscale-alpha" >*/
|
||||
GIMP_INDEXED_IMAGE, /*< desc="Indexed" >*/
|
||||
GIMP_INDEXEDA_IMAGE /*< desc="Indexed-alpha" >*/
|
||||
} GimpImageType;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2468362"></a><h3><a name="GimpMessageHandlerType"></a>enum GimpMessageHandlerType</h3><a class="indexterm" name="id2468370"></a><pre class="programlisting">typedef enum
|
||||
{
|
||||
GIMP_MESSAGE_BOX,
|
||||
GIMP_CONSOLE,
|
||||
GIMP_ERROR_CONSOLE
|
||||
} GimpMessageHandlerType;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2468382"></a><h3><a name="GimpPDBArgType"></a>enum GimpPDBArgType</h3><a class="indexterm" name="id2468390"></a><pre class="programlisting">typedef enum
|
||||
{
|
||||
GIMP_PDB_INT32,
|
||||
GIMP_PDB_INT16,
|
||||
GIMP_PDB_INT8,
|
||||
GIMP_PDB_FLOAT,
|
||||
GIMP_PDB_STRING,
|
||||
GIMP_PDB_INT32ARRAY,
|
||||
GIMP_PDB_INT16ARRAY,
|
||||
GIMP_PDB_INT8ARRAY,
|
||||
GIMP_PDB_FLOATARRAY,
|
||||
GIMP_PDB_STRINGARRAY,
|
||||
GIMP_PDB_COLOR,
|
||||
GIMP_PDB_REGION,
|
||||
GIMP_PDB_DISPLAY,
|
||||
GIMP_PDB_IMAGE,
|
||||
GIMP_PDB_LAYER,
|
||||
GIMP_PDB_CHANNEL,
|
||||
GIMP_PDB_DRAWABLE,
|
||||
GIMP_PDB_SELECTION,
|
||||
GIMP_PDB_BOUNDARY,
|
||||
GIMP_PDB_PATH,
|
||||
GIMP_PDB_PARASITE,
|
||||
GIMP_PDB_STATUS,
|
||||
GIMP_PDB_END
|
||||
} GimpPDBArgType;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2468408"></a><h3><a name="GimpPDBProcType"></a>enum GimpPDBProcType</h3><a class="indexterm" name="id2468416"></a><pre class="programlisting">typedef enum
|
||||
{
|
||||
GIMP_INTERNAL,
|
||||
GIMP_PLUGIN,
|
||||
GIMP_EXTENSION,
|
||||
GIMP_TEMPORARY
|
||||
} GimpPDBProcType;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2468428"></a><h3><a name="GimpPDBStatusType"></a>enum GimpPDBStatusType</h3><a class="indexterm" name="id2468436"></a><pre class="programlisting">typedef enum
|
||||
{
|
||||
GIMP_PDB_EXECUTION_ERROR,
|
||||
GIMP_PDB_CALLING_ERROR,
|
||||
GIMP_PDB_PASS_THROUGH,
|
||||
GIMP_PDB_SUCCESS,
|
||||
GIMP_PDB_CANCEL
|
||||
} GimpPDBStatusType;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2468448"></a><h3><a name="GimpProgressCommand"></a>enum GimpProgressCommand</h3><a class="indexterm" name="id2468457"></a><pre class="programlisting">typedef enum
|
||||
{
|
||||
GIMP_PROGRESS_COMMAND_START,
|
||||
GIMP_PROGRESS_COMMAND_END,
|
||||
GIMP_PROGRESS_COMMAND_SET_TEXT,
|
||||
GIMP_PROGRESS_COMMAND_SET_VALUE
|
||||
} GimpProgressCommand;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2468469"></a><h3><a name="GimpStackTraceMode"></a>enum GimpStackTraceMode</h3><a class="indexterm" name="id2468478"></a><pre class="programlisting">typedef enum
|
||||
{
|
||||
GIMP_STACK_TRACE_NEVER,
|
||||
GIMP_STACK_TRACE_QUERY,
|
||||
GIMP_STACK_TRACE_ALWAYS
|
||||
} GimpStackTraceMode;
|
||||
</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><<<EFBFBD>Part<EFBFBD>I.<2E>GIMP Base Library</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpbasetypes.html"><b>gimpbasetypes<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
97
devel-docs/libgimpbase/html/libgimpbase-gimpbasetypes.html
Normal file
97
devel-docs/libgimpbase/html/libgimpbase-gimpbasetypes.html
Normal file
@ -0,0 +1,97 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpbasetypes</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpbasetypes</span></h2><p>gimpbasetypes — Translation between gettext translation domain identifier and GType.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
<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="id2564164"></a><h2>Description</h2><p>
|
||||
Translation between gettext translation domain identifier and GType.
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2564174"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2564180"></a><h3><a name="GimpEnumDesc"></a>GimpEnumDesc</h3><a class="indexterm" name="id2564188"></a><pre class="programlisting">typedef struct {
|
||||
gint value;
|
||||
gchar *value_desc;
|
||||
gchar *value_help;
|
||||
} GimpEnumDesc;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2544622"></a><h3><a name="GimpFlagsDesc"></a>GimpFlagsDesc</h3><a class="indexterm" name="id2544630"></a><pre class="programlisting">typedef struct {
|
||||
guint value;
|
||||
gchar *value_desc;
|
||||
gchar *value_help;
|
||||
} GimpFlagsDesc;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2544642"></a><h3><a name="gimp-type-set-translation-domain"></a>gimp_type_set_translation_domain ()</h3><a class="indexterm" name="id2544653"></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
|
||||
to use it when registering a <span class="type">GTypeEnum</span> with translatable value
|
||||
names.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>type</tt></i><EFBFBD>:</span></td><td> a <span class="type">GType</span>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>domain</tt></i><EFBFBD>:</span></td><td> a constant string that identifies a translation domain or <tt class="literal">NULL</tt>
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2544740"></a><h3><a name="gimp-type-get-translation-domain"></a>gimp_type_get_translation_domain ()</h3><a class="indexterm" name="id2544751"></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"><tt class="function">gimp_type_set_translation_domain()</tt></a>. You should
|
||||
not need to use this function directly, use <a href="libgimpbase-gimputils.html#gimp-enum-get-value"><tt class="function">gimp_enum_get_value()</tt></a>
|
||||
or <tt class="function">gimp_enum_value_get_name()</tt> instead.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>type</tt></i><EFBFBD>:</span></td><td> a <span class="type">GType</span>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> the translation domain associated with <i class="parameter"><tt>type</tt></i>
|
||||
or <tt class="literal">NULL</tt> if no domain was set
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2568038"></a><h3><a name="gimp-enum-set-value-descriptions"></a>gimp_enum_set_value_descriptions ()</h3><a class="indexterm" name="id2568049"></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><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>enum_type</tt></i><EFBFBD>:</span></td><td> a <span class="type">GType</span>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>descriptions</tt></i><EFBFBD>:</span></td><td> a <tt class="literal">NULL</tt> terminated constant static array of <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2568126"></a><h3><a name="gimp-enum-get-value-descriptions"></a>gimp_enum_get_value_descriptions ()</h3><a class="indexterm" name="id2568138"></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><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>enum_type</tt></i><EFBFBD>:</span></td><td> a <span class="type">GType</span>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> a <tt class="literal">NULL</tt> terminated constant array of <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2568721"></a><h3><a name="gimp-flags-get-value-descriptions"></a>gimp_flags_get_value_descriptions ()</h3><a class="indexterm" name="id2568731"></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><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>flags_type</tt></i><EFBFBD>:</span></td><td> a <span class="type">GType</span>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> a <tt class="literal">NULL</tt> terminated constant array of <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2568803"></a><h3><a name="gimp-flags-set-value-descriptions"></a>gimp_flags_set_value_descriptions ()</h3><a class="indexterm" name="id2568814"></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><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>flags_type</tt></i><EFBFBD>:</span></td><td> a <span class="type">GType</span>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>descriptions</tt></i><EFBFBD>:</span></td><td> a <tt class="literal">NULL</tt> terminated constant static array of <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>
|
||||
</td></tr></tbody></table></div><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><<<EFBFBD>gimpbaseenums</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpversion.html"><b>gimpversion<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
38
devel-docs/libgimpbase/html/libgimpbase-gimpchecks.html
Normal file
38
devel-docs/libgimpbase/html/libgimpbase-gimpchecks.html
Normal file
@ -0,0 +1,38 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpchecks</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpchecks</span></h2><p>gimpchecks — Constants and functions related to rendering checkerboards.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
#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="id2581674"></a><h2>Description</h2><p>
|
||||
Constants and functions related to rendering checkerboards.
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2538059"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2538065"></a><h3><a name="GIMP-CHECK-SIZE:CAPS"></a>GIMP_CHECK_SIZE</h3><a class="indexterm" name="id2538072"></a><pre class="programlisting">#define GIMP_CHECK_SIZE 8
|
||||
</pre><p>
|
||||
The default checkerboard size in pixels. This is configurable in the
|
||||
core but GIMP plug-ins can't access the user preference and should use
|
||||
this constant instead.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2538085"></a><h3><a name="GIMP-CHECK-SIZE-SM:CAPS"></a>GIMP_CHECK_SIZE_SM</h3><a class="indexterm" name="id2538093"></a><pre class="programlisting">#define GIMP_CHECK_SIZE_SM 4
|
||||
</pre><p>
|
||||
The default small checkerboard size in pixels.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2538104"></a><h3><a name="GIMP-CHECK-DARK:CAPS"></a>GIMP_CHECK_DARK</h3><a class="indexterm" name="id2538112"></a><pre class="programlisting">#define GIMP_CHECK_DARK 0.4
|
||||
</pre><p>
|
||||
The dark gray value for the default checkerboard pattern.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2538123"></a><h3><a name="GIMP-CHECK-LIGHT:CAPS"></a>GIMP_CHECK_LIGHT</h3><a class="indexterm" name="id2538131"></a><pre class="programlisting">#define GIMP_CHECK_LIGHT 0.6
|
||||
</pre><p>
|
||||
The light gray value for the default checkerboard pattern.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2538142"></a><h3><a name="gimp-checks-get-shades"></a>gimp_checks_get_shades ()</h3><a class="indexterm" name="id2538151"></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><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>type</tt></i><EFBFBD>:</span></td><td> the checkerboard type
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>light</tt></i><EFBFBD>:</span></td><td> return location for the light shade
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dark</tt></i><EFBFBD>:</span></td><td> return location for the dark shade
|
||||
</td></tr></tbody></table></div><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><<<EFBFBD>gimplimits</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpdatafiles.html"><b>gimpdatafiles<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
53
devel-docs/libgimpbase/html/libgimpbase-gimpdatafiles.html
Normal file
53
devel-docs/libgimpbase/html/libgimpbase-gimpdatafiles.html
Normal file
@ -0,0 +1,53 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpdatafiles</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpdatafiles</span></h2><p>gimpdatafiles — Functions to handle GIMP data files.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
<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="id2565402"></a><h2>Description</h2><p>
|
||||
Functions to handle GIMP data files.
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2565412"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2565417"></a><h3><a name="GimpDatafileData"></a>GimpDatafileData</h3><a class="indexterm" name="id2565426"></a><pre class="programlisting">typedef struct {
|
||||
const gchar *filename;
|
||||
const gchar *dirname;
|
||||
const gchar *basename;
|
||||
|
||||
time_t atime;
|
||||
time_t mtime;
|
||||
time_t ctime;
|
||||
} GimpDatafileData;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2565438"></a><h3><a name="GimpDatafileLoaderFunc"></a>GimpDatafileLoaderFunc ()</h3><a class="indexterm" name="id2565447"></a><pre class="programlisting">void (*GimpDatafileLoaderFunc) (const <a href="libgimpbase-gimpdatafiles.html#GimpDatafileData">GimpDatafileData</a> *file_data,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>file_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581895"></a><h3><a name="gimp-datafiles-check-extension"></a>gimp_datafiles_check_extension ()</h3><a class="indexterm" name="id2581906"></a><pre class="programlisting">gboolean gimp_datafiles_check_extension (const gchar *filename,
|
||||
const gchar *extension);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>extension</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2581967"></a><h3><a name="gimp-datafiles-read-directories"></a>gimp_datafiles_read_directories ()</h3><a class="indexterm" name="id2581978"></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><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>path_str</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>flags</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>loader_func</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></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="libgimpbase-gimpchecks.html"><b><<<EFBFBD>gimpchecks</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpenv.html"><b>gimpenv<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
141
devel-docs/libgimpbase/html/libgimpbase-gimpenv.html
Normal file
141
devel-docs/libgimpbase/html/libgimpbase-gimpenv.html
Normal file
@ -0,0 +1,141 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpenv</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpenv</span></h2><p>gimpenv — Functions to access the GIMP environment.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
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="id2528565"></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="id2582154"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2582159"></a><h3><a name="gimp-directory"></a>gimp_directory ()</h3><a class="indexterm" name="id2582168"></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
|
||||
an absolute path, it is used as is. If it is a relative path, it
|
||||
is taken to be a subdirectory of the home directory. If it is a
|
||||
relative path, and no home directory can be determined, it is taken
|
||||
to be a subdirectory of <a href="libgimpbase-gimpenv.html#gimp-data-directory"><tt class="function">gimp_data_directory()</tt></a>.
|
||||
</p><p>
|
||||
The usual case is that no GIMP2_DIRECTORY environment variable
|
||||
exists, and then we use the GIMPDIR subdirectory of the home
|
||||
directory. If no home directory exists, we use a per-user
|
||||
subdirectory of <a href="libgimpbase-gimpenv.html#gimp-data-directory"><tt class="function">gimp_data_directory()</tt></a>. In any case, we always
|
||||
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 <tt class="function">g_free()</tt>. 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><EFBFBD>:</span></td><td> The user-specific GIMP settings directory.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582241"></a><h3><a name="gimp-personal-rc-file"></a>gimp_personal_rc_file ()</h3><a class="indexterm" name="id2582249"></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><p>
|
||||
The returned string is allocated dynamically and *SHOULD* be freed
|
||||
with <tt class="function">g_free()</tt> after use. 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"><i class="parameter"><tt>basename</tt></i><EFBFBD>:</span></td><td> The basename of a rc_file.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The name of a file in the user-specific GIMP settings directory.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573625"></a><h3><a name="gimp-data-directory"></a>gimp_data_directory ()</h3><a class="indexterm" name="id2573634"></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
|
||||
absolute pathname. Otherwise, on Unix the compile-time 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 <tt class="function">g_free()</tt>. 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><EFBFBD>:</span></td><td> The top directory for GIMP data.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573682"></a><h3><a name="gimp-locale-directory"></a>gimp_locale_directory ()</h3><a class="indexterm" name="id2573691"></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
|
||||
absolute pathname. Otherwise, on Unix the compile-time 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 <tt class="function">g_free()</tt>. 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><EFBFBD>:</span></td><td> The top directory for GIMP locale files.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573741"></a><h3><a name="gimp-plug-in-directory"></a>gimp_plug_in_directory ()</h3><a class="indexterm" name="id2573749"></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
|
||||
should be an absolute pathname. Otherwise, on Unix the compile-time
|
||||
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 <tt class="function">g_free()</tt>. 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><EFBFBD>:</span></td><td> The top directory for GIMP plug_ins and modules.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2573801"></a><h3><a name="gimp-sysconf-directory"></a>gimp_sysconf_directory ()</h3><a class="indexterm" name="id2573809"></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
|
||||
absolute pathname. Otherwise, on Unix the compile-time 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 <tt class="function">g_free()</tt>. 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><EFBFBD>:</span></td><td> The top directory for GIMP config files.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576008"></a><h3><a name="gimp-gtkrc"></a>gimp_gtkrc ()</h3><a class="indexterm" name="id2576017"></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 <tt class="function">g_free()</tt>. 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><EFBFBD>:</span></td><td> The name of the GIMP's application-specific gtkrc file.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576065"></a><h3><a name="gimp-path-parse"></a>gimp_path_parse ()</h3><a class="indexterm" name="id2576073"></a><pre class="programlisting">GList* gimp_path_parse (const gchar *path,
|
||||
gint max_paths,
|
||||
gboolean check,
|
||||
GList **check_failed);</pre><p>
|
||||
</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>path</tt></i><EFBFBD>:</span></td><td> A list of directories separated by <span class="type">G_SEARCHPATH_SEPARATOR</span>.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>max_paths</tt></i><EFBFBD>:</span></td><td> The maximum number of directories to return.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>check</tt></i><EFBFBD>:</span></td><td> <tt class="literal">TRUE</tt> if you want the directories to be checked.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>check_failed</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> A <span class="type">GList</span> of all directories in <i class="parameter"><tt>path</tt></i>.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2576201"></a><h3><a name="gimp-path-to-str"></a>gimp_path_to_str ()</h3><a class="indexterm" name="id2576209"></a><pre class="programlisting">gchar* gimp_path_to_str (GList *path);</pre><p>
|
||||
</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>path</tt></i><EFBFBD>:</span></td><td> A list of directories as returned by <a href="libgimpbase-gimpenv.html#gimp-path-parse"><tt class="function">gimp_path_parse()</tt></a>.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> A searchpath string separated by <span class="type">G_SEARCHPATH_SEPARATOR</span>.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583838"></a><h3><a name="gimp-path-free"></a>gimp_path_free ()</h3><a class="indexterm" name="id2583846"></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><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>path</tt></i><EFBFBD>:</span></td><td> A list of directories as returned by <a href="libgimpbase-gimpenv.html#gimp-path-parse"><tt class="function">gimp_path_parse()</tt></a>.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583892"></a><h3><a name="gimp-path-get-user-writable-dir"></a>gimp_path_get_user_writable_dir ()</h3><a class="indexterm" name="id2583903"></a><pre class="programlisting">gchar* gimp_path_get_user_writable_dir (GList *path);</pre><p>
|
||||
Note that you have to <tt class="function">g_free()</tt> the returned string.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>path</tt></i><EFBFBD>:</span></td><td> A list of directories as returned by <a href="libgimpbase-gimpenv.html#gimp-path-parse"><tt class="function">gimp_path_parse()</tt></a>.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The first directory in <i class="parameter"><tt>path</tt></i> where the user has write permission.
|
||||
</td></tr></tbody></table></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="libgimpbase-gimpdatafiles.html"><b><<<EFBFBD>gimpdatafiles</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpmemsize.html"><b>gimpmemsize<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
40
devel-docs/libgimpbase/html/libgimpbase-gimplimits.html
Normal file
40
devel-docs/libgimpbase/html/libgimpbase-gimplimits.html
Normal file
@ -0,0 +1,40 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimplimits</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimplimits</span></h2><p>gimplimits — Boundaries of some GIMP data types and some global constants.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
#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="id2532666"></a><h2>Description</h2><p>
|
||||
Boundaries of some GIMP data types and some global constants.
|
||||
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2575989"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2575994"></a><h3><a name="GIMP-MIN-IMAGE-SIZE:CAPS"></a>GIMP_MIN_IMAGE_SIZE</h3><a class="indexterm" name="id2538216"></a><pre class="programlisting">#define GIMP_MIN_IMAGE_SIZE 1
|
||||
</pre><p>
|
||||
The minimum width and height of a GIMP image in pixels.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2538226"></a><h3><a name="GIMP-MAX-IMAGE-SIZE:CAPS"></a>GIMP_MAX_IMAGE_SIZE</h3><a class="indexterm" name="id2538235"></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
|
||||
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.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2538249"></a><h3><a name="GIMP-MIN-RESOLUTION:CAPS"></a>GIMP_MIN_RESOLUTION</h3><a class="indexterm" name="id2538257"></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
|
||||
somewhat arbitray value that can be used to when a lower value for a
|
||||
resolution is needed. GIMP will not accept resolutions smaller than
|
||||
this value.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2538272"></a><h3><a name="GIMP-MAX-RESOLUTION:CAPS"></a>GIMP_MAX_RESOLUTION</h3><a class="indexterm" name="id2538280"></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
|
||||
somewhat arbitray value that can be used to when an upper value for a
|
||||
resolution is needed. GIMP will not accept resolutions larger than
|
||||
this value.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2538294"></a><h3><a name="GIMP-MAX-MEMSIZE:CAPS"></a>GIMP_MAX_MEMSIZE</h3><a class="indexterm" name="id2538302"></a><pre class="programlisting">#define GIMP_MAX_MEMSIZE ((guint64) 1 << 42) /* 4 terabyte;
|
||||
</pre><p>
|
||||
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 <tt class="literal">G_MAXDOUBLE</tt> since
|
||||
the <a
|
||||
href="../libgimpwidgets/GimpMemsizeEntry.html"
|
||||
><span class="type">GimpMemsizeEntry</span></a> doesn't handle larger values.
|
||||
</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-gimpversion.html"><b><<<EFBFBD>gimpversion</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpchecks.html"><b>gimpchecks<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
52
devel-docs/libgimpbase/html/libgimpbase-gimpmemsize.html
Normal file
52
devel-docs/libgimpbase/html/libgimpbase-gimpmemsize.html
Normal file
@ -0,0 +1,52 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpmemsize</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpmemsize</span></h2><p>gimpmemsize — Functions to (de)serialize a given memory size.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
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)
|
||||
|
||||
</pre></div><div class="refsect1" lang="en"><a name="id2531440"></a><h2>Description</h2><p>
|
||||
Functions to (de)serialize a given memory size.
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2531450"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2531456"></a><h3><a name="gimp-memsize-serialize"></a>gimp_memsize_serialize ()</h3><a class="indexterm" name="id2531464"></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"><tt class="function">gimp_memsize_deserialize()</tt></a> and can thus be used in
|
||||
config files. It should not be displayed to the user. If you need a
|
||||
nice human-readable string please use <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string"><tt class="function">gimp_memsize_to_string()</tt></a>.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>memsize</tt></i><EFBFBD>:</span></td><td> memory size in bytes
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> A newly allocated string representation of <i class="parameter"><tt>memsize</tt></i>.
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2545897"></a><h3><a name="gimp-memsize-deserialize"></a>gimp_memsize_deserialize ()</h3><a class="indexterm" name="id2545906"></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"><tt class="function">gimp_memsize_serialize()</tt></a>.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>string</tt></i><EFBFBD>:</span></td><td> a string as returned by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><tt class="function">gimp_memsize_serialize()</tt></a>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>memsize</tt></i><EFBFBD>:</span></td><td> return location for memory size in bytes
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> <tt class="literal">TRUE</tt> if the <i class="parameter"><tt>string</tt></i> was successfully parsed and
|
||||
<i class="parameter"><tt>memsize</tt></i> has been set, <tt class="literal">FALSE</tt> otherwise.
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2564621"></a><h3><a name="gimp-memsize-to-string"></a>gimp_memsize_to_string ()</h3><a class="indexterm" name="id2564629"></a><pre class="programlisting">gchar* gimp_memsize_to_string (guint64 memsize);</pre><p>
|
||||
This function returns a human readable, translated representation
|
||||
of the passed <i class="parameter"><tt>memsize</tt></i>. Large values are displayed using a
|
||||
reasonable memsize unit, e.g.: "345" becomes "345 Bytes", "4500"
|
||||
becomes "4.4 KB" and so on.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>memsize</tt></i><EFBFBD>:</span></td><td> A memory size in bytes.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> A newly allocated human-readable, translated string.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2564684"></a><h3><a name="GIMP-TYPE-MEMSIZE:CAPS"></a>GIMP_TYPE_MEMSIZE</h3><a class="indexterm" name="id2564692"></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>.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2583391"></a><h3><a name="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"></a>GIMP_VALUE_HOLDS_MEMSIZE()</h3><a class="indexterm" name="id2583399"></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"><i class="parameter"><tt>value</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></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="libgimpbase-gimpenv.html"><b><<<EFBFBD>gimpenv</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpparasite.html"><b>gimpparasite<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
160
devel-docs/libgimpbase/html/libgimpbase-gimpparasite.html
Normal file
160
devel-docs/libgimpbase/html/libgimpbase-gimpparasite.html
Normal file
@ -0,0 +1,160 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpparasite</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpparasite</span></h2><p>gimpparasite — Arbitrary pieces of data which can be attached to various GIMP objects.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
<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="id2584433"></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="id2584444"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2584449"></a><h3><a name="GimpParasite"></a>GimpParasite</h3><a class="indexterm" name="id2569798"></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 */
|
||||
gpointer data; /* a pointer to the data. plugin is *
|
||||
* responsible for tracking byte order */
|
||||
} GimpParasite;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2569814"></a><h3><a name="gimp-parasite-new"></a>gimp_parasite_new ()</h3><a class="indexterm" name="id2569822"></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><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>flags</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>size</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569916"></a><h3><a name="gimp-parasite-free"></a>gimp_parasite_free ()</h3><a class="indexterm" name="id2569925"></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"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2569958"></a><h3><a name="gimp-parasite-copy"></a>gimp_parasite_copy ()</h3><a class="indexterm" name="id2569967"></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><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2570011"></a><h3><a name="gimp-parasite-compare"></a>gimp_parasite_compare ()</h3><a class="indexterm" name="id2570019"></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><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>a</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>b</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582891"></a><h3><a name="gimp-parasite-is-type"></a>gimp_parasite_is_type ()</h3><a class="indexterm" name="id2582899"></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><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>name</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582961"></a><h3><a name="gimp-parasite-is-persistent"></a>gimp_parasite_is_persistent ()</h3><a class="indexterm" name="id2582970"></a><pre class="programlisting">gboolean gimp_parasite_is_persistent (const <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"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583014"></a><h3><a name="gimp-parasite-is-undoable"></a>gimp_parasite_is_undoable ()</h3><a class="indexterm" name="id2583023"></a><pre class="programlisting">gboolean gimp_parasite_is_undoable (const <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"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583067"></a><h3><a name="gimp-parasite-has-flag"></a>gimp_parasite_has_flag ()</h3><a class="indexterm" name="id2583075"></a><pre class="programlisting">gboolean gimp_parasite_has_flag (const <a href="libgimpbase-gimpparasite.html#GimpParasite">GimpParasite</a> *parasite,
|
||||
gulong flag);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>flag</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586066"></a><h3><a name="gimp-parasite-flags"></a>gimp_parasite_flags ()</h3><a class="indexterm" name="id2586075"></a><pre class="programlisting">gulong gimp_parasite_flags (const <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"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586119"></a><h3><a name="gimp-parasite-name"></a>gimp_parasite_name ()</h3><a class="indexterm" name="id2586127"></a><pre class="programlisting">const gchar* gimp_parasite_name (const <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"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586172"></a><h3><a name="gimp-parasite-data"></a>gimp_parasite_data ()</h3><a class="indexterm" name="id2586181"></a><pre class="programlisting">gconstpointer gimp_parasite_data (const <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"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586225"></a><h3><a name="gimp-parasite-data-size"></a>gimp_parasite_data_size ()</h3><a class="indexterm" name="id2586233"></a><pre class="programlisting">glong gimp_parasite_data_size (const <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"><i class="parameter"><tt>parasite</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586278"></a><h3><a name="GIMP-PARASITE-PERSISTENT:CAPS"></a>GIMP_PARASITE_PERSISTENT</h3><a class="indexterm" name="id2586289"></a><pre class="programlisting">#define GIMP_PARASITE_PERSISTENT 1
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586298"></a><h3><a name="GIMP-PARASITE-UNDOABLE:CAPS"></a>GIMP_PARASITE_UNDOABLE</h3><a class="indexterm" name="id2586307"></a><pre class="programlisting">#define GIMP_PARASITE_UNDOABLE 2
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586317"></a><h3><a name="GIMP-PARASITE-ATTACH-PARENT:CAPS"></a>GIMP_PARASITE_ATTACH_PARENT</h3><a class="indexterm" name="id2586328"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_PARENT (0x80 << 8)
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586339"></a><h3><a name="GIMP-PARASITE-PARENT-PERSISTENT:CAPS"></a>GIMP_PARASITE_PARENT_PERSISTENT</h3><a class="indexterm" name="id2586350"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT << 8)
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586362"></a><h3><a name="GIMP-PARASITE-PARENT-UNDOABLE:CAPS"></a>GIMP_PARASITE_PARENT_UNDOABLE</h3><a class="indexterm" name="id2586373"></a><pre class="programlisting">#define GIMP_PARASITE_PARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE << 8)
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586385"></a><h3><a name="GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS"></a>GIMP_PARASITE_ATTACH_GRANDPARENT</h3><a class="indexterm" name="id2586396"></a><pre class="programlisting">#define GIMP_PARASITE_ATTACH_GRANDPARENT (0x80 << 16)
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586407"></a><h3><a name="GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS"></a>GIMP_PARASITE_GRANDPARENT_PERSISTENT</h3><a class="indexterm" name="id2586418"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT << 16)
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586430"></a><h3><a name="GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS"></a>GIMP_PARASITE_GRANDPARENT_UNDOABLE</h3><a class="indexterm" name="id2586442"></a><pre class="programlisting">#define GIMP_PARASITE_GRANDPARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE << 16)
|
||||
</pre><p>
|
||||
|
||||
</p></div></div><div class="refsect1" lang="en"><a name="id2586455"></a><h2>See Also</h2><p>
|
||||
<a
|
||||
href="../libgimp/libgimp-gimpimage.html#gimp-image-parasite-attach"
|
||||
><tt class="function">gimp_image_parasite_attach()</tt></a>, <a
|
||||
href="../libgimp/libgimp-gimpdrawable.html#gimp-drawable-parasite-attach"
|
||||
><tt class="function">gimp_drawable_parasite_attach()</tt></a>,
|
||||
<a
|
||||
href="../libgimp/libgimp-gimp.html#gimp-parasite-attach"
|
||||
><tt class="function">gimp_parasite_attach()</tt></a> and their related functions.
|
||||
</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><<<EFBFBD>gimpmemsize</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpparasiteio.html"><b>gimpparasiteio<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
36
devel-docs/libgimpbase/html/libgimpbase-gimpparasiteio.html
Normal file
36
devel-docs/libgimpbase/html/libgimpbase-gimpparasiteio.html
Normal file
@ -0,0 +1,36 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpparasiteio</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpparasiteio</span></h2><p>gimpparasiteio — 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></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
#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="id2585906"></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="id2527278"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2527284"></a><h3><a name="GIMP-PIXPIPE-MAXDIM:CAPS"></a>GIMP_PIXPIPE_MAXDIM</h3><a class="indexterm" name="id2527292"></a><pre class="programlisting">#define GIMP_PIXPIPE_MAXDIM 4
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2527302"></a><h3><a name="gimp-pixpipe-params-init"></a>gimp_pixpipe_params_init ()</h3><a class="indexterm" name="id2527310"></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"><i class="parameter"><tt>params</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2527344"></a><h3><a name="gimp-pixpipe-params-parse"></a>gimp_pixpipe_params_parse ()</h3><a class="indexterm" name="id2527352"></a><pre class="programlisting">void gimp_pixpipe_params_parse (const gchar *parameters,
|
||||
GimpPixPipeParams *params);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>parameters</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>params</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2570130"></a><h3><a name="gimp-pixpipe-params-build"></a>gimp_pixpipe_params_build ()</h3><a class="indexterm" name="id2570138"></a><pre class="programlisting">gchar* gimp_pixpipe_params_build (GimpPixPipeParams *params);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>params</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2570183"></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><<<EFBFBD>gimpparasite</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpsignal.html"><b>gimpsignal<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
315
devel-docs/libgimpbase/html/libgimpbase-gimpprotocol.html
Normal file
315
devel-docs/libgimpbase/html/libgimpbase-gimpprotocol.html
Normal file
@ -0,0 +1,315 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpprotocol</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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="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></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><span class="refentrytitle">gimpprotocol</span></h2><p>gimpprotocol — 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="id2589678"></a><h2>Description</h2><p>
|
||||
The communication protocol between GIMP and it's plug-ins.
|
||||
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2574805"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2574810"></a><h3><a name="GIMP-PROTOCOL-VERSION:CAPS"></a>GIMP_PROTOCOL_VERSION</h3><a class="indexterm" name="id2574819"></a><pre class="programlisting">#define GIMP_PROTOCOL_VERSION 0x0011
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2574828"></a><h3><a name="GPConfig"></a>GPConfig</h3><a class="indexterm" name="id2574837"></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="id2556165"></a><h3><a name="GPTileReq"></a>GPTileReq</h3><a class="indexterm" name="id2581208"></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="id2557980"></a><h3><a name="GPTileAck"></a>GPTileAck</h3><a class="indexterm" name="id2556851"></a><pre class="programlisting">typedef struct _GPTileAck GPTileAck;</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2574860"></a><h3><a name="GPTileData"></a>GPTileData</h3><a class="indexterm" name="id2574868"></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="id2574880"></a><h3><a name="GPParam"></a>GPParam</h3><a class="indexterm" name="id2574888"></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="id2534219"></a><h3><a name="GPParamDef"></a>GPParamDef</h3><a class="indexterm" name="id2574910"></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="id2574922"></a><h3><a name="GPProcRun"></a>GPProcRun</h3><a class="indexterm" name="id2574929"></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="id2574940"></a><h3><a name="GPProcReturn"></a>GPProcReturn</h3><a class="indexterm" name="id2574948"></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="id2574959"></a><h3><a name="GPProcInstall"></a>GPProcInstall</h3><a class="indexterm" name="id2574966"></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="id2574982"></a><h3><a name="GPProcUninstall"></a>GPProcUninstall</h3><a class="indexterm" name="id2574989"></a><pre class="programlisting">typedef struct {
|
||||
gchar *name;
|
||||
} GPProcUninstall;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2574999"></a><h3><a name="gp-init"></a>gp_init ()</h3><a class="indexterm" name="id2575006"></a><pre class="programlisting">void gp_init (void);</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2575019"></a><h3><a name="gp-has-init-write"></a>gp_has_init_write ()</h3><a class="indexterm" name="id2575027"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575083"></a><h3><a name="gp-quit-write"></a>gp_quit_write ()</h3><a class="indexterm" name="id2575091"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2575147"></a><h3><a name="gp-config-write"></a>gp_config_write ()</h3><a class="indexterm" name="id2575155"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>config</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2593266"></a><h3><a name="gp-tile-req-write"></a>gp_tile_req_write ()</h3><a class="indexterm" name="id2593275"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>tile_req</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2593352"></a><h3><a name="gp-tile-ack-write"></a>gp_tile_ack_write ()</h3><a class="indexterm" name="id2593360"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2593421"></a><h3><a name="gp-tile-data-write"></a>gp_tile_data_write ()</h3><a class="indexterm" name="id2593429"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>tile_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2593506"></a><h3><a name="gp-proc-run-write"></a>gp_proc_run_write ()</h3><a class="indexterm" name="id2593515"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>proc_run</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2593592"></a><h3><a name="gp-proc-return-write"></a>gp_proc_return_write ()</h3><a class="indexterm" name="id2593600"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>proc_return</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2593678"></a><h3><a name="gp-temp-proc-run-write"></a>gp_temp_proc_run_write ()</h3><a class="indexterm" name="id2593686"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>proc_run</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2593763"></a><h3><a name="gp-temp-proc-return-write"></a>gp_temp_proc_return_write ()</h3><a class="indexterm" name="id2593772"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>proc_return</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2593849"></a><h3><a name="gp-proc-install-write"></a>gp_proc_install_write ()</h3><a class="indexterm" name="id2593857"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>proc_install</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2593935"></a><h3><a name="gp-proc-uninstall-write"></a>gp_proc_uninstall_write ()</h3><a class="indexterm" name="id2593943"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>proc_uninstall</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2594020"></a><h3><a name="gp-extension-ack-write"></a>gp_extension_ack_write ()</h3><a class="indexterm" name="id2594029"></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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2594090"></a><h2>See Also</h2><p>
|
||||
<span class="type">libgimp-gimpwire</span>
|
||||
</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-gimputils.html"><b><<<EFBFBD>gimputils</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpwire.html"><b>gimpwire<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
47
devel-docs/libgimpbase/html/libgimpbase-gimpsignal.html
Normal file
47
devel-docs/libgimpbase/html/libgimpbase-gimpsignal.html
Normal file
@ -0,0 +1,47 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpsignal</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpsignal</span></h2><p>gimpsignal — Portable signal handling.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
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="id2585424"></a><h2>Description</h2><p>
|
||||
Portable signal handling.
|
||||
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2585433"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2585439"></a><h3><a name="GimpSignalHandlerFunc"></a>GimpSignalHandlerFunc ()</h3><a class="indexterm" name="id2585447"></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
|
||||
special values defined by your system's signal.h header file (like
|
||||
<i class="parameter"><tt>SIG_DFL</tt></i> or <i class="parameter"><tt>SIG_IGN</tt></i>).
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>signum</tt></i><EFBFBD>:</span></td><td>The number of the signal. Useful if different signals are handled
|
||||
by a single handler.
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2585493"></a><h3><a name="gimp-signal-private"></a>gimp_signal_private ()</h3><a class="indexterm" name="id2585501"></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
|
||||
sa_flags are set; these primarily to ensure restarting
|
||||
of interrupted system calls. See sigaction(2) It is a
|
||||
aid to transition and not new development: that effort
|
||||
should employ sigaction directly. [gosgood 18.04.2000]
|
||||
</p><p>
|
||||
Cause <i class="parameter"><tt>handler</tt></i> to be run when <i class="parameter"><tt>signum</tt></i> is delivered. We
|
||||
use sigaction(2) rather than signal(2) so that we can control the
|
||||
signal handler's environment completely via <i class="parameter"><tt>flags</tt></i>: some signal(2)
|
||||
implementations differ in their sematics, so we need to nail down
|
||||
exactly what we want. [austin 06.04.2000]</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>signum</tt></i><EFBFBD>:</span></td><td> Selects signal to be handled see man 5 signal (or man 7 signal)
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>handler</tt></i><EFBFBD>:</span></td><td> Handler that maps to signum. Invoked by O/S.
|
||||
Handler gets signal that caused invocation. Corresponds
|
||||
to the <i class="parameter"><tt>sa_handler</tt></i> field of the <i class="parameter"><tt>sigaction</tt></i> struct.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>flags</tt></i><EFBFBD>:</span></td><td> Preferences. OR'ed SA_<xxx>. See man sigaction. Corresponds
|
||||
to the <i class="parameter"><tt>sa_flags</tt></i> field of the <i class="parameter"><tt>sigaction</tt></i> struct.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</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"><tt class="function">gimp_signal_private()</tt></a>.
|
||||
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2536296"></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><<<EFBFBD>gimpparasiteio</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpunit.html"><b>gimpunit<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
167
devel-docs/libgimpbase/html/libgimpbase-gimpunit.html
Normal file
167
devel-docs/libgimpbase/html/libgimpbase-gimpunit.html
Normal file
@ -0,0 +1,167 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpunit</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpunit</span></h2><p>gimpunit — Provides a collection of predefined units and functions for creating
|
||||
user-defined units.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
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)
|
||||
|
||||
</pre></div><div class="refsect1" lang="en"><a name="id2562110"></a><h2>Description</h2><p>
|
||||
Provides a collection of predefined units and functions for creating
|
||||
user-defined units.
|
||||
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2562121"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2562126"></a><h3><a name="GimpUnit"></a>enum GimpUnit</h3><a class="indexterm" name="id2562135"></a><pre class="programlisting">typedef enum /*< skip >*/
|
||||
{
|
||||
GIMP_UNIT_PIXEL = 0,
|
||||
|
||||
GIMP_UNIT_INCH = 1,
|
||||
GIMP_UNIT_MM = 2,
|
||||
GIMP_UNIT_POINT = 3,
|
||||
GIMP_UNIT_PICA = 4,
|
||||
|
||||
GIMP_UNIT_END = 5,
|
||||
|
||||
GIMP_UNIT_PERCENT = 65536 /*< pdb-skip >*/
|
||||
} GimpUnit;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2562148"></a><h3><a name="gimp-unit-get-number-of-units"></a>gimp_unit_get_number_of_units ()</h3><a class="indexterm" name="id2562157"></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>
|
||||
|
||||
</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><EFBFBD>:</span></td><td> The number of defined units.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586516"></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="id2586525"></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"
|
||||
UNIT_PIXEL).</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><EFBFBD>:</span></td><td> The number of built-in units.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586567"></a><h3><a name="gimp-unit-new"></a>gimp_unit_new ()</h3><a class="indexterm" name="id2586576"></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><p>
|
||||
Note that a new unit is always created with it's deletion flag
|
||||
set to <tt class="literal">TRUE</tt>. You will have to set it to <tt class="literal">FALSE</tt> with
|
||||
<a href="libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag"><tt class="function">gimp_unit_set_deletion_flag()</tt></a> to make the unit definition persistent.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>identifier</tt></i><EFBFBD>:</span></td><td> The unit's identifier string.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>factor</tt></i><EFBFBD>:</span></td><td> The unit's factor (how many units are in one inch).
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>digits</tt></i><EFBFBD>:</span></td><td> The unit's suggested number of digits (see <a href="libgimpbase-gimpunit.html#gimp-unit-get-digits"><tt class="function">gimp_unit_get_digits()</tt></a>).
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>symbol</tt></i><EFBFBD>:</span></td><td> The symbol of the unit (e.g. "''" for inch).
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>abbreviation</tt></i><EFBFBD>:</span></td><td> The abbreviation of the unit.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>singular</tt></i><EFBFBD>:</span></td><td> The singular form of the unit.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>plural</tt></i><EFBFBD>:</span></td><td> The plural form of the unit.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The ID of the new unit.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2529100"></a><h3><a name="gimp-unit-get-deletion-flag"></a>gimp_unit_get_deletion_flag ()</h3><a class="indexterm" name="id2529109"></a><pre class="programlisting">gboolean gimp_unit_get_deletion_flag (<a href="libgimpbase-gimpunit.html#GimpUnit">GimpUnit</a> unit);</pre><p>
|
||||
</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>unit</tt></i><EFBFBD>:</span></td><td> The unit you want to know the <i class="parameter"><tt>deletion_flag</tt></i> of.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The unit's <i class="parameter"><tt>deletion_flag</tt></i>.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2529164"></a><h3><a name="gimp-unit-set-deletion-flag"></a>gimp_unit_set_deletion_flag ()</h3><a class="indexterm" name="id2529173"></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 <i class="parameter"><tt>deletion_flag</tt></i>. If the <i class="parameter"><tt>deletion_flag</tt></i> of a unit is
|
||||
<tt class="literal">TRUE</tt> when GIMP exits, this unit will not be saved in the users's
|
||||
"unitrc" file.
|
||||
</p><p>
|
||||
Trying to change the <i class="parameter"><tt>deletion_flag</tt></i> of a built-in unit will be silently
|
||||
ignored.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>unit</tt></i><EFBFBD>:</span></td><td> The unit you want to set the <i class="parameter"><tt>deletion_flag</tt></i> for.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>deletion_flag</tt></i><EFBFBD>:</span></td><td> The new deletion_flag.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2529256"></a><h3><a name="gimp-unit-get-factor"></a>gimp_unit_get_factor ()</h3><a class="indexterm" name="id2529264"></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 <i class="parameter"><tt>factor</tt></i> is defined to be:
|
||||
</p><p>
|
||||
distance_in_units == (<i class="parameter"><tt>factor</tt></i> * distance_in_inches)
|
||||
</p><p>
|
||||
Returns 0 for <i class="parameter"><tt>unit</tt></i> == GIMP_UNIT_PIXEL.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>unit</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> The unit's factor.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2529335"></a><h3><a name="gimp-unit-get-digits"></a>gimp_unit_get_digits ()</h3><a class="indexterm" name="id2529343"></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.
|
||||
</p><p>
|
||||
Returns 0 for <i class="parameter"><tt>unit</tt></i> == GIMP_UNIT_PIXEL.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>unit</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> The suggested number of digits.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2588619"></a><h3><a name="gimp-unit-get-identifier"></a>gimp_unit_get_identifier ()</h3><a class="indexterm" name="id2588627"></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>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>unit</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> The unit's identifier.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2588678"></a><h3><a name="gimp-unit-get-symbol"></a>gimp_unit_get_symbol ()</h3><a class="indexterm" name="id2588686"></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><p>
|
||||
NOTE: This string must not be changed or freed.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>unit</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> The unit's symbol.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582540"></a><h3><a name="gimp-unit-get-abbreviation"></a>gimp_unit_get_abbreviation ()</h3><a class="indexterm" name="id2562867"></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.
|
||||
</p><p>
|
||||
NOTE: This string must not be changed or freed.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>unit</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> The unit's abbreviation.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2588768"></a><h3><a name="gimp-unit-get-singular"></a>gimp_unit_get_singular ()</h3><a class="indexterm" name="id2588776"></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.
|
||||
</p><p>
|
||||
NOTE: This string must not be changed or freed.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>unit</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> The unit's singular form.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2588826"></a><h3><a name="gimp-unit-get-plural"></a>gimp_unit_get_plural ()</h3><a class="indexterm" name="id2588833"></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.
|
||||
</p><p>
|
||||
NOTE: This string must not be changed or freed.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>unit</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> The unit's plural form.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2588883"></a><h3><a name="GIMP-TYPE-UNIT:CAPS"></a>GIMP_TYPE_UNIT</h3><a class="indexterm" name="id2588890"></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>.
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2588920"></a><h3><a name="GIMP-VALUE-HOLDS-UNIT:CAPS"></a>GIMP_VALUE_HOLDS_UNIT()</h3><a class="indexterm" name="id2588928"></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"><i class="parameter"><tt>value</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2588955"></a><h2>See Also</h2><p>
|
||||
<a
|
||||
href="../libgimpwidgets/GimpUnitMenu.html"
|
||||
><span class="type">GimpUnitMenu</span></a>
|
||||
</p><p>
|
||||
<a
|
||||
href="../libgimpwidgets/GimpSizeEntry.html"
|
||||
><span class="type">GimpSizeEntry</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-gimpsignal.html"><b><<<EFBFBD>gimpsignal</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimputils.html"><b>gimputils<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
208
devel-docs/libgimpbase/html/libgimpbase-gimputils.html
Normal file
208
devel-docs/libgimpbase/html/libgimpbase-gimputils.html
Normal file
@ -0,0 +1,208 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimputils</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimputils</span></h2><p>gimputils — Utilities of general interest</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
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);
|
||||
</pre></div><div class="refsect1" lang="en"><a name="id2585018"></a><h2>Description</h2><p>
|
||||
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2585028"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2585033"></a><h3><a name="gimp-any-to-utf8"></a>gimp_any_to_utf8 ()</h3><a class="indexterm" name="id2585042"></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.
|
||||
</p><p>
|
||||
If <i class="parameter"><tt>str</tt></i> is valid UTF-8, a copy of the string is returned.
|
||||
</p><p>
|
||||
If UTF-8 validation fails, <tt class="function">g_locale_to_utf8()</tt> is tried and if it
|
||||
succeeds the resulting string is returned.
|
||||
</p><p>
|
||||
Otherwise, the portion of <i class="parameter"><tt>str</tt></i> that is UTF-8, concatenated
|
||||
with "(invalid UTF-8 string)" is returned. If not even the start
|
||||
of <i class="parameter"><tt>str</tt></i> is valid UTF-8, only "(invalid UTF-8 string)" is returned.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i><EFBFBD>:</span></td><td> The string to be converted to UTF-8.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>len</tt></i><EFBFBD>:</span></td><td> The length of the string, or -1 if the string
|
||||
is nul-terminated.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>warning_format</tt></i><EFBFBD>:</span></td><td> The message format for the warning message if conversion
|
||||
to UTF-8 fails. See the <tt class="function"><tt class="function">printf()</tt></tt>
|
||||
documentation.
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> The UTF-8 string as described above.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2585180"></a><h3><a name="gimp-filename-to-utf8"></a>gimp_filename_to_utf8 ()</h3><a class="indexterm" name="id2585188"></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
|
||||
guaranteed to be valid only during the current iteration of the
|
||||
main loop or until the next call to <a href="libgimpbase-gimputils.html#gimp-filename-to-utf8"><tt class="function">gimp_filename_to_utf8()</tt></a>.
|
||||
</p><p>
|
||||
The only purpose of this function is to provide an easy way to pass
|
||||
a filename in the filesystem encoding to a function that expects an
|
||||
UTF-8 encoded filename.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> A temporarily valid UTF-8 representation of <i class="parameter"><tt>filename</tt></i>.
|
||||
This string must not be changed or freed.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583436"></a><h3><a name="gimp-utf8-strtrim"></a>gimp_utf8_strtrim ()</h3><a class="indexterm" name="id2583444"></a><pre class="programlisting">gchar* gimp_utf8_strtrim (const gchar *str,
|
||||
gint max_chars);</pre><p>
|
||||
Creates a (possibly trimmed) copy of <i class="parameter"><tt>str</tt></i>. The string is cut if it
|
||||
exceeds <i class="parameter"><tt>max_chars</tt></i> characters or on the first newline. The fact
|
||||
that the string was trimmed is indicated by appending an ellipsis.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i><EFBFBD>:</span></td><td> an UTF-8 encoded string (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>max_chars</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> A (possibly trimmed) copy of <i class="parameter"><tt>str</tt></i> which should be freed
|
||||
using <tt class="function">g_free()</tt> when it is not needed any longer.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2583534"></a><h3><a name="gimp-escape-uline"></a>gimp_escape_uline ()</h3><a class="indexterm" name="id2583542"></a><pre class="programlisting">gchar* gimp_escape_uline (const gchar *str);</pre><p>
|
||||
This function returns a copy of <i class="parameter"><tt>str</tt></i> with all underline converted
|
||||
to two adjacent underlines. This comes in handy when needing to display
|
||||
strings with underlines (like filenames) in a place that would convert
|
||||
them to mnemonics.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i><EFBFBD>:</span></td><td> Underline infested string (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> A (possibly escaped) copy of <i class="parameter"><tt>str</tt></i> which should be
|
||||
freed using <tt class="function">g_free()</tt> when it is not needed any longer.
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2583617"></a><h3><a name="gimp-strip-uline"></a>gimp_strip_uline ()</h3><a class="indexterm" name="id2583625"></a><pre class="programlisting">gchar* gimp_strip_uline (const gchar *str);</pre><p>
|
||||
This function returns a copy of <i class="parameter"><tt>str</tt></i> stripped of underline
|
||||
characters. This comes in handy when needing to strip mnemonics
|
||||
from menu paths etc.
|
||||
</p><p>
|
||||
In some languages, mnemonics are handled by adding the mnemonic
|
||||
character in brackets (like "File (_F)"). This function recognizes
|
||||
this construct and removes the whole bracket construction to get
|
||||
rid of the mnemonic (see bug <span class="type">157561</span>).</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>str</tt></i><EFBFBD>:</span></td><td> underline infested string (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> A (possibly stripped) copy of <i class="parameter"><tt>str</tt></i> which should be
|
||||
freed using <tt class="function">g_free()</tt> when it is not needed any longer.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2590937"></a><h3><a name="gimp-enum-get-desc"></a>gimp_enum_get_desc ()</h3><a class="indexterm" name="id2590946"></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 <tt class="literal">NULL</tt>.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>enum_class</tt></i><EFBFBD>:</span></td><td> a <span class="type">GEnumClass</span>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i><EFBFBD>:</span></td><td> a value from <i class="parameter"><tt>enum_class</tt></i>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> the value's <a href="libgimpbase-gimpbasetypes.html#GimpEnumDesc"><span class="type">GimpEnumDesc</span></a>.
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2590995"></a><h3><a name="gimp-enum-get-value"></a>gimp_enum_get_value ()</h3><a class="indexterm" name="id2591003"></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 <i class="parameter"><tt>value</tt></i> is valid for the enum registered as <i class="parameter"><tt>enum_type</tt></i>.
|
||||
If the value exists in that enum, its name, nick and its translated
|
||||
desc and help are returned (if <i class="parameter"><tt>value_name</tt></i>, <i class="parameter"><tt>value_nick</tt></i>, <i class="parameter"><tt>value_desc</tt></i>
|
||||
and <i class="parameter"><tt>value_help</tt></i> are not <tt class="literal">NULL</tt>).</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>enum_type</tt></i><EFBFBD>:</span></td><td> the <span class="type">GType</span> of a registered enum
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i><EFBFBD>:</span></td><td> an integer value
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value_name</tt></i><EFBFBD>:</span></td><td> return location for the value's name (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value_nick</tt></i><EFBFBD>:</span></td><td> return location for the value's nick (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value_desc</tt></i><EFBFBD>:</span></td><td> return location for the value's translated desc (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value_help</tt></i><EFBFBD>:</span></td><td> return location for the value's translated help (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> <tt class="literal">TRUE</tt> if <i class="parameter"><tt>value</tt></i> is valid for the <i class="parameter"><tt>enum_type</tt></i>,
|
||||
<tt class="literal">FALSE</tt> otherwise
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2591187"></a><h3><a name="gimp-enum-value-get-desc"></a>gimp_enum_value_get_desc ()</h3><a class="indexterm" name="id2591195"></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 <i class="parameter"><tt>enum_value</tt></i>.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>enum_class</tt></i><EFBFBD>:</span></td><td> a <span class="type">GEnumClass</span>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>enum_value</tt></i><EFBFBD>:</span></td><td> a <span class="type">GEnumValue</span> from <i class="parameter"><tt>enum_class</tt></i>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> the translated desc of the enum value
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2591276"></a><h3><a name="gimp-enum-value-get-help"></a>gimp_enum_value_get_help ()</h3><a class="indexterm" name="id2591283"></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 <i class="parameter"><tt>enum_value</tt></i>.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>enum_class</tt></i><EFBFBD>:</span></td><td> a <span class="type">GEnumClass</span>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>enum_value</tt></i><EFBFBD>:</span></td><td> a <span class="type">GEnumValue</span> from <i class="parameter"><tt>enum_class</tt></i>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> the translated help of the enum value
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2591367"></a><h3><a name="gimp-flags-get-first-desc"></a>gimp_flags_get_first_desc ()</h3><a class="indexterm" name="id2591376"></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 <tt class="literal">NULL</tt>.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>flags_class</tt></i><EFBFBD>:</span></td><td> a <span class="type">GFlagsClass</span>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i><EFBFBD>:</span></td><td> a value from <i class="parameter"><tt>flags_class</tt></i>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> the value's <a href="libgimpbase-gimpbasetypes.html#GimpFlagsDesc"><span class="type">GimpFlagsDesc</span></a>.
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2591469"></a><h3><a name="gimp-flags-get-first-value"></a>gimp_flags_get_first_value ()</h3><a class="indexterm" name="id2591477"></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 <i class="parameter"><tt>value</tt></i> is valid for the flags registered as <i class="parameter"><tt>flags_type</tt></i>.
|
||||
If the value exists in that flags, its name, nick and its translated
|
||||
desc and help are returned (if <i class="parameter"><tt>value_name</tt></i>, <i class="parameter"><tt>value_nick</tt></i>, <i class="parameter"><tt>value_desc</tt></i>
|
||||
and <i class="parameter"><tt>value_help</tt></i> are not <tt class="literal">NULL</tt>).</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>flags_type</tt></i><EFBFBD>:</span></td><td> the <span class="type">GType</span> of registered flags
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value</tt></i><EFBFBD>:</span></td><td> an integer value
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value_name</tt></i><EFBFBD>:</span></td><td> return location for the value's name (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value_nick</tt></i><EFBFBD>:</span></td><td> return location for the value's nick (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value_desc</tt></i><EFBFBD>:</span></td><td> return location for the value's translated desc (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>value_help</tt></i><EFBFBD>:</span></td><td> return location for the value's translated help (or <tt class="literal">NULL</tt>)
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> <tt class="literal">TRUE</tt> if <i class="parameter"><tt>value</tt></i> is valid for the <i class="parameter"><tt>flags_type</tt></i>,
|
||||
<tt class="literal">FALSE</tt> otherwise
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2591671"></a><h3><a name="gimp-flags-value-get-desc"></a>gimp_flags_value_get_desc ()</h3><a class="indexterm" name="id2591679"></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 <i class="parameter"><tt>flags_value</tt></i>.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>flags_class</tt></i><EFBFBD>:</span></td><td> a <span class="type">GFlagsClass</span>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>flags_value</tt></i><EFBFBD>:</span></td><td> a <span class="type">GFlagsValue</span> from <i class="parameter"><tt>flags_class</tt></i>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> the translated desc of the flags value
|
||||
|
||||
</td></tr></tbody></table></div><p>Since GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2591767"></a><h3><a name="gimp-flags-value-get-help"></a>gimp_flags_value_get_help ()</h3><a class="indexterm" name="id2591776"></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 <i class="parameter"><tt>flags_value</tt></i>.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>flags_class</tt></i><EFBFBD>:</span></td><td> a <span class="type">GFlagsClass</span>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>flags_value</tt></i><EFBFBD>:</span></td><td> a <span class="type">GFlagsValue</span> from <i class="parameter"><tt>flags_class</tt></i>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> the translated help of the flags value
|
||||
|
||||
</td></tr></tbody></table></div><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><<<EFBFBD>gimpunit</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpprotocol.html"><b>gimpprotocol<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
38
devel-docs/libgimpbase/html/libgimpbase-gimpversion.html
Normal file
38
devel-docs/libgimpbase/html/libgimpbase-gimpversion.html
Normal file
@ -0,0 +1,38 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpversion</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-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></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><span class="refentrytitle">gimpversion</span></h2><p>gimpversion — Macros and constants useful for determining GIMP's version number and
|
||||
capabilities.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
#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="id2580365"></a><h2>Description</h2><p>
|
||||
Macros and constants useful for determining GIMP's version number and
|
||||
capabilities.
|
||||
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2559070"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2559075"></a><h3><a name="GIMP-MAJOR-VERSION:CAPS"></a>GIMP_MAJOR_VERSION</h3><a class="indexterm" name="id2559087"></a><pre class="programlisting">#define GIMP_MAJOR_VERSION (2)
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2559098"></a><h3><a name="GIMP-MINOR-VERSION:CAPS"></a>GIMP_MINOR_VERSION</h3><a class="indexterm" name="id2559105"></a><pre class="programlisting">#define GIMP_MINOR_VERSION (2)
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2559116"></a><h3><a name="GIMP-MICRO-VERSION:CAPS"></a>GIMP_MICRO_VERSION</h3><a class="indexterm" name="id2559124"></a><pre class="programlisting">#define GIMP_MICRO_VERSION (4)
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2549809"></a><h3><a name="GIMP-VERSION:CAPS"></a>GIMP_VERSION</h3><a class="indexterm" name="id2549818"></a><pre class="programlisting">#define GIMP_VERSION "2.2.4"
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2549828"></a><h3><a name="GIMP-API-VERSION:CAPS"></a>GIMP_API_VERSION</h3><a class="indexterm" name="id2549837"></a><pre class="programlisting">#define GIMP_API_VERSION "2.0"
|
||||
</pre><p>
|
||||
Since: GIMP 2.2
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2549848"></a><h3><a name="GIMP-CHECK-VERSION:CAPS"></a>GIMP_CHECK_VERSION()</h3><a class="indexterm" name="id2549856"></a><pre class="programlisting">#define GIMP_CHECK_VERSION(major, minor, micro)</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>major</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>minor</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>micro</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></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="libgimpbase-gimpbasetypes.html"><b><<<EFBFBD>gimpbasetypes</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimplimits.html"><b>gimplimits<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
351
devel-docs/libgimpbase/html/libgimpbase-gimpwire.html
Normal file
351
devel-docs/libgimpbase/html/libgimpbase-gimpwire.html
Normal file
@ -0,0 +1,351 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpwire</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"><link rel="prev" href="libgimpbase-gimpprotocol.html" title="gimpprotocol"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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-gimpprotocol.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></tr></table><div class="refentry" lang="en"><a name="libgimpbase-gimpwire"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimpwire</span></h2><p>gimpwire — The lowlevel I/O protocol used for communication 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">
|
||||
|
||||
|
||||
|
||||
<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a>;
|
||||
void (<a href="libgimpbase-gimpwire.html#WireReadFunc">*WireReadFunc</a>) (GIOChannel *channel,
|
||||
<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg,
|
||||
gpointer user_data);
|
||||
void (<a href="libgimpbase-gimpwire.html#WireWriteFunc">*WireWriteFunc</a>) (GIOChannel *channel,
|
||||
<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg,
|
||||
gpointer user_data);
|
||||
void (<a href="libgimpbase-gimpwire.html#WireDestroyFunc">*WireDestroyFunc</a>) (<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg);
|
||||
gboolean (<a href="libgimpbase-gimpwire.html#WireIOFunc">*WireIOFunc</a>) (GIOChannel *channel,
|
||||
guint8 *buf,
|
||||
gulong count,
|
||||
gpointer user_data);
|
||||
gboolean (<a href="libgimpbase-gimpwire.html#WireFlushFunc">*WireFlushFunc</a>) (GIOChannel *channel,
|
||||
gpointer user_data);
|
||||
void <a href="libgimpbase-gimpwire.html#wire-register">wire_register</a> (guint32 type,
|
||||
<a href="libgimpbase-gimpwire.html#WireReadFunc">WireReadFunc</a> read_func,
|
||||
<a href="libgimpbase-gimpwire.html#WireWriteFunc">WireWriteFunc</a> write_func,
|
||||
<a href="libgimpbase-gimpwire.html#WireDestroyFunc">WireDestroyFunc</a> destroy_func);
|
||||
void <a href="libgimpbase-gimpwire.html#wire-set-reader">wire_set_reader</a> (<a href="libgimpbase-gimpwire.html#WireIOFunc">WireIOFunc</a> read_func);
|
||||
void <a href="libgimpbase-gimpwire.html#wire-set-writer">wire_set_writer</a> (<a href="libgimpbase-gimpwire.html#WireIOFunc">WireIOFunc</a> write_func);
|
||||
void <a href="libgimpbase-gimpwire.html#wire-set-flusher">wire_set_flusher</a> (<a href="libgimpbase-gimpwire.html#WireFlushFunc">WireFlushFunc</a> flush_func);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-read">wire_read</a> (GIOChannel *channel,
|
||||
guint8 *buf,
|
||||
gsize count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-write">wire_write</a> (GIOChannel *channel,
|
||||
guint8 *buf,
|
||||
gsize count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-flush">wire_flush</a> (GIOChannel *channel,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-error">wire_error</a> (void);
|
||||
void <a href="libgimpbase-gimpwire.html#wire-clear-error">wire_clear_error</a> (void);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-read-msg">wire_read_msg</a> (GIOChannel *channel,
|
||||
<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-write-msg">wire_write_msg</a> (GIOChannel *channel,
|
||||
<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg,
|
||||
gpointer user_data);
|
||||
void <a href="libgimpbase-gimpwire.html#wire-destroy">wire_destroy</a> (<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-read-int32">wire_read_int32</a> (GIOChannel *channel,
|
||||
guint32 *data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-read-int16">wire_read_int16</a> (GIOChannel *channel,
|
||||
guint16 *data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-read-int8">wire_read_int8</a> (GIOChannel *channel,
|
||||
guint8 *data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-read-double">wire_read_double</a> (GIOChannel *channel,
|
||||
gdouble *data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-read-string">wire_read_string</a> (GIOChannel *channel,
|
||||
gchar **data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-write-int32">wire_write_int32</a> (GIOChannel *channel,
|
||||
guint32 *data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-write-int16">wire_write_int16</a> (GIOChannel *channel,
|
||||
guint16 *data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-write-int8">wire_write_int8</a> (GIOChannel *channel,
|
||||
guint8 *data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-write-double">wire_write_double</a> (GIOChannel *channel,
|
||||
gdouble *data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
gboolean <a href="libgimpbase-gimpwire.html#wire-write-string">wire_write_string</a> (GIOChannel *channel,
|
||||
gchar **data,
|
||||
gint count,
|
||||
gpointer user_data);
|
||||
</pre></div><div class="refsect1" lang="en"><a name="id2586932"></a><h2>Description</h2><p>
|
||||
The lowlevel I/O protocol used for communication between GIMP and
|
||||
it's plug-ins.
|
||||
|
||||
</p></div><div class="refsect1" lang="en"><a name="id2586943"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2586949"></a><h3><a name="WireMessage"></a>WireMessage</h3><a class="indexterm" name="id2586957"></a><pre class="programlisting">typedef struct {
|
||||
guint32 type;
|
||||
gpointer data;
|
||||
} WireMessage;
|
||||
</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2586968"></a><h3><a name="WireReadFunc"></a>WireReadFunc ()</h3><a class="indexterm" name="id2586976"></a><pre class="programlisting">void (*WireReadFunc) (GIOChannel *channel,
|
||||
<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>msg</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597056"></a><h3><a name="WireWriteFunc"></a>WireWriteFunc ()</h3><a class="indexterm" name="id2597065"></a><pre class="programlisting">void (*WireWriteFunc) (GIOChannel *channel,
|
||||
<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>msg</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597132"></a><h3><a name="WireDestroyFunc"></a>WireDestroyFunc ()</h3><a class="indexterm" name="id2597141"></a><pre class="programlisting">void (*WireDestroyFunc) (<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>msg</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597175"></a><h3><a name="WireIOFunc"></a>WireIOFunc ()</h3><a class="indexterm" name="id2597183"></a><pre class="programlisting">gboolean (*WireIOFunc) (GIOChannel *channel,
|
||||
guint8 *buf,
|
||||
gulong count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>buf</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597277"></a><h3><a name="WireFlushFunc"></a>WireFlushFunc ()</h3><a class="indexterm" name="id2597286"></a><pre class="programlisting">gboolean (*WireFlushFunc) (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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597346"></a><h3><a name="wire-register"></a>wire_register ()</h3><a class="indexterm" name="id2597354"></a><pre class="programlisting">void wire_register (guint32 type,
|
||||
<a href="libgimpbase-gimpwire.html#WireReadFunc">WireReadFunc</a> read_func,
|
||||
<a href="libgimpbase-gimpwire.html#WireWriteFunc">WireWriteFunc</a> write_func,
|
||||
<a href="libgimpbase-gimpwire.html#WireDestroyFunc">WireDestroyFunc</a> destroy_func);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>type</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>read_func</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>write_func</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>destroy_func</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597440"></a><h3><a name="wire-set-reader"></a>wire_set_reader ()</h3><a class="indexterm" name="id2597448"></a><pre class="programlisting">void wire_set_reader (<a href="libgimpbase-gimpwire.html#WireIOFunc">WireIOFunc</a> read_func);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>read_func</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597482"></a><h3><a name="wire-set-writer"></a>wire_set_writer ()</h3><a class="indexterm" name="id2597491"></a><pre class="programlisting">void wire_set_writer (<a href="libgimpbase-gimpwire.html#WireIOFunc">WireIOFunc</a> write_func);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>write_func</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597525"></a><h3><a name="wire-set-flusher"></a>wire_set_flusher ()</h3><a class="indexterm" name="id2597534"></a><pre class="programlisting">void wire_set_flusher (<a href="libgimpbase-gimpwire.html#WireFlushFunc">WireFlushFunc</a> flush_func);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>flush_func</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597568"></a><h3><a name="wire-read"></a>wire_read ()</h3><a class="indexterm" name="id2597577"></a><pre class="programlisting">gboolean wire_read (GIOChannel *channel,
|
||||
guint8 *buf,
|
||||
gsize count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>buf</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597672"></a><h3><a name="wire-write"></a>wire_write ()</h3><a class="indexterm" name="id2597680"></a><pre class="programlisting">gboolean wire_write (GIOChannel *channel,
|
||||
guint8 *buf,
|
||||
gsize count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>buf</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2567609"></a><h3><a name="wire-flush"></a>wire_flush ()</h3><a class="indexterm" name="id2597752"></a><pre class="programlisting">gboolean wire_flush (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"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597808"></a><h3><a name="wire-error"></a>wire_error ()</h3><a class="indexterm" name="id2597816"></a><pre class="programlisting">gboolean wire_error (void);</pre><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><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597841"></a><h3><a name="wire-clear-error"></a>wire_clear_error ()</h3><a class="indexterm" name="id2597849"></a><pre class="programlisting">void wire_clear_error (void);</pre><p>
|
||||
|
||||
</p></div><hr><div class="refsect2" lang="en"><a name="id2597861"></a><h3><a name="wire-read-msg"></a>wire_read_msg ()</h3><a class="indexterm" name="id2597869"></a><pre class="programlisting">gboolean wire_read_msg (GIOChannel *channel,
|
||||
<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>msg</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2597941"></a><h3><a name="wire-write-msg"></a>wire_write_msg ()</h3><a class="indexterm" name="id2597949"></a><pre class="programlisting">gboolean wire_write_msg (GIOChannel *channel,
|
||||
<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>msg</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598024"></a><h3><a name="wire-destroy"></a>wire_destroy ()</h3><a class="indexterm" name="id2598033"></a><pre class="programlisting">void wire_destroy (<a href="libgimpbase-gimpwire.html#WireMessage">WireMessage</a> *msg);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>msg</tt></i><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598066"></a><h3><a name="wire-read-int32"></a>wire_read_int32 ()</h3><a class="indexterm" name="id2598075"></a><pre class="programlisting">gboolean wire_read_int32 (GIOChannel *channel,
|
||||
guint32 *data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598169"></a><h3><a name="wire-read-int16"></a>wire_read_int16 ()</h3><a class="indexterm" name="id2598177"></a><pre class="programlisting">gboolean wire_read_int16 (GIOChannel *channel,
|
||||
guint16 *data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598271"></a><h3><a name="wire-read-int8"></a>wire_read_int8 ()</h3><a class="indexterm" name="id2598280"></a><pre class="programlisting">gboolean wire_read_int8 (GIOChannel *channel,
|
||||
guint8 *data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598374"></a><h3><a name="wire-read-double"></a>wire_read_double ()</h3><a class="indexterm" name="id2598382"></a><pre class="programlisting">gboolean wire_read_double (GIOChannel *channel,
|
||||
gdouble *data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598476"></a><h3><a name="wire-read-string"></a>wire_read_string ()</h3><a class="indexterm" name="id2598485"></a><pre class="programlisting">gboolean wire_read_string (GIOChannel *channel,
|
||||
gchar **data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598579"></a><h3><a name="wire-write-int32"></a>wire_write_int32 ()</h3><a class="indexterm" name="id2598587"></a><pre class="programlisting">gboolean wire_write_int32 (GIOChannel *channel,
|
||||
guint32 *data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598682"></a><h3><a name="wire-write-int16"></a>wire_write_int16 ()</h3><a class="indexterm" name="id2598690"></a><pre class="programlisting">gboolean wire_write_int16 (GIOChannel *channel,
|
||||
guint16 *data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598784"></a><h3><a name="wire-write-int8"></a>wire_write_int8 ()</h3><a class="indexterm" name="id2598792"></a><pre class="programlisting">gboolean wire_write_int8 (GIOChannel *channel,
|
||||
guint8 *data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598887"></a><h3><a name="wire-write-double"></a>wire_write_double ()</h3><a class="indexterm" name="id2598895"></a><pre class="programlisting">gboolean wire_write_double (GIOChannel *channel,
|
||||
gdouble *data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598989"></a><h3><a name="wire-write-string"></a>wire_write_string ()</h3><a class="indexterm" name="id2598998"></a><pre class="programlisting">gboolean wire_write_string (GIOChannel *channel,
|
||||
gchar **data,
|
||||
gint count,
|
||||
gpointer user_data);</pre><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>channel</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>count</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i><EFBFBD>:</span></td><td>
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td>
|
||||
|
||||
|
||||
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2599093"></a><h2>See Also</h2><p>
|
||||
<span class="type">libgimp-gimpprotocol</span>
|
||||
</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-gimpprotocol.html"><b><<<EFBFBD>gimpprotocol</b></a></td><td align="right"></td></tr></table></body></html>
|
||||
186
devel-docs/libgimpbase/html/libgimpbase.devhelp
Normal file
186
devel-docs/libgimpbase/html/libgimpbase.devhelp
Normal file
@ -0,0 +1,186 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="no"?>
|
||||
<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">
|
||||
<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>
|
||||
<function name="enum GimpCheckSize" link="libgimpbase-gimpbaseenums.html#GimpCheckSize"/>
|
||||
<function name="enum GimpCheckType" link="libgimpbase-gimpbaseenums.html#GimpCheckType"/>
|
||||
<function name="enum GimpImageBaseType" link="libgimpbase-gimpbaseenums.html#GimpImageBaseType"/>
|
||||
<function name="enum GimpImageType" link="libgimpbase-gimpbaseenums.html#GimpImageType"/>
|
||||
<function name="enum GimpMessageHandlerType" link="libgimpbase-gimpbaseenums.html#GimpMessageHandlerType"/>
|
||||
<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 GimpStackTraceMode" link="libgimpbase-gimpbaseenums.html#GimpStackTraceMode"/>
|
||||
<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"/>
|
||||
<function name="gimp_type_get_translation_domain ()" link="libgimpbase-gimpbasetypes.html#gimp-type-get-translation-domain"/>
|
||||
<function name="gimp_enum_set_value_descriptions ()" link="libgimpbase-gimpbasetypes.html#gimp-enum-set-value-descriptions"/>
|
||||
<function name="gimp_enum_get_value_descriptions ()" link="libgimpbase-gimpbasetypes.html#gimp-enum-get-value-descriptions"/>
|
||||
<function name="gimp_flags_get_value_descriptions ()" link="libgimpbase-gimpbasetypes.html#gimp-flags-get-value-descriptions"/>
|
||||
<function name="gimp_flags_set_value_descriptions ()" link="libgimpbase-gimpbasetypes.html#gimp-flags-set-value-descriptions"/>
|
||||
<function name="GIMP_MAJOR_VERSION" link="libgimpbase-gimpversion.html#GIMP-MAJOR-VERSION:CAPS"/>
|
||||
<function name="GIMP_MINOR_VERSION" link="libgimpbase-gimpversion.html#GIMP-MINOR-VERSION:CAPS"/>
|
||||
<function name="GIMP_MICRO_VERSION" link="libgimpbase-gimpversion.html#GIMP-MICRO-VERSION:CAPS"/>
|
||||
<function name="GIMP_VERSION" link="libgimpbase-gimpversion.html#GIMP-VERSION:CAPS"/>
|
||||
<function name="GIMP_API_VERSION" link="libgimpbase-gimpversion.html#GIMP-API-VERSION:CAPS"/>
|
||||
<function name="GIMP_CHECK_VERSION()" link="libgimpbase-gimpversion.html#GIMP-CHECK-VERSION:CAPS"/>
|
||||
<function name="GIMP_MIN_IMAGE_SIZE" link="libgimpbase-gimplimits.html#GIMP-MIN-IMAGE-SIZE:CAPS"/>
|
||||
<function name="GIMP_MAX_IMAGE_SIZE" link="libgimpbase-gimplimits.html#GIMP-MAX-IMAGE-SIZE:CAPS"/>
|
||||
<function name="GIMP_MIN_RESOLUTION" link="libgimpbase-gimplimits.html#GIMP-MIN-RESOLUTION:CAPS"/>
|
||||
<function name="GIMP_MAX_RESOLUTION" link="libgimpbase-gimplimits.html#GIMP-MAX-RESOLUTION:CAPS"/>
|
||||
<function name="GIMP_MAX_MEMSIZE" link="libgimpbase-gimplimits.html#GIMP-MAX-MEMSIZE:CAPS"/>
|
||||
<function name="GIMP_CHECK_SIZE" link="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE:CAPS"/>
|
||||
<function name="GIMP_CHECK_SIZE_SM" link="libgimpbase-gimpchecks.html#GIMP-CHECK-SIZE-SM:CAPS"/>
|
||||
<function name="GIMP_CHECK_DARK" link="libgimpbase-gimpchecks.html#GIMP-CHECK-DARK:CAPS"/>
|
||||
<function name="GIMP_CHECK_LIGHT" link="libgimpbase-gimpchecks.html#GIMP-CHECK-LIGHT:CAPS"/>
|
||||
<function name="gimp_checks_get_shades ()" link="libgimpbase-gimpchecks.html#gimp-checks-get-shades"/>
|
||||
<function name="GimpDatafileData" link="libgimpbase-gimpdatafiles.html#GimpDatafileData"/>
|
||||
<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_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"/>
|
||||
<function name="gimp_locale_directory ()" link="libgimpbase-gimpenv.html#gimp-locale-directory"/>
|
||||
<function name="gimp_plug_in_directory ()" link="libgimpbase-gimpenv.html#gimp-plug-in-directory"/>
|
||||
<function name="gimp_sysconf_directory ()" link="libgimpbase-gimpenv.html#gimp-sysconf-directory"/>
|
||||
<function name="gimp_gtkrc ()" link="libgimpbase-gimpenv.html#gimp-gtkrc"/>
|
||||
<function name="gimp_path_parse ()" link="libgimpbase-gimpenv.html#gimp-path-parse"/>
|
||||
<function name="gimp_path_to_str ()" link="libgimpbase-gimpenv.html#gimp-path-to-str"/>
|
||||
<function name="gimp_path_free ()" link="libgimpbase-gimpenv.html#gimp-path-free"/>
|
||||
<function name="gimp_path_get_user_writable_dir ()" link="libgimpbase-gimpenv.html#gimp-path-get-user-writable-dir"/>
|
||||
<function name="gimp_memsize_serialize ()" link="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"/>
|
||||
<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_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"/>
|
||||
<function name="gimp_parasite_free ()" link="libgimpbase-gimpparasite.html#gimp-parasite-free"/>
|
||||
<function name="gimp_parasite_copy ()" link="libgimpbase-gimpparasite.html#gimp-parasite-copy"/>
|
||||
<function name="gimp_parasite_compare ()" link="libgimpbase-gimpparasite.html#gimp-parasite-compare"/>
|
||||
<function name="gimp_parasite_is_type ()" link="libgimpbase-gimpparasite.html#gimp-parasite-is-type"/>
|
||||
<function name="gimp_parasite_is_persistent ()" link="libgimpbase-gimpparasite.html#gimp-parasite-is-persistent"/>
|
||||
<function name="gimp_parasite_is_undoable ()" link="libgimpbase-gimpparasite.html#gimp-parasite-is-undoable"/>
|
||||
<function name="gimp_parasite_has_flag ()" link="libgimpbase-gimpparasite.html#gimp-parasite-has-flag"/>
|
||||
<function name="gimp_parasite_flags ()" link="libgimpbase-gimpparasite.html#gimp-parasite-flags"/>
|
||||
<function name="gimp_parasite_name ()" link="libgimpbase-gimpparasite.html#gimp-parasite-name"/>
|
||||
<function name="gimp_parasite_data ()" link="libgimpbase-gimpparasite.html#gimp-parasite-data"/>
|
||||
<function name="gimp_parasite_data_size ()" link="libgimpbase-gimpparasite.html#gimp-parasite-data-size"/>
|
||||
<function name="GIMP_PARASITE_PERSISTENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-PERSISTENT:CAPS"/>
|
||||
<function name="GIMP_PARASITE_UNDOABLE" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-UNDOABLE:CAPS"/>
|
||||
<function name="GIMP_PARASITE_ATTACH_PARENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-PARENT:CAPS"/>
|
||||
<function name="GIMP_PARASITE_PARENT_PERSISTENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-PERSISTENT:CAPS"/>
|
||||
<function name="GIMP_PARASITE_PARENT_UNDOABLE" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-PARENT-UNDOABLE:CAPS"/>
|
||||
<function name="GIMP_PARASITE_ATTACH_GRANDPARENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-ATTACH-GRANDPARENT:CAPS"/>
|
||||
<function name="GIMP_PARASITE_GRANDPARENT_PERSISTENT" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-PERSISTENT:CAPS"/>
|
||||
<function name="GIMP_PARASITE_GRANDPARENT_UNDOABLE" link="libgimpbase-gimpparasite.html#GIMP-PARASITE-GRANDPARENT-UNDOABLE:CAPS"/>
|
||||
<function name="GIMP_PIXPIPE_MAXDIM" link="libgimpbase-gimpparasiteio.html#GIMP-PIXPIPE-MAXDIM:CAPS"/>
|
||||
<function name="gimp_pixpipe_params_init ()" link="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-init"/>
|
||||
<function name="gimp_pixpipe_params_parse ()" link="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-parse"/>
|
||||
<function name="gimp_pixpipe_params_build ()" link="libgimpbase-gimpparasiteio.html#gimp-pixpipe-params-build"/>
|
||||
<function name="GimpSignalHandlerFunc ()" link="libgimpbase-gimpsignal.html#GimpSignalHandlerFunc"/>
|
||||
<function name="gimp_signal_private ()" link="libgimpbase-gimpsignal.html#gimp-signal-private"/>
|
||||
<function name="enum GimpUnit" link="libgimpbase-gimpunit.html#GimpUnit"/>
|
||||
<function name="gimp_unit_get_number_of_units ()" link="libgimpbase-gimpunit.html#gimp-unit-get-number-of-units"/>
|
||||
<function name="gimp_unit_get_number_of_built_in_units ()" link="libgimpbase-gimpunit.html#gimp-unit-get-number-of-built-in-units"/>
|
||||
<function name="gimp_unit_new ()" link="libgimpbase-gimpunit.html#gimp-unit-new"/>
|
||||
<function name="gimp_unit_get_deletion_flag ()" link="libgimpbase-gimpunit.html#gimp-unit-get-deletion-flag"/>
|
||||
<function name="gimp_unit_set_deletion_flag ()" link="libgimpbase-gimpunit.html#gimp-unit-set-deletion-flag"/>
|
||||
<function name="gimp_unit_get_factor ()" link="libgimpbase-gimpunit.html#gimp-unit-get-factor"/>
|
||||
<function name="gimp_unit_get_digits ()" link="libgimpbase-gimpunit.html#gimp-unit-get-digits"/>
|
||||
<function name="gimp_unit_get_identifier ()" link="libgimpbase-gimpunit.html#gimp-unit-get-identifier"/>
|
||||
<function name="gimp_unit_get_symbol ()" link="libgimpbase-gimpunit.html#gimp-unit-get-symbol"/>
|
||||
<function name="gimp_unit_get_abbreviation ()" link="libgimpbase-gimpunit.html#gimp-unit-get-abbreviation"/>
|
||||
<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_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_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"/>
|
||||
<function name="gimp_enum_value_get_help ()" link="libgimpbase-gimputils.html#gimp-enum-value-get-help"/>
|
||||
<function name="gimp_flags_get_first_desc ()" link="libgimpbase-gimputils.html#gimp-flags-get-first-desc"/>
|
||||
<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>
|
||||
1
devel-docs/libgimpbase/html/libgimpbase.html
Normal file
1
devel-docs/libgimpbase/html/libgimpbase.html
Normal file
@ -0,0 +1 @@
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Part<EFBFBD>I.<2E>GIMP Base Library</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpbase.html" title="Part<72>I.<2E>GIMP Base Library"></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="index.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="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>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><<<EFBFBD>GIMP Base Library Reference Manual</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpbaseenums.html"><b>gimpbaseenums<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
BIN
devel-docs/libgimpbase/html/right.png
Normal file
BIN
devel-docs/libgimpbase/html/right.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 472 B |
66
devel-docs/libgimpbase/html/style.css
Normal file
66
devel-docs/libgimpbase/html/style.css
Normal file
@ -0,0 +1,66 @@
|
||||
.synopsis, .classsynopsis
|
||||
{
|
||||
background: #eeeeee;
|
||||
border: solid 1px #aaaaaa;
|
||||
padding: 0.5em;
|
||||
}
|
||||
.programlisting
|
||||
{
|
||||
background: #eeeeff;
|
||||
border: solid 1px #aaaaff;
|
||||
padding: 0.5em;
|
||||
}
|
||||
.variablelist
|
||||
{
|
||||
padding: 4px;
|
||||
margin-left: 3em;
|
||||
}
|
||||
.variablelist td:first-child
|
||||
{
|
||||
vertical-align: top;
|
||||
}
|
||||
table.navigation
|
||||
{
|
||||
background: #ffeeee;
|
||||
border: solid 1px #ffaaaa;
|
||||
margin-top: 0.5em;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
.navigation a
|
||||
{
|
||||
color: #770000;
|
||||
}
|
||||
.navigation a:visited
|
||||
{
|
||||
color: #550000;
|
||||
}
|
||||
.navigation .title
|
||||
{
|
||||
font-size: 200%;
|
||||
}
|
||||
div.refnamediv
|
||||
{
|
||||
margin-top: 2em;
|
||||
}
|
||||
div.gallery-float
|
||||
{
|
||||
float: left;
|
||||
padding: 10px;
|
||||
}
|
||||
div.gallery-float img
|
||||
{
|
||||
border-style: none;
|
||||
}
|
||||
div.gallery-spacer
|
||||
{
|
||||
clear: both;
|
||||
}
|
||||
a
|
||||
{
|
||||
text-decoration: none;
|
||||
}
|
||||
a:hover
|
||||
{
|
||||
text-decoration: underline;
|
||||
color: #FF0000;
|
||||
}
|
||||
BIN
devel-docs/libgimpbase/html/up.png
Normal file
BIN
devel-docs/libgimpbase/html/up.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 406 B |
33
devel-docs/libgimpbase/libgimpbase-docs.sgml
Normal file
33
devel-docs/libgimpbase/libgimpbase-docs.sgml
Normal file
@ -0,0 +1,33 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
|
||||
<bookinfo>
|
||||
<title>GIMP Base Library Reference Manual</title>
|
||||
<releaseinfo>
|
||||
for GIMP <xi:include href="version" parse="text"/>
|
||||
</releaseinfo>
|
||||
</bookinfo>
|
||||
|
||||
<part id="libgimpbase">
|
||||
<title>GIMP Base Library</title>
|
||||
<xi:include href="xml/gimpbaseenums.xml" />
|
||||
<xi:include href="xml/gimpbasetypes.xml" />
|
||||
<xi:include href="xml/gimpversion.xml" />
|
||||
<xi:include href="xml/gimplimits.xml" />
|
||||
<xi:include href="xml/gimpchecks.xml" />
|
||||
<xi:include href="xml/gimpdatafiles.xml" />
|
||||
<xi:include href="xml/gimpenv.xml" />
|
||||
<xi:include href="xml/gimpmemsize.xml" />
|
||||
<xi:include href="xml/gimpparasite.xml" />
|
||||
<xi:include href="xml/gimpparasiteio.xml" />
|
||||
<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>
|
||||
|
||||
</book>
|
||||
0
devel-docs/libgimpbase/libgimpbase-overrides.txt
Normal file
0
devel-docs/libgimpbase/libgimpbase-overrides.txt
Normal file
246
devel-docs/libgimpbase/libgimpbase-sections.txt
Normal file
246
devel-docs/libgimpbase/libgimpbase-sections.txt
Normal file
@ -0,0 +1,246 @@
|
||||
<SECTION>
|
||||
<FILE>gimpbasetypes</FILE>
|
||||
GimpEnumDesc
|
||||
GimpFlagsDesc
|
||||
gimp_type_set_translation_domain
|
||||
gimp_type_get_translation_domain
|
||||
gimp_enum_set_value_descriptions
|
||||
gimp_enum_get_value_descriptions
|
||||
gimp_flags_get_value_descriptions
|
||||
gimp_flags_set_value_descriptions
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimpbaseenums</FILE>
|
||||
GimpCheckSize
|
||||
GimpCheckType
|
||||
GimpImageBaseType
|
||||
GimpImageType
|
||||
GimpMessageHandlerType
|
||||
GimpPDBArgType
|
||||
GimpPDBProcType
|
||||
GimpPDBStatusType
|
||||
GimpProgressCommand
|
||||
GimpStackTraceMode
|
||||
<SUBSECTION Standard>
|
||||
GIMP_TYPE_CHECK_SIZE
|
||||
GIMP_TYPE_CHECK_TYPE
|
||||
GIMP_TYPE_IMAGE_BASE_TYPE
|
||||
GIMP_TYPE_IMAGE_TYPE
|
||||
GIMP_TYPE_MESSAGE_HANDLER_TYPE
|
||||
GIMP_TYPE_PDB_ARG_TYPE
|
||||
GIMP_TYPE_PDB_PROC_TYPE
|
||||
GIMP_TYPE_PDB_STATUS_TYPE
|
||||
GIMP_TYPE_PROGRESS_COMMAND
|
||||
GIMP_TYPE_STACK_TRACE_MODE
|
||||
gimp_check_size_get_type
|
||||
gimp_check_type_get_type
|
||||
gimp_image_base_type_get_type
|
||||
gimp_image_type_get_type
|
||||
gimp_message_handler_type_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_stack_trace_mode_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimpchecks</FILE>
|
||||
GIMP_CHECK_SIZE
|
||||
GIMP_CHECK_SIZE_SM
|
||||
GIMP_CHECK_DARK
|
||||
GIMP_CHECK_LIGHT
|
||||
gimp_checks_get_shades
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimpenv</FILE>
|
||||
gimp_directory
|
||||
gimp_personal_rc_file
|
||||
gimp_data_directory
|
||||
gimp_locale_directory
|
||||
gimp_plug_in_directory
|
||||
gimp_sysconf_directory
|
||||
gimp_gtkrc
|
||||
gimp_path_parse
|
||||
gimp_path_to_str
|
||||
gimp_path_free
|
||||
gimp_path_get_user_writable_dir
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimplimits</FILE>
|
||||
GIMP_MIN_IMAGE_SIZE
|
||||
GIMP_MAX_IMAGE_SIZE
|
||||
GIMP_MIN_RESOLUTION
|
||||
GIMP_MAX_RESOLUTION
|
||||
GIMP_MAX_MEMSIZE
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimpmemsize</FILE>
|
||||
gimp_memsize_serialize
|
||||
gimp_memsize_deserialize
|
||||
gimp_memsize_to_string
|
||||
GIMP_TYPE_MEMSIZE
|
||||
GIMP_VALUE_HOLDS_MEMSIZE
|
||||
<SUBSECTION Standard>
|
||||
gimp_memsize_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimpparasite</FILE>
|
||||
GimpParasite
|
||||
gimp_parasite_new
|
||||
gimp_parasite_free
|
||||
gimp_parasite_copy
|
||||
gimp_parasite_compare
|
||||
gimp_parasite_is_type
|
||||
gimp_parasite_is_persistent
|
||||
gimp_parasite_is_undoable
|
||||
gimp_parasite_has_flag
|
||||
gimp_parasite_flags
|
||||
gimp_parasite_name
|
||||
gimp_parasite_data
|
||||
gimp_parasite_data_size
|
||||
GIMP_PARASITE_PERSISTENT
|
||||
GIMP_PARASITE_UNDOABLE
|
||||
GIMP_PARASITE_ATTACH_PARENT
|
||||
GIMP_PARASITE_PARENT_PERSISTENT
|
||||
GIMP_PARASITE_PARENT_UNDOABLE
|
||||
GIMP_PARASITE_ATTACH_GRANDPARENT
|
||||
GIMP_PARASITE_GRANDPARENT_PERSISTENT
|
||||
GIMP_PARASITE_GRANDPARENT_UNDOABLE
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimpparasiteio</FILE>
|
||||
GIMP_PIXPIPE_MAXDIM
|
||||
gimp_pixpipe_params_init
|
||||
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
|
||||
gimp_signal_private
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimpunit</FILE>
|
||||
GimpUnit
|
||||
gimp_unit_get_number_of_units
|
||||
gimp_unit_get_number_of_built_in_units
|
||||
gimp_unit_new
|
||||
gimp_unit_get_deletion_flag
|
||||
gimp_unit_set_deletion_flag
|
||||
gimp_unit_get_factor
|
||||
gimp_unit_get_digits
|
||||
gimp_unit_get_identifier
|
||||
gimp_unit_get_symbol
|
||||
gimp_unit_get_abbreviation
|
||||
gimp_unit_get_singular
|
||||
gimp_unit_get_plural
|
||||
GIMP_TYPE_UNIT
|
||||
GIMP_VALUE_HOLDS_UNIT
|
||||
<SUBSECTION Standard>
|
||||
gimp_unit_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimputils</FILE>
|
||||
gimp_any_to_utf8
|
||||
gimp_filename_to_utf8
|
||||
gimp_utf8_strtrim
|
||||
gimp_escape_uline
|
||||
gimp_strip_uline
|
||||
gimp_enum_get_desc
|
||||
gimp_enum_get_value
|
||||
gimp_enum_value_get_desc
|
||||
gimp_enum_value_get_help
|
||||
gimp_flags_get_first_desc
|
||||
gimp_flags_get_first_value
|
||||
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
|
||||
GIMP_MINOR_VERSION
|
||||
GIMP_MICRO_VERSION
|
||||
GIMP_VERSION
|
||||
GIMP_API_VERSION
|
||||
GIMP_CHECK_VERSION
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gimpdatafiles</FILE>
|
||||
GimpDatafileData
|
||||
GimpDatafileLoaderFunc
|
||||
gimp_datafiles_check_extension
|
||||
gimp_datafiles_read_directories
|
||||
</SECTION>
|
||||
0
devel-docs/libgimpbase/libgimpbase.types
Normal file
0
devel-docs/libgimpbase/libgimpbase.types
Normal file
136
devel-docs/libgimpbase/tmpl/gimpbaseenums.sgml
Normal file
136
devel-docs/libgimpbase/tmpl/gimpbaseenums.sgml
Normal file
@ -0,0 +1,136 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpbaseenums
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Basic GIMP enumeration data types.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Basic GIMP enumeration data types.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GimpCheckSize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_CHECK_SIZE_SMALL_CHECKS:
|
||||
@GIMP_CHECK_SIZE_MEDIUM_CHECKS:
|
||||
@GIMP_CHECK_SIZE_LARGE_CHECKS:
|
||||
|
||||
<!-- ##### ENUM GimpCheckType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_CHECK_TYPE_LIGHT_CHECKS:
|
||||
@GIMP_CHECK_TYPE_GRAY_CHECKS:
|
||||
@GIMP_CHECK_TYPE_DARK_CHECKS:
|
||||
@GIMP_CHECK_TYPE_WHITE_ONLY:
|
||||
@GIMP_CHECK_TYPE_GRAY_ONLY:
|
||||
@GIMP_CHECK_TYPE_BLACK_ONLY:
|
||||
|
||||
<!-- ##### ENUM GimpImageBaseType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_RGB:
|
||||
@GIMP_GRAY:
|
||||
@GIMP_INDEXED:
|
||||
|
||||
<!-- ##### ENUM GimpImageType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_RGB_IMAGE:
|
||||
@GIMP_RGBA_IMAGE:
|
||||
@GIMP_GRAY_IMAGE:
|
||||
@GIMP_GRAYA_IMAGE:
|
||||
@GIMP_INDEXED_IMAGE:
|
||||
@GIMP_INDEXEDA_IMAGE:
|
||||
|
||||
<!-- ##### ENUM GimpMessageHandlerType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_MESSAGE_BOX:
|
||||
@GIMP_CONSOLE:
|
||||
@GIMP_ERROR_CONSOLE:
|
||||
|
||||
<!-- ##### ENUM GimpPDBArgType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_PDB_INT32:
|
||||
@GIMP_PDB_INT16:
|
||||
@GIMP_PDB_INT8:
|
||||
@GIMP_PDB_FLOAT:
|
||||
@GIMP_PDB_STRING:
|
||||
@GIMP_PDB_INT32ARRAY:
|
||||
@GIMP_PDB_INT16ARRAY:
|
||||
@GIMP_PDB_INT8ARRAY:
|
||||
@GIMP_PDB_FLOATARRAY:
|
||||
@GIMP_PDB_STRINGARRAY:
|
||||
@GIMP_PDB_COLOR:
|
||||
@GIMP_PDB_REGION:
|
||||
@GIMP_PDB_DISPLAY:
|
||||
@GIMP_PDB_IMAGE:
|
||||
@GIMP_PDB_LAYER:
|
||||
@GIMP_PDB_CHANNEL:
|
||||
@GIMP_PDB_DRAWABLE:
|
||||
@GIMP_PDB_SELECTION:
|
||||
@GIMP_PDB_BOUNDARY:
|
||||
@GIMP_PDB_PATH:
|
||||
@GIMP_PDB_PARASITE:
|
||||
@GIMP_PDB_STATUS:
|
||||
@GIMP_PDB_END:
|
||||
|
||||
<!-- ##### ENUM GimpPDBProcType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_INTERNAL:
|
||||
@GIMP_PLUGIN:
|
||||
@GIMP_EXTENSION:
|
||||
@GIMP_TEMPORARY:
|
||||
|
||||
<!-- ##### ENUM GimpPDBStatusType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_PDB_EXECUTION_ERROR:
|
||||
@GIMP_PDB_CALLING_ERROR:
|
||||
@GIMP_PDB_PASS_THROUGH:
|
||||
@GIMP_PDB_SUCCESS:
|
||||
@GIMP_PDB_CANCEL:
|
||||
|
||||
<!-- ##### ENUM GimpProgressCommand ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_PROGRESS_COMMAND_START:
|
||||
@GIMP_PROGRESS_COMMAND_END:
|
||||
@GIMP_PROGRESS_COMMAND_SET_TEXT:
|
||||
@GIMP_PROGRESS_COMMAND_SET_VALUE:
|
||||
|
||||
<!-- ##### ENUM GimpStackTraceMode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_STACK_TRACE_NEVER:
|
||||
@GIMP_STACK_TRACE_QUERY:
|
||||
@GIMP_STACK_TRACE_ALWAYS:
|
||||
|
||||
88
devel-docs/libgimpbase/tmpl/gimpbasetypes.sgml
Normal file
88
devel-docs/libgimpbase/tmpl/gimpbasetypes.sgml
Normal file
@ -0,0 +1,88 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpbasetypes
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Translation between gettext translation domain identifier and GType.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Translation between gettext translation domain identifier and GType.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GimpEnumDesc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@value_desc:
|
||||
@value_help:
|
||||
|
||||
<!-- ##### STRUCT GimpFlagsDesc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@value_desc:
|
||||
@value_help:
|
||||
|
||||
<!-- ##### FUNCTION gimp_type_set_translation_domain ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@domain:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_type_get_translation_domain ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_enum_set_value_descriptions ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@enum_type:
|
||||
@descriptions:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_enum_get_value_descriptions ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@enum_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_flags_get_value_descriptions ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@flags_type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_flags_set_value_descriptions ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@flags_type:
|
||||
@descriptions:
|
||||
|
||||
|
||||
56
devel-docs/libgimpbase/tmpl/gimpchecks.sgml
Normal file
56
devel-docs/libgimpbase/tmpl/gimpchecks.sgml
Normal file
@ -0,0 +1,56 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpchecks
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Constants and functions related to rendering checkerboards.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Constants and functions related to rendering checkerboards.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GIMP_CHECK_SIZE ##### -->
|
||||
<para>
|
||||
The default checkerboard size in pixels. This is configurable in the
|
||||
core but GIMP plug-ins can't access the user preference and should use
|
||||
this constant instead.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_CHECK_SIZE_SM ##### -->
|
||||
<para>
|
||||
The default small checkerboard size in pixels.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_CHECK_DARK ##### -->
|
||||
<para>
|
||||
The dark gray value for the default checkerboard pattern.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_CHECK_LIGHT ##### -->
|
||||
<para>
|
||||
The light gray value for the default checkerboard pattern.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_checks_get_shades ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@light:
|
||||
@dark:
|
||||
|
||||
|
||||
58
devel-docs/libgimpbase/tmpl/gimpdatafiles.sgml
Normal file
58
devel-docs/libgimpbase/tmpl/gimpdatafiles.sgml
Normal file
@ -0,0 +1,58 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpdatafiles
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Functions to handle GIMP data files.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Functions to handle GIMP data files.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GimpDatafileData ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filename:
|
||||
@dirname:
|
||||
@basename:
|
||||
@atime:
|
||||
@mtime:
|
||||
@ctime:
|
||||
|
||||
<!-- ##### USER_FUNCTION GimpDatafileLoaderFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@file_data:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_datafiles_check_extension ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filename:
|
||||
@extension:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_datafiles_read_directories ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@path_str:
|
||||
@flags:
|
||||
@loader_func:
|
||||
@user_data:
|
||||
|
||||
|
||||
112
devel-docs/libgimpbase/tmpl/gimpenv.sgml
Normal file
112
devel-docs/libgimpbase/tmpl/gimpenv.sgml
Normal file
@ -0,0 +1,112 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpenv
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Functions to access the GIMP environment.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
A set of functions to find the locations of GIMP's data directories and
|
||||
configuration files.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gimp_directory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_personal_rc_file ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@basename:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_data_directory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_locale_directory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_plug_in_directory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_sysconf_directory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_gtkrc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_path_parse ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@path:
|
||||
@max_paths:
|
||||
@check:
|
||||
@check_failed:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_path_to_str ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@path:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_path_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@path:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_path_get_user_writable_dir ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@path:
|
||||
@Returns:
|
||||
|
||||
|
||||
62
devel-docs/libgimpbase/tmpl/gimplimits.sgml
Normal file
62
devel-docs/libgimpbase/tmpl/gimplimits.sgml
Normal file
@ -0,0 +1,62 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimplimits
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Boundaries of some GIMP data types and some global constants.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Boundaries of some GIMP data types and some global constants.
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GIMP_MIN_IMAGE_SIZE ##### -->
|
||||
<para>
|
||||
The minimum width and height of a GIMP image in pixels.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_MAX_IMAGE_SIZE ##### -->
|
||||
<para>
|
||||
The maximum width and height of a GIMP image in pixels. This is a
|
||||
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>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_MIN_RESOLUTION ##### -->
|
||||
<para>
|
||||
The minimum resolution of a GIMP image in pixels per inch. This is a
|
||||
somewhat arbitray value that can be used to when a lower value for a
|
||||
resolution is needed. GIMP will not accept resolutions smaller than
|
||||
this value.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_MAX_RESOLUTION ##### -->
|
||||
<para>
|
||||
The maximum resolution of a GIMP image in pixels per inch. This is a
|
||||
somewhat arbitray value that can be used to when an upper value for a
|
||||
resolution is needed. GIMP will not accept resolutions larger than
|
||||
this value.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_MAX_MEMSIZE ##### -->
|
||||
<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 %G_MAXDOUBLE since
|
||||
the #GimpMemsizeEntry doesn't handle larger values.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
59
devel-docs/libgimpbase/tmpl/gimpmemsize.sgml
Normal file
59
devel-docs/libgimpbase/tmpl/gimpmemsize.sgml
Normal file
@ -0,0 +1,59 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpmemsize
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Functions to (de)serialize a given memory size.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Functions to (de)serialize a given memory size.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gimp_memsize_serialize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@memsize:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_memsize_deserialize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@memsize:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_memsize_to_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@memsize:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_TYPE_MEMSIZE ##### -->
|
||||
<para>
|
||||
#GIMP_TYPE_MEMSIZE is a #GType derived from #G_TYPE_UINT64.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_VALUE_HOLDS_MEMSIZE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
197
devel-docs/libgimpbase/tmpl/gimpparasite.sgml
Normal file
197
devel-docs/libgimpbase/tmpl/gimpparasite.sgml
Normal file
@ -0,0 +1,197 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpparasite
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Arbitrary pieces of data which can be attached to various GIMP objects.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Arbitrary pieces of data which can be attached to various GIMP objects.
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
gimp_image_parasite_attach(), gimp_drawable_parasite_attach(),
|
||||
gimp_parasite_attach() and their related functions.
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GimpParasite ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@flags:
|
||||
@size:
|
||||
@data:
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@flags:
|
||||
@size:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_compare ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@a:
|
||||
@b:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_is_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_is_persistent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_is_undoable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_has_flag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
@flag:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_flags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_parasite_data_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parasite:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_PARASITE_PERSISTENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_PARASITE_UNDOABLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_PARASITE_ATTACH_PARENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_PARASITE_PARENT_PERSISTENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_PARASITE_PARENT_UNDOABLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_PARASITE_ATTACH_GRANDPARENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_PARASITE_GRANDPARENT_PERSISTENT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_PARASITE_GRANDPARENT_UNDOABLE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
50
devel-docs/libgimpbase/tmpl/gimpparasiteio.sgml
Normal file
50
devel-docs/libgimpbase/tmpl/gimpparasiteio.sgml
Normal file
@ -0,0 +1,50 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpparasiteio
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Utility functions to (de)serialize certain C structures to/from #GimpParasite's.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Utility functions to (de)serialize certain C structures to/from #GimpParasite's.
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
#GimpParasite
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GIMP_PIXPIPE_MAXDIM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_pixpipe_params_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@params:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_pixpipe_params_parse ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parameters:
|
||||
@params:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_pixpipe_params_build ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@params:
|
||||
@Returns:
|
||||
|
||||
|
||||
294
devel-docs/libgimpbase/tmpl/gimpprotocol.sgml
Normal file
294
devel-docs/libgimpbase/tmpl/gimpprotocol.sgml
Normal file
@ -0,0 +1,294 @@
|
||||
<!-- ##### 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>
|
||||
|
||||
<!-- ##### 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:
|
||||
|
||||
|
||||
40
devel-docs/libgimpbase/tmpl/gimpsignal.sgml
Normal file
40
devel-docs/libgimpbase/tmpl/gimpsignal.sgml
Normal file
@ -0,0 +1,40 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpsignal
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Portable signal handling.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Portable signal handling.
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
signal(2), signal(5 or 7), sigaction(2).
|
||||
</para>
|
||||
|
||||
<!-- ##### USER_FUNCTION GimpSignalHandlerFunc ##### -->
|
||||
<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
|
||||
special values defined by your system's signal.h header file (like
|
||||
@SIG_DFL or @SIG_IGN).
|
||||
</para>
|
||||
|
||||
@signum: The number of the signal. Useful if different signals are handled
|
||||
by a single handler.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_signal_private ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@signum:
|
||||
@handler:
|
||||
@flags:
|
||||
@Returns:
|
||||
|
||||
|
||||
162
devel-docs/libgimpbase/tmpl/gimpunit.sgml
Normal file
162
devel-docs/libgimpbase/tmpl/gimpunit.sgml
Normal file
@ -0,0 +1,162 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpunit
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Provides a collection of predefined units and functions for creating
|
||||
user-defined units.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Provides a collection of predefined units and functions for creating
|
||||
user-defined units.
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
#GimpUnitMenu
|
||||
</para>
|
||||
<para>
|
||||
#GimpSizeEntry
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GimpUnit ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GIMP_UNIT_PIXEL:
|
||||
@GIMP_UNIT_INCH:
|
||||
@GIMP_UNIT_MM:
|
||||
@GIMP_UNIT_POINT:
|
||||
@GIMP_UNIT_PICA:
|
||||
@GIMP_UNIT_END:
|
||||
@GIMP_UNIT_PERCENT:
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_number_of_units ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_number_of_built_in_units ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@identifier:
|
||||
@factor:
|
||||
@digits:
|
||||
@symbol:
|
||||
@abbreviation:
|
||||
@singular:
|
||||
@plural:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_deletion_flag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@unit:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_set_deletion_flag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@unit:
|
||||
@deletion_flag:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_factor ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@unit:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_digits ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@unit:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_identifier ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@unit:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_symbol ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@unit:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_abbreviation ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@unit:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_singular ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@unit:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_unit_get_plural ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@unit:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_TYPE_UNIT ##### -->
|
||||
<para>
|
||||
#GIMP_TYPE_UNIT is a #GType derived from #G_TYPE_INT.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_VALUE_HOLDS_UNIT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
|
||||
|
||||
153
devel-docs/libgimpbase/tmpl/gimputils.sgml
Normal file
153
devel-docs/libgimpbase/tmpl/gimputils.sgml
Normal file
@ -0,0 +1,153 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimputils
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Utilities of general interest
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gimp_any_to_utf8 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@str:
|
||||
@len:
|
||||
@warning_format:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_filename_to_utf8 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@filename:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_utf8_strtrim ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@str:
|
||||
@max_chars:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_escape_uline ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@str:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_strip_uline ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@str:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_enum_get_desc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@enum_class:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_enum_get_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@enum_type:
|
||||
@value:
|
||||
@value_name:
|
||||
@value_nick:
|
||||
@value_desc:
|
||||
@value_help:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_enum_value_get_desc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@enum_class:
|
||||
@enum_value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_enum_value_get_help ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@enum_class:
|
||||
@enum_value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_flags_get_first_desc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@flags_class:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_flags_get_first_value ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@flags_type:
|
||||
@value:
|
||||
@value_name:
|
||||
@value_nick:
|
||||
@value_desc:
|
||||
@value_help:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_flags_value_get_desc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@flags_class:
|
||||
@flags_value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gimp_flags_value_get_help ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@flags_class:
|
||||
@flags_value:
|
||||
@Returns:
|
||||
|
||||
|
||||
64
devel-docs/libgimpbase/tmpl/gimpversion.sgml
Normal file
64
devel-docs/libgimpbase/tmpl/gimpversion.sgml
Normal file
@ -0,0 +1,64 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
gimpversion
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Macros and constants useful for determining GIMP's version number and
|
||||
capabilities.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Macros and constants useful for determining GIMP's version number and
|
||||
capabilities.
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GIMP_MAJOR_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_MINOR_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_MICRO_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_API_VERSION ##### -->
|
||||
<para>
|
||||
Since: GIMP 2.2
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GIMP_CHECK_VERSION ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@major:
|
||||
@minor:
|
||||
@micro:
|
||||
|
||||
|
||||
311
devel-docs/libgimpbase/tmpl/gimpwire.sgml
Normal file
311
devel-docs/libgimpbase/tmpl/gimpwire.sgml
Normal file
@ -0,0 +1,311 @@
|
||||
<!-- ##### 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>
|
||||
|
||||
<!-- ##### 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:
|
||||
|
||||
|
||||
0
devel-docs/libgimpbase/tmpl/libgimpbase-unused.sgml
Normal file
0
devel-docs/libgimpbase/tmpl/libgimpbase-unused.sgml
Normal file
1
devel-docs/libgimpbase/version.in
Normal file
1
devel-docs/libgimpbase/version.in
Normal file
@ -0,0 +1 @@
|
||||
@GIMP_VERSION@
|
||||
209
devel-docs/libgimpbase/xml/gimpbaseenums.xml
Normal file
209
devel-docs/libgimpbase/xml/gimpbaseenums.xml
Normal file
@ -0,0 +1,209 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpbaseenums">
|
||||
<refmeta>
|
||||
<refentrytitle>gimpbaseenums</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>gimpbaseenums</refname><refpurpose>Basic GIMP enumeration data types.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<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>;
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Basic GIMP enumeration data types.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpCheckSize"/>enum GimpCheckSize</title>
|
||||
<indexterm><primary>GimpCheckSize</primary></indexterm><programlisting>typedef enum /*< pdb-skip >*/
|
||||
{
|
||||
GIMP_CHECK_SIZE_SMALL_CHECKS = 0, /*< desc="Small" >*/
|
||||
GIMP_CHECK_SIZE_MEDIUM_CHECKS = 1, /*< desc="Medium" >*/
|
||||
GIMP_CHECK_SIZE_LARGE_CHECKS = 2 /*< desc="Large" >*/
|
||||
} GimpCheckSize;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpCheckType"/>enum GimpCheckType</title>
|
||||
<indexterm><primary>GimpCheckType</primary></indexterm><programlisting>typedef enum /*< pdb-skip >*/
|
||||
{
|
||||
GIMP_CHECK_TYPE_LIGHT_CHECKS = 0, /*< desc="Light Checks" >*/
|
||||
GIMP_CHECK_TYPE_GRAY_CHECKS = 1, /*< desc="Mid-Tone Checks" >*/
|
||||
GIMP_CHECK_TYPE_DARK_CHECKS = 2, /*< desc="Dark Checks" >*/
|
||||
GIMP_CHECK_TYPE_WHITE_ONLY = 3, /*< desc="White Only" >*/
|
||||
GIMP_CHECK_TYPE_GRAY_ONLY = 4, /*< desc="Gray Only" >*/
|
||||
GIMP_CHECK_TYPE_BLACK_ONLY = 5 /*< desc="Black Only" >*/
|
||||
} GimpCheckType;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpImageBaseType"/>enum GimpImageBaseType</title>
|
||||
<indexterm><primary>GimpImageBaseType</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_RGB, /*< desc="RGB color" >*/
|
||||
GIMP_GRAY, /*< desc="Grayscale" >*/
|
||||
GIMP_INDEXED /*< desc="Indexed color" >*/
|
||||
} GimpImageBaseType;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpImageType"/>enum GimpImageType</title>
|
||||
<indexterm><primary>GimpImageType</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_RGB_IMAGE, /*< desc="RGB" >*/
|
||||
GIMP_RGBA_IMAGE, /*< desc="RGB-alpha" >*/
|
||||
GIMP_GRAY_IMAGE, /*< desc="Grayscale" >*/
|
||||
GIMP_GRAYA_IMAGE, /*< desc="Grayscale-alpha" >*/
|
||||
GIMP_INDEXED_IMAGE, /*< desc="Indexed" >*/
|
||||
GIMP_INDEXEDA_IMAGE /*< desc="Indexed-alpha" >*/
|
||||
} GimpImageType;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpMessageHandlerType"/>enum GimpMessageHandlerType</title>
|
||||
<indexterm><primary>GimpMessageHandlerType</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_MESSAGE_BOX,
|
||||
GIMP_CONSOLE,
|
||||
GIMP_ERROR_CONSOLE
|
||||
} GimpMessageHandlerType;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpPDBArgType"/>enum GimpPDBArgType</title>
|
||||
<indexterm><primary>GimpPDBArgType</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_PDB_INT32,
|
||||
GIMP_PDB_INT16,
|
||||
GIMP_PDB_INT8,
|
||||
GIMP_PDB_FLOAT,
|
||||
GIMP_PDB_STRING,
|
||||
GIMP_PDB_INT32ARRAY,
|
||||
GIMP_PDB_INT16ARRAY,
|
||||
GIMP_PDB_INT8ARRAY,
|
||||
GIMP_PDB_FLOATARRAY,
|
||||
GIMP_PDB_STRINGARRAY,
|
||||
GIMP_PDB_COLOR,
|
||||
GIMP_PDB_REGION,
|
||||
GIMP_PDB_DISPLAY,
|
||||
GIMP_PDB_IMAGE,
|
||||
GIMP_PDB_LAYER,
|
||||
GIMP_PDB_CHANNEL,
|
||||
GIMP_PDB_DRAWABLE,
|
||||
GIMP_PDB_SELECTION,
|
||||
GIMP_PDB_BOUNDARY,
|
||||
GIMP_PDB_PATH,
|
||||
GIMP_PDB_PARASITE,
|
||||
GIMP_PDB_STATUS,
|
||||
GIMP_PDB_END
|
||||
} GimpPDBArgType;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpPDBProcType"/>enum GimpPDBProcType</title>
|
||||
<indexterm><primary>GimpPDBProcType</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_INTERNAL,
|
||||
GIMP_PLUGIN,
|
||||
GIMP_EXTENSION,
|
||||
GIMP_TEMPORARY
|
||||
} GimpPDBProcType;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpPDBStatusType"/>enum GimpPDBStatusType</title>
|
||||
<indexterm><primary>GimpPDBStatusType</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_PDB_EXECUTION_ERROR,
|
||||
GIMP_PDB_CALLING_ERROR,
|
||||
GIMP_PDB_PASS_THROUGH,
|
||||
GIMP_PDB_SUCCESS,
|
||||
GIMP_PDB_CANCEL
|
||||
} GimpPDBStatusType;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
} GimpProgressCommand;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpStackTraceMode"/>enum GimpStackTraceMode</title>
|
||||
<indexterm><primary>GimpStackTraceMode</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_STACK_TRACE_NEVER,
|
||||
GIMP_STACK_TRACE_QUERY,
|
||||
GIMP_STACK_TRACE_ALWAYS
|
||||
} GimpStackTraceMode;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
203
devel-docs/libgimpbase/xml/gimpbasetypes.xml
Normal file
203
devel-docs/libgimpbase/xml/gimpbasetypes.xml
Normal file
@ -0,0 +1,203 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpbasetypes">
|
||||
<refmeta>
|
||||
<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>
|
||||
</refnamediv>
|
||||
|
||||
<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);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Translation between gettext translation domain identifier and GType.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpEnumDesc"/>GimpEnumDesc</title>
|
||||
<indexterm><primary>GimpEnumDesc</primary></indexterm><programlisting>typedef struct {
|
||||
gint value;
|
||||
gchar *value_desc;
|
||||
gchar *value_help;
|
||||
} GimpEnumDesc;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpFlagsDesc"/>GimpFlagsDesc</title>
|
||||
<indexterm><primary>GimpFlagsDesc</primary></indexterm><programlisting>typedef struct {
|
||||
guint value;
|
||||
gchar *value_desc;
|
||||
gchar *value_help;
|
||||
} GimpFlagsDesc;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-type-set-translation-domain"/>gimp_type_set_translation_domain ()</title>
|
||||
<indexterm role="GIMP"><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
|
||||
to use it when registering a <link linkend="GTypeEnum"><type>GTypeEnum</type></link> with translatable value
|
||||
names.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>domain</parameter> :</term>
|
||||
<listitem><simpara> a constant string that identifies a translation domain or <literal>NULL</literal>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-type-get-translation-domain"/>gimp_type_get_translation_domain ()</title>
|
||||
<indexterm role="GIMP"><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
|
||||
not need to use this function directly, use <link linkend="gimp-enum-get-value"><function>gimp_enum_get_value()</function></link>
|
||||
or <link linkend="gimp-enum-value-get-name"><function>gimp_enum_value_get_name()</function></link> instead.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the translation domain associated with <parameter>type</parameter>
|
||||
or <literal>NULL</literal> if no domain was set
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-enum-set-value-descriptions"/>gimp_enum_set_value_descriptions ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>enum_type</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>descriptions</parameter> :</term>
|
||||
<listitem><simpara> a <literal>NULL</literal> terminated constant static array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-enum-get-value-descriptions"/>gimp_enum_get_value_descriptions ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>enum_type</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <literal>NULL</literal> terminated constant array of <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-flags-get-value-descriptions"/>gimp_flags_get_value_descriptions ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>flags_type</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <literal>NULL</literal> terminated constant array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-flags-set-value-descriptions"/>gimp_flags_set_value_descriptions ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>flags_type</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GType"><type>GType</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>descriptions</parameter> :</term>
|
||||
<listitem><simpara> a <literal>NULL</literal> terminated constant static array of <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
107
devel-docs/libgimpbase/xml/gimpchecks.xml
Normal file
107
devel-docs/libgimpbase/xml/gimpchecks.xml
Normal file
@ -0,0 +1,107 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpchecks">
|
||||
<refmeta>
|
||||
<refentrytitle>gimpchecks</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>gimpchecks</refname><refpurpose>Constants and functions related to rendering checkerboards.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<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);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Constants and functions related to rendering checkerboards.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<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>
|
||||
The default checkerboard size in pixels. This is configurable in the
|
||||
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"/>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"/>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"/>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"/>gimp_checks_get_shades ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara> the checkerboard type
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>light</parameter> :</term>
|
||||
<listitem><simpara> return location for the light shade
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>dark</parameter> :</term>
|
||||
<listitem><simpara> return location for the dark shade
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
130
devel-docs/libgimpbase/xml/gimpdatafiles.xml
Normal file
130
devel-docs/libgimpbase/xml/gimpdatafiles.xml
Normal file
@ -0,0 +1,130 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpdatafiles">
|
||||
<refmeta>
|
||||
<refentrytitle>gimpdatafiles</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>gimpdatafiles</refname><refpurpose>Functions to handle GIMP data files.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<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);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Functions to handle GIMP data files.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpDatafileData"/>GimpDatafileData</title>
|
||||
<indexterm><primary>GimpDatafileData</primary></indexterm><programlisting>typedef struct {
|
||||
const gchar *filename;
|
||||
const gchar *dirname;
|
||||
const gchar *basename;
|
||||
|
||||
time_t atime;
|
||||
time_t mtime;
|
||||
time_t ctime;
|
||||
} GimpDatafileData;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>file_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>filename</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>extension</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>path_str</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>flags</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>loader_func</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
282
devel-docs/libgimpbase/xml/gimpenv.xml
Normal file
282
devel-docs/libgimpbase/xml/gimpenv.xml
Normal file
@ -0,0 +1,282 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpenv">
|
||||
<refmeta>
|
||||
<refentrytitle>gimpenv</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>gimpenv</refname><refpurpose>Functions to access the GIMP environment.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<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);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
A set of functions to find the locations of GIMP's data directories and
|
||||
configuration files.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<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
|
||||
an absolute path, it is used as is. If it is a relative path, it
|
||||
is taken to be a subdirectory of the home directory. If it is a
|
||||
relative path, and no home directory can be determined, it is taken
|
||||
to be a subdirectory of <link linkend="gimp-data-directory"><function>gimp_data_directory()</function></link>.
|
||||
</para>
|
||||
<para>
|
||||
The usual case is that no GIMP2_DIRECTORY environment variable
|
||||
exists, and then we use the GIMPDIR subdirectory of the home
|
||||
directory. If no home directory exists, we use a per-user
|
||||
subdirectory of <link linkend="gimp-data-directory"><function>gimp_data_directory()</function></link>. In any case, we always
|
||||
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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The user-specific GIMP settings directory.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
<para>
|
||||
The returned string is allocated dynamically and *SHOULD* be freed
|
||||
with <link linkend="g-free"><function>g_free()</function></link> after use. 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">
|
||||
<varlistentry><term><parameter>basename</parameter> :</term>
|
||||
<listitem><simpara> The basename of a rc_file.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of a file in the user-specific GIMP settings directory.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
absolute pathname. Otherwise, on Unix the compile-time 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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The top directory for GIMP data.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
absolute pathname. Otherwise, on Unix the compile-time 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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The top directory for GIMP locale files.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
should be an absolute pathname. Otherwise, on Unix the compile-time
|
||||
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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The top directory for GIMP plug_ins and modules.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
absolute pathname. Otherwise, on Unix the compile-time 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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The top directory for GIMP config files.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the GIMP's application-specific gtkrc file.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>path</parameter> :</term>
|
||||
<listitem><simpara> A list of directories separated by <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>max_paths</parameter> :</term>
|
||||
<listitem><simpara> The maximum number of directories to return.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>check</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if you want the directories to be checked.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>check_failed</parameter> :</term>
|
||||
<listitem><simpara> Returns a <link linkend="GList"><type>GList</type></link> of path elements for which the
|
||||
check failed.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of all directories in <parameter>path</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>path</parameter> :</term>
|
||||
<listitem><simpara> A list of directories as returned by <link linkend="gimp-path-parse"><function>gimp_path_parse()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A searchpath string separated by <link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>path</parameter> :</term>
|
||||
<listitem><simpara> A list of directories as returned by <link linkend="gimp-path-parse"><function>gimp_path_parse()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>path</parameter> :</term>
|
||||
<listitem><simpara> A list of directories as returned by <link linkend="gimp-path-parse"><function>gimp_path_parse()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The first directory in <parameter>path</parameter> where the user has write permission.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
99
devel-docs/libgimpbase/xml/gimplimits.xml
Normal file
99
devel-docs/libgimpbase/xml/gimplimits.xml
Normal file
@ -0,0 +1,99 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimplimits">
|
||||
<refmeta>
|
||||
<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>
|
||||
</refnamediv>
|
||||
|
||||
<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>
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Boundaries of some GIMP data types and some global constants.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<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"/>GIMP_MAX_IMAGE_SIZE</title>
|
||||
<indexterm><primary>GIMP_MAX_IMAGE_SIZE</primary></indexterm><programlisting>#define GIMP_MAX_IMAGE_SIZE 262144 /* 2^18 */
|
||||
</programlisting>
|
||||
<para>
|
||||
The maximum width and height of a GIMP image in pixels. This is a
|
||||
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"/>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>
|
||||
The minimum resolution of a GIMP image in pixels per inch. This is a
|
||||
somewhat arbitray value that can be used to when a lower value for a
|
||||
resolution is needed. GIMP will not accept resolutions smaller than
|
||||
this value.
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
The maximum resolution of a GIMP image in pixels per inch. This is a
|
||||
somewhat arbitray value that can be used to when an upper value for a
|
||||
resolution is needed. GIMP will not accept resolutions larger than
|
||||
this value.
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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 << 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 <literal>G_MAXDOUBLE</literal> since
|
||||
the <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link> doesn't handle larger values.
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
133
devel-docs/libgimpbase/xml/gimpmemsize.xml
Normal file
133
devel-docs/libgimpbase/xml/gimpmemsize.xml
Normal file
@ -0,0 +1,133 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpmemsize">
|
||||
<refmeta>
|
||||
<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>
|
||||
</refnamediv>
|
||||
|
||||
<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)
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Functions to (de)serialize a given memory size.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-memsize-serialize"/>gimp_memsize_serialize ()</title>
|
||||
<indexterm role="GIMP"><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
|
||||
config files. It should not be displayed to the user. If you need a
|
||||
nice human-readable string please use <link linkend="gimp-memsize-to-string"><function>gimp_memsize_to_string()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>memsize</parameter> :</term>
|
||||
<listitem><simpara> memory size in bytes
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated string representation of <parameter>memsize</parameter>.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-memsize-deserialize"/>gimp_memsize_deserialize ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>string</parameter> :</term>
|
||||
<listitem><simpara> a string as returned by <link linkend="gimp-memsize-serialize"><function>gimp_memsize_serialize()</function></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>memsize</parameter> :</term>
|
||||
<listitem><simpara> return location for memory size in bytes
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</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>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
reasonable memsize unit, e.g.: "345" becomes "345 Bytes", "4500"
|
||||
becomes "4.4 KB" and so on.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>memsize</parameter> :</term>
|
||||
<listitem><simpara> A memory size in bytes.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated human-readable, translated string.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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"/>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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
342
devel-docs/libgimpbase/xml/gimpparasite.xml
Normal file
342
devel-docs/libgimpbase/xml/gimpparasite.xml
Normal file
@ -0,0 +1,342 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpparasite">
|
||||
<refmeta>
|
||||
<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>
|
||||
</refnamediv>
|
||||
|
||||
<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>
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Arbitrary pieces of data which can be attached to various GIMP objects.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<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. */
|
||||
guint32 size; /* amount of data */
|
||||
gpointer data; /* a pointer to the data. plugin is *
|
||||
* responsible for tracking byte order */
|
||||
} GimpParasite;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>name</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>flags</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>size</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>a</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>b</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>name</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>flag</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parasite</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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"/>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"/>GIMP_PARASITE_ATTACH_PARENT</title>
|
||||
<indexterm><primary>GIMP_PARASITE_ATTACH_PARENT</primary></indexterm><programlisting>#define GIMP_PARASITE_ATTACH_PARENT (0x80 << 8)
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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 << 8)
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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 << 8)
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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 << 16)
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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 << 16)
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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 << 16)
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="gimp-image-parasite-attach"><function>gimp_image_parasite_attach()</function></link>, <link linkend="gimp-drawable-parasite-attach"><function>gimp_drawable_parasite_attach()</function></link>,
|
||||
<link linkend="gimp-parasite-attach"><function>gimp_parasite_attach()</function></link> and their related functions.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
109
devel-docs/libgimpbase/xml/gimpparasiteio.xml
Normal file
109
devel-docs/libgimpbase/xml/gimpparasiteio.xml
Normal file
@ -0,0 +1,109 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpparasiteio">
|
||||
<refmeta>
|
||||
<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>
|
||||
</refnamediv>
|
||||
|
||||
<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);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<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"/>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">
|
||||
<varlistentry><term><parameter>params</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>parameters</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>params</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>params</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="GimpParasite"><type>GimpParasite</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
556
devel-docs/libgimpbase/xml/gimpprotocol.xml
Normal file
556
devel-docs/libgimpbase/xml/gimpprotocol.xml
Normal file
@ -0,0 +1,556 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpprotocol">
|
||||
<refmeta>
|
||||
<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>
|
||||
</refnamediv>
|
||||
|
||||
<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);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
The communication protocol between GIMP and it's plug-ins.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<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"/>GPConfig</title>
|
||||
<indexterm><primary>GPConfig</primary></indexterm><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;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GPTileReq"/>GPTileReq</title>
|
||||
<indexterm><primary>GPTileReq</primary></indexterm><programlisting>typedef struct {
|
||||
gint32 drawable_ID;
|
||||
guint32 tile_num;
|
||||
guint32 shadow;
|
||||
} GPTileReq;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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"/>GPTileData</title>
|
||||
<indexterm><primary>GPTileData</primary></indexterm><programlisting>typedef struct {
|
||||
gint32 drawable_ID;
|
||||
guint32 tile_num;
|
||||
guint32 shadow;
|
||||
guint32 bpp;
|
||||
guint32 width;
|
||||
guint32 height;
|
||||
guint32 use_shm;
|
||||
guchar *data;
|
||||
} GPTileData;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GPParam"/>GPParam</title>
|
||||
<indexterm><primary>GPParam</primary></indexterm><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;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GPParamDef"/>GPParamDef</title>
|
||||
<indexterm><primary>GPParamDef</primary></indexterm><programlisting>typedef struct {
|
||||
guint32 type;
|
||||
gchar *name;
|
||||
gchar *description;
|
||||
} GPParamDef;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GPProcRun"/>GPProcRun</title>
|
||||
<indexterm><primary>GPProcRun</primary></indexterm><programlisting>typedef struct {
|
||||
gchar *name;
|
||||
guint32 nparams;
|
||||
GPParam *params;
|
||||
} GPProcRun;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GPProcReturn"/>GPProcReturn</title>
|
||||
<indexterm><primary>GPProcReturn</primary></indexterm><programlisting>typedef struct {
|
||||
gchar *name;
|
||||
guint32 nparams;
|
||||
GPParam *params;
|
||||
} GPProcReturn;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GPProcInstall"/>GPProcInstall</title>
|
||||
<indexterm><primary>GPProcInstall</primary></indexterm><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;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GPProcUninstall"/>GPProcUninstall</title>
|
||||
<indexterm><primary>GPProcUninstall</primary></indexterm><programlisting>typedef struct {
|
||||
gchar *name;
|
||||
} GPProcUninstall;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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"/>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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>config</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>tile_req</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>tile_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>proc_run</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>proc_return</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>proc_run</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>proc_return</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>proc_install</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>proc_uninstall</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="libgimp-gimpwire"><type>libgimp-gimpwire</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
113
devel-docs/libgimpbase/xml/gimpsignal.xml
Normal file
113
devel-docs/libgimpbase/xml/gimpsignal.xml
Normal file
@ -0,0 +1,113 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpsignal">
|
||||
<refmeta>
|
||||
<refentrytitle>gimpsignal</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>gimpsignal</refname><refpurpose>Portable signal handling.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<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);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Portable signal handling.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<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
|
||||
special values defined by your system's signal.h header file (like
|
||||
<parameter>SIG_DFL</parameter> or <parameter>SIG_IGN</parameter>).
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>signum</parameter> :</term>
|
||||
<listitem><simpara>The number of the signal. Useful if different signals are handled
|
||||
by a single handler.
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
sa_flags are set; these primarily to ensure restarting
|
||||
of interrupted system calls. See sigaction(2) It is a
|
||||
aid to transition and not new development: that effort
|
||||
should employ sigaction directly. [gosgood 18.04.2000]
|
||||
</para>
|
||||
<para>
|
||||
Cause <parameter>handler</parameter> to be run when <parameter>signum</parameter> is delivered. We
|
||||
use sigaction(2) rather than signal(2) so that we can control the
|
||||
signal handler's environment completely via <parameter>flags</parameter>: some signal(2)
|
||||
implementations differ in their sematics, so we need to nail down
|
||||
exactly what we want. [austin 06.04.2000]</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>signum</parameter> :</term>
|
||||
<listitem><simpara> Selects signal to be handled see man 5 signal (or man 7 signal)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>handler</parameter> :</term>
|
||||
<listitem><simpara> Handler that maps to signum. Invoked by O/S.
|
||||
Handler gets signal that caused invocation. Corresponds
|
||||
to the <parameter>sa_handler</parameter> field of the <parameter>sigaction</parameter> struct.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>flags</parameter> :</term>
|
||||
<listitem><simpara> Preferences. OR'ed SA_<xxx>. See man sigaction. Corresponds
|
||||
to the <parameter>sa_flags</parameter> field of the <parameter>sigaction</parameter> struct.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A reference to the signal handling function which was
|
||||
active before the call to <link linkend="gimp-signal-private"><function>gimp_signal_private()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
signal(2), signal(5 or 7), sigaction(2).
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
350
devel-docs/libgimpbase/xml/gimpunit.xml
Normal file
350
devel-docs/libgimpbase/xml/gimpunit.xml
Normal file
@ -0,0 +1,350 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpunit">
|
||||
<refmeta>
|
||||
<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
|
||||
user-defined units.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<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)
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Provides a collection of predefined units and functions for creating
|
||||
user-defined units.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpUnit"/>enum GimpUnit</title>
|
||||
<indexterm><primary>GimpUnit</primary></indexterm><programlisting>typedef enum /*< skip >*/
|
||||
{
|
||||
GIMP_UNIT_PIXEL = 0,
|
||||
|
||||
GIMP_UNIT_INCH = 1,
|
||||
GIMP_UNIT_MM = 2,
|
||||
GIMP_UNIT_POINT = 3,
|
||||
GIMP_UNIT_PICA = 4,
|
||||
|
||||
GIMP_UNIT_END = 5,
|
||||
|
||||
GIMP_UNIT_PERCENT = 65536 /*< pdb-skip >*/
|
||||
} GimpUnit;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of defined units.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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"
|
||||
UNIT_PIXEL).</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of built-in units.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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 <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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>identifier</parameter> :</term>
|
||||
<listitem><simpara> The unit's identifier string.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>factor</parameter> :</term>
|
||||
<listitem><simpara> The unit's factor (how many units are in one inch).
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>digits</parameter> :</term>
|
||||
<listitem><simpara> The unit's suggested number of digits (see <link linkend="gimp-unit-get-digits"><function>gimp_unit_get_digits()</function></link>).
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>symbol</parameter> :</term>
|
||||
<listitem><simpara> The symbol of the unit (e.g. "''" for inch).
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>abbreviation</parameter> :</term>
|
||||
<listitem><simpara> The abbreviation of the unit.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>singular</parameter> :</term>
|
||||
<listitem><simpara> The singular form of the unit.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>plural</parameter> :</term>
|
||||
<listitem><simpara> The plural form of the unit.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The ID of the new unit.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit you want to know the <parameter>deletion_flag</parameter> of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The unit's <parameter>deletion_flag</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
<literal>TRUE</literal> when GIMP exits, this unit will not be saved in the users's
|
||||
"unitrc" file.
|
||||
</para>
|
||||
<para>
|
||||
Trying to change the <parameter>deletion_flag</parameter> of a built-in unit will be silently
|
||||
ignored.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit you want to set the <parameter>deletion_flag</parameter> for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>deletion_flag</parameter> :</term>
|
||||
<listitem><simpara> The new deletion_flag.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
<para>
|
||||
distance_in_units == (<parameter>factor</parameter> * distance_in_inches)
|
||||
</para>
|
||||
<para>
|
||||
Returns 0 for <parameter>unit</parameter> == GIMP_UNIT_PIXEL.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit you want to know the factor of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The unit's factor.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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.
|
||||
</para>
|
||||
<para>
|
||||
Returns 0 for <parameter>unit</parameter> == GIMP_UNIT_PIXEL.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit you want to know the digits.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The suggested number of digits.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit you want to know the identifier of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The unit's identifier.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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>
|
||||
<para>
|
||||
NOTE: This string must not be changed or freed.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit you want to know the symbol of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The unit's symbol.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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.
|
||||
</para>
|
||||
<para>
|
||||
NOTE: This string must not be changed or freed.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit you want to know the abbreviation of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The unit's abbreviation.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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.
|
||||
</para>
|
||||
<para>
|
||||
NOTE: This string must not be changed or freed.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit you want to know the singular form of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The unit's singular form.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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.
|
||||
</para>
|
||||
<para>
|
||||
NOTE: This string must not be changed or freed.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit you want to know the plural form of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The unit's plural form.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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"/>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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
411
devel-docs/libgimpbase/xml/gimputils.xml
Normal file
411
devel-docs/libgimpbase/xml/gimputils.xml
Normal file
@ -0,0 +1,411 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimputils">
|
||||
<refmeta>
|
||||
<refentrytitle>gimputils</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>gimputils</refname><refpurpose>Utilities of general interest</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<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);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<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.
|
||||
</para>
|
||||
<para>
|
||||
If <parameter>str</parameter> is valid UTF-8, a copy of the string is returned.
|
||||
</para>
|
||||
<para>
|
||||
If UTF-8 validation fails, <link linkend="g-locale-to-utf8"><function>g_locale_to_utf8()</function></link> is tried and if it
|
||||
succeeds the resulting string is returned.
|
||||
</para>
|
||||
<para>
|
||||
Otherwise, the portion of <parameter>str</parameter> that is UTF-8, concatenated
|
||||
with "(invalid UTF-8 string)" is returned. If not even the start
|
||||
of <parameter>str</parameter> is valid UTF-8, only "(invalid UTF-8 string)" is returned.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>str</parameter> :</term>
|
||||
<listitem><simpara> The string to be converted to UTF-8.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>len</parameter> :</term>
|
||||
<listitem><simpara> The length of the string, or -1 if the string
|
||||
is nul-terminated.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>warning_format</parameter> :</term>
|
||||
<listitem><simpara> The message format for the warning message if conversion
|
||||
to UTF-8 fails. See the <function><link linkend="printf"><function>printf()</function></link></function>
|
||||
documentation.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>...</parameter> :</term>
|
||||
<listitem><simpara> The parameters to insert into the format string.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The UTF-8 string as described above.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
guaranteed to be valid only during the current iteration of the
|
||||
main loop or until the next call to <link linkend="gimp-filename-to-utf8"><function>gimp_filename_to_utf8()</function></link>.
|
||||
</para>
|
||||
<para>
|
||||
The only purpose of this function is to provide an easy way to pass
|
||||
a filename in the filesystem encoding to a function that expects an
|
||||
UTF-8 encoded filename.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>filename</parameter> :</term>
|
||||
<listitem><simpara> The filename to be converted to UTF-8.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A temporarily valid UTF-8 representation of <parameter>filename</parameter>.
|
||||
This string must not be changed or freed.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
that the string was trimmed is indicated by appending an ellipsis.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>str</parameter> :</term>
|
||||
<listitem><simpara> an UTF-8 encoded string (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>max_chars</parameter> :</term>
|
||||
<listitem><simpara> the maximum number of characters before the string get
|
||||
trimmed
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A (possibly trimmed) 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-escape-uline"/>gimp_escape_uline ()</title>
|
||||
<indexterm role="GIMP"><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
|
||||
strings with underlines (like filenames) in a place that would convert
|
||||
them to mnemonics.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>str</parameter> :</term>
|
||||
<listitem><simpara> Underline infested string (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</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>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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
|
||||
from menu paths etc.
|
||||
</para>
|
||||
<para>
|
||||
In some languages, mnemonics are handled by adding the mnemonic
|
||||
character in brackets (like "File (_F)"). This function recognizes
|
||||
this construct and removes the whole bracket construction to get
|
||||
rid of the mnemonic (see bug <link linkend="157561:CAPS"><type>157561</type></link>).</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>str</parameter> :</term>
|
||||
<listitem><simpara> underline infested string (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</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"/>gimp_enum_get_desc ()</title>
|
||||
<indexterm role="GIMP"><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">
|
||||
<varlistentry><term><parameter>enum_class</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GEnumClass"><type>GEnumClass</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> a value from <parameter>enum_class</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the value's <link linkend="GimpEnumDesc"><type>GimpEnumDesc</type></link>.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-enum-get-value"/>gimp_enum_get_value ()</title>
|
||||
<indexterm role="GIMP"><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 <literal>NULL</literal>).</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>enum_type</parameter> :</term>
|
||||
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of a registered enum
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> an integer value
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value_name</parameter> :</term>
|
||||
<listitem><simpara> return location for the value's name (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value_nick</parameter> :</term>
|
||||
<listitem><simpara> return location for the value's nick (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value_desc</parameter> :</term>
|
||||
<listitem><simpara> return location for the value's translated desc (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value_help</parameter> :</term>
|
||||
<listitem><simpara> return location for the value's translated help (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</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>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-enum-value-get-desc"/>gimp_enum_value_get_desc ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>enum_class</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GEnumClass"><type>GEnumClass</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>enum_value</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GEnumValue"><type>GEnumValue</type></link> from <parameter>enum_class</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the translated desc of the enum value
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-enum-value-get-help"/>gimp_enum_value_get_help ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>enum_class</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GEnumClass"><type>GEnumClass</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>enum_value</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GEnumValue"><type>GEnumValue</type></link> from <parameter>enum_class</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the translated help of the enum value
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-flags-get-first-desc"/>gimp_flags_get_first_desc ()</title>
|
||||
<indexterm role="GIMP"><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 <literal>NULL</literal>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>flags_class</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GFlagsClass"><type>GFlagsClass</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> a value from <parameter>flags_class</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the value's <link linkend="GimpFlagsDesc"><type>GimpFlagsDesc</type></link>.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-flags-get-first-value"/>gimp_flags_get_first_value ()</title>
|
||||
<indexterm role="GIMP"><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 <literal>NULL</literal>).</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>flags_type</parameter> :</term>
|
||||
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of registered flags
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> an integer value
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value_name</parameter> :</term>
|
||||
<listitem><simpara> return location for the value's name (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value_nick</parameter> :</term>
|
||||
<listitem><simpara> return location for the value's nick (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value_desc</parameter> :</term>
|
||||
<listitem><simpara> return location for the value's translated desc (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value_help</parameter> :</term>
|
||||
<listitem><simpara> return location for the value's translated help (or <literal>NULL</literal>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</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>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-flags-value-get-desc"/>gimp_flags_value_get_desc ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>flags_class</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GFlagsClass"><type>GFlagsClass</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>flags_value</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GFlagsValue"><type>GFlagsValue</type></link> from <parameter>flags_class</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the translated desc of the flags value
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-flags-value-get-help"/>gimp_flags_value_get_help ()</title>
|
||||
<indexterm role="GIMP"><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>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>flags_class</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GFlagsClass"><type>GFlagsClass</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>flags_value</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GFlagsValue"><type>GFlagsValue</type></link> from <parameter>flags_class</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the translated help of the flags value
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
110
devel-docs/libgimpbase/xml/gimpversion.xml
Normal file
110
devel-docs/libgimpbase/xml/gimpversion.xml
Normal file
@ -0,0 +1,110 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpversion">
|
||||
<refmeta>
|
||||
<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
|
||||
capabilities.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<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)
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Macros and constants useful for determining GIMP's version number and
|
||||
capabilities.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<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"/>GIMP_MINOR_VERSION</title>
|
||||
<indexterm><primary>GIMP_MINOR_VERSION</primary></indexterm><programlisting>#define GIMP_MINOR_VERSION (2)
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GIMP-MICRO-VERSION:CAPS"/>GIMP_MICRO_VERSION</title>
|
||||
<indexterm><primary>GIMP_MICRO_VERSION</primary></indexterm><programlisting>#define GIMP_MICRO_VERSION (4)
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GIMP-VERSION:CAPS"/>GIMP_VERSION</title>
|
||||
<indexterm><primary>GIMP_VERSION</primary></indexterm><programlisting>#define GIMP_VERSION "2.2.4"
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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"/>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">
|
||||
<varlistentry><term><parameter>major</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>minor</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>micro</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
706
devel-docs/libgimpbase/xml/gimpwire.xml
Normal file
706
devel-docs/libgimpbase/xml/gimpwire.xml
Normal file
@ -0,0 +1,706 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
||||
|
||||
<refentry id="libgimpbase-gimpwire">
|
||||
<refmeta>
|
||||
<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
|
||||
it's plug-ins.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<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);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
The lowlevel I/O protocol used for communication between GIMP and
|
||||
it's plug-ins.
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="WireMessage"/>WireMessage</title>
|
||||
<indexterm><primary>WireMessage</primary></indexterm><programlisting>typedef struct {
|
||||
guint32 type;
|
||||
gpointer data;
|
||||
} WireMessage;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>msg</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>msg</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>msg</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>read_func</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>write_func</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>destroy_func</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>read_func</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>write_func</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>flush_func</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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"/>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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>msg</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>msg</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>msg</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<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">
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>count</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="libgimp-gimpprotocol"><type>libgimp-gimpprotocol</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
Reference in New Issue
Block a user