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

new directory devel-docs/libgimpbase/

Browse Source 
2001-05-25  Michael Natterer  <mitch@gimp.org>

	* configure.in: new directory devel-docs/libgimpbase/

2001-05-25  Michael Natterer  <mitch@gimp.org>

	* Makefile.am
	* libgimpbase/*: new gtk-doc module for the new library.

	* libgimp/*: removed the files which belong to libgimpbase, updates.

	* libgimpmath/libgimpmath-decl.txt
	* libgimpmath/libgimpmath.hierarchy
	* libgimpwidgets/libgimpwidgets-decl.txt
	* libgimpwidgets/libgimpwidgets-sections.txt
	* libgimpwidgets/libgimpwidgets.hierarchy
	* libgimpwidgets/tmpl/gimpbutton.sgml
	* libgimpwidgets/tmpl/gimpoffsetarea.sgml
	* libgimpwidgets/tmpl/gimpwidgetstypes.sgml: updated.
This commit is contained in:
Michael Natterer
2001-05-25 20:44:40 +00:00
committed by Michael Natterer
parent ca6ee05ea3
commit ced2d1481b
45 changed files with 2251 additions and 1956 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
devel-docs/libgimpbase/.cvsignore Normal file
View File

@ -0,0 +1,7 @@
Makefile
Makefile.in
libgimpbase.html
libgimpbase-decl-list.txt
libgimpbase-unused.txt
html
sgml

91
devel-docs/libgimpbase/Makefile.am Normal file
View File

@ -0,0 +1,91 @@
## Process this file with automake to produce Makefile.in
# The name of the module.
DOC_MODULE=libgimpbase
# The top-level SGML file.
DOC_MAIN_SGML_FILE=libgimpbase-docs.sgml
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=$(top_srcdir)/libgimpbase
CFLAGS=`gimptool-1.4 --cflags`
LDFLAGS=`gimptool-1.4 --libs`
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
libgimpbase_docdir = $(HTML_DIR)
EXTRA_DIST = \
$(DOC_MAIN_SGML_FILE) \
$(DOC_MODULE).hierarchy \
$(DOC_MODULE).signals \
$(DOC_MODULE).types \
$(DOC_MODULE)-include.c \
$(DOC_MODULE)-decl.txt \
$(DOC_MODULE)-sections.txt
if ENABLE_GTK_DOC
html/index.html: sgml/libgimpbase-doc.bottom
$(MAKE) html
else
html/index.html:
endif
sgml/libgimpbase-doc.bottom: $(tmpl_sources)
$(MAKE) sgml
scan:
-(cd $(srcdir) \
&& env \
CFLAGS="$(CFLAGS)" \
CPPFLAGS="$(CPPFLAGS)" \
LDFLAGS="$(LDFLAGS)" \
gtkdoc-scanobj --module=$(DOC_MODULE) \
&& gtkdoc-scan \
--module=$(DOC_MODULE) \
--source-dir=$(DOC_SOURCE_DIR))
templates: scan
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
sgml:
cd $(srcdir) \
&& gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
html:
test -d $(srcdir)/html || mkdir $(srcdir)/html
-cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
clean-local:
rm -f *~ *.bak *-unused.txt
maintainer-clean-local: clean
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
(installfiles=`echo $(srcdir)/html/*.html`; \
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
then echo '-- Nothing to install' ; \
else \
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); \
echo '-- Fixing Crossreferences' ; \
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
fi)
dist-hook:
mkdir $(distdir)/html
mkdir $(distdir)/sgml
mkdir $(distdir)/tmpl
-cp $(srcdir)/html/*.html $(srcdir)/html/index.sgml $(distdir)/html
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
.PHONY : html sgml templates scan

773
devel-docs/libgimpbase/libgimpbase-decl.txt Normal file
View File

@ -0,0 +1,773 @@
<STRUCT>
<NAME>GimpParasite</NAME>
</STRUCT>
<ENUM>
<NAME>GimpUnit</NAME>
typedef enum /*< chop=GIMP_ >*/
{
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 /*< skip >*/
} GimpUnit;
</ENUM>
<ENUM>
<NAME>GimpPDBArgType</NAME>
typedef enum /*< chop=GIMP_ >*/
{
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;
</ENUM>
<ENUM>
<NAME>GimpPDBProcType</NAME>
typedef enum /*< chop=GIMP_ >*/
{
GIMP_INTERNAL,
GIMP_PLUGIN,
GIMP_EXTENSION,
GIMP_TEMPORARY
} GimpPDBProcType;
</ENUM>
<ENUM>
<NAME>GimpPDBStatusType</NAME>
typedef enum /*< chop=GIMP_ >*/
{
GIMP_PDB_EXECUTION_ERROR,
GIMP_PDB_CALLING_ERROR,
GIMP_PDB_PASS_THROUGH,
GIMP_PDB_SUCCESS,
GIMP_PDB_CANCEL
} GimpPDBStatusType;
</ENUM>
<FUNCTION>
<NAME>gimp_directory</NAME>
<RETURNS>const gchar *</RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_personal_rc_file</NAME>
<RETURNS>gchar *</RETURNS>
const gchar *basename
</FUNCTION>
<FUNCTION>
<NAME>gimp_data_directory</NAME>
<RETURNS>const gchar *</RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_sysconf_directory</NAME>
<RETURNS>const gchar *</RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_gtkrc</NAME>
<RETURNS>const gchar *</RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_path_parse</NAME>
<RETURNS>GList *</RETURNS>
const gchar *path,gint max_paths,gboolean check,GList **check_failed
</FUNCTION>
<FUNCTION>
<NAME>gimp_path_to_str</NAME>
<RETURNS>gchar *</RETURNS>
GList *path
</FUNCTION>
<FUNCTION>
<NAME>gimp_path_free</NAME>
<RETURNS>void </RETURNS>
GList *path
</FUNCTION>
<FUNCTION>
<NAME>gimp_path_get_user_writable_dir</NAME>
<RETURNS>gchar *</RETURNS>
GList *path
</FUNCTION>
<MACRO>
<NAME>GIMP_MIN_IMAGE_SIZE</NAME>
#define GIMP_MIN_IMAGE_SIZE 1
</MACRO>
<MACRO>
<NAME>GIMP_MAX_IMAGE_SIZE</NAME>
#define GIMP_MAX_IMAGE_SIZE 16777216 /* 2^24 */
</MACRO>
<MACRO>
<NAME>GIMP_MIN_RESOLUTION</NAME>
#define GIMP_MIN_RESOLUTION 5e-3 /* shouldn't display as 0.000 */
</MACRO>
<MACRO>
<NAME>GIMP_MAX_RESOLUTION</NAME>
#define GIMP_MAX_RESOLUTION 65536.0
</MACRO>
<MACRO>
<NAME>GIMP_CHECK_SIZE</NAME>
#define GIMP_CHECK_SIZE 8
</MACRO>
<MACRO>
<NAME>GIMP_CHECK_SIZE_SM</NAME>
#define GIMP_CHECK_SIZE_SM 4
</MACRO>
<MACRO>
<NAME>GIMP_CHECK_DARK</NAME>
#define GIMP_CHECK_DARK 0.4 /* corresponds to GRAY_CHECKS as */
</MACRO>
<MACRO>
<NAME>GIMP_CHECK_LIGHT</NAME>
#define GIMP_CHECK_LIGHT 0.6 /* defined in app/image_render.c */
</MACRO>
<MACRO>
<NAME>GIMP_PARASITE_PERSISTENT</NAME>
#define GIMP_PARASITE_PERSISTENT 1
</MACRO>
<MACRO>
<NAME>GIMP_PARASITE_UNDOABLE</NAME>
#define GIMP_PARASITE_UNDOABLE 2
</MACRO>
<MACRO>
<NAME>GIMP_PARASITE_ATTACH_PARENT</NAME>
#define GIMP_PARASITE_ATTACH_PARENT (0x80 << 8)
</MACRO>
<MACRO>
<NAME>GIMP_PARASITE_PARENT_PERSISTENT</NAME>
#define GIMP_PARASITE_PARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT << 8)
</MACRO>
<MACRO>
<NAME>GIMP_PARASITE_PARENT_UNDOABLE</NAME>
#define GIMP_PARASITE_PARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE << 8)
</MACRO>
<MACRO>
<NAME>GIMP_PARASITE_ATTACH_GRANDPARENT</NAME>
#define GIMP_PARASITE_ATTACH_GRANDPARENT (0x80 << 16)
</MACRO>
<MACRO>
<NAME>GIMP_PARASITE_GRANDPARENT_PERSISTENT</NAME>
#define GIMP_PARASITE_GRANDPARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT << 16)
</MACRO>
<MACRO>
<NAME>GIMP_PARASITE_GRANDPARENT_UNDOABLE</NAME>
#define GIMP_PARASITE_GRANDPARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE << 16)
</MACRO>
<STRUCT>
<NAME>GimpParasite</NAME>
struct GimpParasite
{
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 */
};
</STRUCT>
<FUNCTION>
<NAME>gimp_parasite_new</NAME>
<RETURNS>GimpParasite *</RETURNS>
const gchar *name,guint32 flags,guint32 size,const gpointer data
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_free</NAME>
<RETURNS>void </RETURNS>
GimpParasite *parasite
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_copy</NAME>
<RETURNS>GimpParasite *</RETURNS>
const GimpParasite *parasite
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_compare</NAME>
<RETURNS>gboolean </RETURNS>
const GimpParasite *a,const GimpParasite *b
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_is_type</NAME>
<RETURNS>gboolean </RETURNS>
const GimpParasite *parasite,const gchar *name
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_is_persistent</NAME>
<RETURNS>gboolean </RETURNS>
const GimpParasite *parasite
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_is_undoable</NAME>
<RETURNS>gboolean </RETURNS>
const GimpParasite *parasite
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_has_flag</NAME>
<RETURNS>gboolean </RETURNS>
const GimpParasite *parasite,gulong flag
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_flags</NAME>
<RETURNS>gulong </RETURNS>
const GimpParasite *parasite
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_name</NAME>
<RETURNS>const gchar *</RETURNS>
const GimpParasite *parasite
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_data</NAME>
<RETURNS>gpointer </RETURNS>
const GimpParasite *parasite
</FUNCTION>
<FUNCTION>
<NAME>gimp_parasite_data_size</NAME>
<RETURNS>glong </RETURNS>
const GimpParasite *parasite
</FUNCTION>
<MACRO>
<NAME>GIMP_PIXPIPE_MAXDIM</NAME>
#define GIMP_PIXPIPE_MAXDIM 4
</MACRO>
<FUNCTION>
<NAME>gimp_pixpipe_params_init</NAME>
<RETURNS>void </RETURNS>
GimpPixPipeParams *params
</FUNCTION>
<FUNCTION>
<NAME>gimp_pixpipe_params_parse</NAME>
<RETURNS>void </RETURNS>
gchar *parameters,GimpPixPipeParams *params
</FUNCTION>
<FUNCTION>
<NAME>gimp_pixpipe_params_build</NAME>
<RETURNS>gchar *</RETURNS>
GimpPixPipeParams *params
</FUNCTION>
<MACRO>
<NAME>GP_VERSION</NAME>
#define GP_VERSION 0x0008
</MACRO>
<STRUCT>
<NAME>GPConfig</NAME>
</STRUCT>
<STRUCT>
<NAME>GPTileReq</NAME>
</STRUCT>
<STRUCT>
<NAME>GPTileAck</NAME>
</STRUCT>
<STRUCT>
<NAME>GPTileData</NAME>
</STRUCT>
<STRUCT>
<NAME>GPParam</NAME>
</STRUCT>
<STRUCT>
<NAME>GPParamDef</NAME>
</STRUCT>
<STRUCT>
<NAME>GPProcRun</NAME>
</STRUCT>
<STRUCT>
<NAME>GPProcReturn</NAME>
</STRUCT>
<STRUCT>
<NAME>GPProcInstall</NAME>
</STRUCT>
<STRUCT>
<NAME>GPProcUninstall</NAME>
</STRUCT>
<STRUCT>
<NAME>GPConfig</NAME>
struct GPConfig
{
guint32 version;
guint32 tile_width;
guint32 tile_height;
gint32 shm_ID;
gdouble gamma;
gint8 install_cmap;
gint8 use_xshm;
gint32 min_colors;
gint32 gdisp_ID;
};
</STRUCT>
<STRUCT>
<NAME>GPTileReq</NAME>
struct GPTileReq
{
gint32 drawable_ID;
guint32 tile_num;
guint32 shadow;
};
</STRUCT>
<STRUCT>
<NAME>GPTileData</NAME>
struct GPTileData
{
gint32 drawable_ID;
guint32 tile_num;
guint32 shadow;
guint32 bpp;
guint32 width;
guint32 height;
guint32 use_shm;
guchar *data;
};
</STRUCT>
<STRUCT>
<NAME>GPParam</NAME>
struct GPParam
{
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;
};
</STRUCT>
<STRUCT>
<NAME>GPParamDef</NAME>
struct GPParamDef
{
guint32 type;
gchar *name;
gchar *description;
};
</STRUCT>
<STRUCT>
<NAME>GPProcRun</NAME>
struct GPProcRun
{
gchar *name;
guint32 nparams;
GPParam *params;
};
</STRUCT>
<STRUCT>
<NAME>GPProcReturn</NAME>
struct GPProcReturn
{
gchar *name;
guint32 nparams;
GPParam *params;
};
</STRUCT>
<STRUCT>
<NAME>GPProcInstall</NAME>
struct GPProcInstall
{
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;
};
</STRUCT>
<STRUCT>
<NAME>GPProcUninstall</NAME>
struct GPProcUninstall
{
gchar *name;
};
</STRUCT>
<FUNCTION>
<NAME>gp_init</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gp_quit_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel
</FUNCTION>
<FUNCTION>
<NAME>gp_config_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,GPConfig *config
</FUNCTION>
<FUNCTION>
<NAME>gp_tile_req_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,GPTileReq *tile_req
</FUNCTION>
<FUNCTION>
<NAME>gp_tile_ack_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel
</FUNCTION>
<FUNCTION>
<NAME>gp_tile_data_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,GPTileData *tile_data
</FUNCTION>
<FUNCTION>
<NAME>gp_proc_run_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,GPProcRun *proc_run
</FUNCTION>
<FUNCTION>
<NAME>gp_proc_return_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,GPProcReturn *proc_return
</FUNCTION>
<FUNCTION>
<NAME>gp_temp_proc_run_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,GPProcRun *proc_run
</FUNCTION>
<FUNCTION>
<NAME>gp_temp_proc_return_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,GPProcReturn *proc_return
</FUNCTION>
<FUNCTION>
<NAME>gp_proc_install_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,GPProcInstall *proc_install
</FUNCTION>
<FUNCTION>
<NAME>gp_proc_uninstall_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,GPProcUninstall *proc_uninstall
</FUNCTION>
<FUNCTION>
<NAME>gp_extension_ack_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel
</FUNCTION>
<MACRO>
<NAME>SA_RESTART</NAME>
#define SA_RESTART SA_SYSV
</MACRO>
<USER_FUNCTION>
<NAME>GimpSignalHandlerFunc</NAME>
<RETURNS>void </RETURNS>
gint signum
</USER_FUNCTION>
<FUNCTION>
<NAME>gimp_signal_private</NAME>
<RETURNS>GimpSignalHandlerFunc </RETURNS>
gint signum,GimpSignalHandlerFunc handler,gint flags
</FUNCTION>
<MACRO>
<NAME>gimp_signal_syscallrestart</NAME>
#define gimp_signal_syscallrestart(signum,handler) gimp_signal_private ((signum), (handler), SA_RESTART)
</MACRO>
<FUNCTION>
<NAME>gimp_unit_get_number_of_units</NAME>
<RETURNS>gint </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_get_number_of_built_in_units</NAME>
<RETURNS>gint </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_new</NAME>
<RETURNS>GimpUnit </RETURNS>
gchar *identifier,gdouble factor,gint digits,gchar *symbol,gchar *abbreviation,gchar *singular,gchar *plural
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_get_deletion_flag</NAME>
<RETURNS>gboolean </RETURNS>
GimpUnit unit
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_set_deletion_flag</NAME>
<RETURNS>void </RETURNS>
GimpUnit unit,gboolean deletion_flag
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_get_factor</NAME>
<RETURNS>gdouble </RETURNS>
GimpUnit unit
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_get_digits</NAME>
<RETURNS>gint </RETURNS>
GimpUnit unit
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_get_identifier</NAME>
<RETURNS>gchar *</RETURNS>
GimpUnit unit
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_get_symbol</NAME>
<RETURNS>gchar *</RETURNS>
GimpUnit unit
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_get_abbreviation</NAME>
<RETURNS>gchar *</RETURNS>
GimpUnit unit
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_get_singular</NAME>
<RETURNS>gchar *</RETURNS>
GimpUnit unit
</FUNCTION>
<FUNCTION>
<NAME>gimp_unit_get_plural</NAME>
<RETURNS>gchar *</RETURNS>
GimpUnit unit
</FUNCTION>
<MACRO>
<NAME>gimp_strescape</NAME>
#define gimp_strescape(string, exceptions) g_strescape (string, exceptions)
</MACRO>
<MACRO>
<NAME>gimp_strcompress</NAME>
#define gimp_strcompress(string) g_strcompress (string)
</MACRO>
<FUNCTION>
<NAME>gimp_strescape</NAME>
<RETURNS>gchar *</RETURNS>
const gchar *source,const gchar *exceptions
</FUNCTION>
<FUNCTION>
<NAME>gimp_strcompress</NAME>
<RETURNS>gchar *</RETURNS>
const gchar *source
</FUNCTION>
<STRUCT>
<NAME>WireMessage</NAME>
</STRUCT>
<USER_FUNCTION>
<NAME>WireReadFunc</NAME>
<RETURNS>void </RETURNS>
GIOChannel *channel,
WireMessage *msg
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>WireWriteFunc</NAME>
<RETURNS>void </RETURNS>
GIOChannel *channel,
WireMessage *msg
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>WireDestroyFunc</NAME>
<RETURNS>void </RETURNS>
WireMessage *msg
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>WireIOFunc</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,
guint8 *buf,
gulong count
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>WireFlushFunc</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel
</USER_FUNCTION>
<STRUCT>
<NAME>WireMessage</NAME>
struct WireMessage
{
guint32 type;
gpointer data;
};
</STRUCT>
<FUNCTION>
<NAME>wire_register</NAME>
<RETURNS>void </RETURNS>
guint32 type,WireReadFunc read_func,WireWriteFunc write_func,WireDestroyFunc destroy_func
</FUNCTION>
<FUNCTION>
<NAME>wire_set_reader</NAME>
<RETURNS>void </RETURNS>
WireIOFunc read_func
</FUNCTION>
<FUNCTION>
<NAME>wire_set_writer</NAME>
<RETURNS>void </RETURNS>
WireIOFunc write_func
</FUNCTION>
<FUNCTION>
<NAME>wire_set_flusher</NAME>
<RETURNS>void </RETURNS>
WireFlushFunc flush_func
</FUNCTION>
<FUNCTION>
<NAME>wire_read</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,guint8 *buf,gulong count
</FUNCTION>
<FUNCTION>
<NAME>wire_write</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,guint8 *buf,gulong count
</FUNCTION>
<FUNCTION>
<NAME>wire_flush</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel
</FUNCTION>
<FUNCTION>
<NAME>wire_error</NAME>
<RETURNS>gboolean </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>wire_clear_error</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>wire_read_msg</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,WireMessage *msg
</FUNCTION>
<FUNCTION>
<NAME>wire_write_msg</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,WireMessage *msg
</FUNCTION>
<FUNCTION>
<NAME>wire_destroy</NAME>
<RETURNS>void </RETURNS>
WireMessage *msg
</FUNCTION>
<FUNCTION>
<NAME>wire_read_int32</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,guint32 *data,gint count
</FUNCTION>
<FUNCTION>
<NAME>wire_read_int16</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,guint16 *data,gint count
</FUNCTION>
<FUNCTION>
<NAME>wire_read_int8</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,guint8 *data,gint count
</FUNCTION>
<FUNCTION>
<NAME>wire_read_double</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,gdouble *data,gint count
</FUNCTION>
<FUNCTION>
<NAME>wire_read_string</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,gchar **data,gint count
</FUNCTION>
<FUNCTION>
<NAME>wire_write_int32</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,guint32 *data,gint count
</FUNCTION>
<FUNCTION>
<NAME>wire_write_int16</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,guint16 *data,gint count
</FUNCTION>
<FUNCTION>
<NAME>wire_write_int8</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,guint8 *data,gint count
</FUNCTION>
<FUNCTION>
<NAME>wire_write_double</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,gdouble *data,gint count
</FUNCTION>
<FUNCTION>
<NAME>wire_write_string</NAME>
<RETURNS>gboolean </RETURNS>
GIOChannel *channel,gchar **data,gint count
</FUNCTION>
<MACRO>
<NAME>GIMP_MAJOR_VERSION</NAME>
#define GIMP_MAJOR_VERSION (1)
</MACRO>
<MACRO>
<NAME>GIMP_MINOR_VERSION</NAME>
#define GIMP_MINOR_VERSION (3)
</MACRO>
<MACRO>
<NAME>GIMP_MICRO_VERSION</NAME>
#define GIMP_MICRO_VERSION (0)
</MACRO>
<MACRO>
<NAME>GIMP_VERSION</NAME>
#define GIMP_VERSION "1.3.0"
</MACRO>
<MACRO>
<NAME>GIMP_CHECK_VERSION</NAME>
#define GIMP_CHECK_VERSION(major, minor, micro) \
(GIMP_MAJOR_VERSION > (major) || \
(GIMP_MAJOR_VERSION == (major) && GIMP_MINOR_VERSION > (minor)) || \
(GIMP_MAJOR_VERSION == (major) && GIMP_MINOR_VERSION == (minor) && \
GIMP_MICRO_VERSION >= (micro)))
</MACRO>

31
devel-docs/libgimpbase/libgimpbase-docs.sgml Normal file
View File

@ -0,0 +1,31 @@
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity libgimpbase-gimpbasetypes SYSTEM "sgml/gimpbasetypes.sgml">
<!entity libgimpbase-gimpsignal SYSTEM "sgml/gimpsignal.sgml">
<!entity libgimpbase-gimpwire SYSTEM "sgml/gimpwire.sgml">
<!entity libgimpbase-gimpparasite SYSTEM "sgml/gimpparasite.sgml">
<!entity libgimpbase-gimpenv SYSTEM "sgml/gimpenv.sgml">
<!entity libgimpbase-gimplimits SYSTEM "sgml/gimplimits.sgml">
<!entity libgimpbase-gimpparasiteio SYSTEM "sgml/gimpparasiteio.sgml">
<!entity libgimpbase-gimpversion SYSTEM "sgml/gimpversion.sgml">
<!entity libgimpbase-gimpunit SYSTEM "sgml/gimpunit.sgml">
<!entity libgimpbase-gimputils SYSTEM "sgml/gimputils.sgml">
]>
<book id="index">
<bookinfo>
<title>GIMP Base Library Reference Manual</title>
</bookinfo>
<chapter id="libgimpbase">
<title>GIMP Base Library</title>
&libgimpbase-gimpbasetypes;
&libgimpbase-gimpversion;
&libgimpbase-gimplimits;
&libgimpbase-gimpenv;
&libgimpbase-gimpparasite;
&libgimpbase-gimpparasiteio;
&libgimpbase-gimpsignal;
&libgimpbase-gimpunit;
&libgimpbase-gimputils;
&libgimpbase-gimpwire;
</chapter>
</book>

15
devel-docs/libgimpbase/libgimpbase-include.c Normal file
View File

@ -0,0 +1,15 @@
/*
* gtk-doc can't build libgimpbase-scan.c without PLUG_IN_INFO being defined
* so we include this file as a workaround
*/
#include <gtk/gtk.h>
#include <libgimp/gimp.h>
GimpPlugInInfo PLUG_IN_INFO =
{
NULL,
NULL,
NULL,
NULL,
};

170
devel-docs/libgimpbase/libgimpbase-sections.txt Normal file
View File

@ -0,0 +1,170 @@
<SECTION>
<FILE>gimpbasetypes</FILE>
GimpParasite
GimpUnit
GimpPDBArgType
GimpPDBProcType
GimpPDBStatusType
</SECTION>
<SECTION>
<FILE>gimpbase</FILE>
</SECTION>
<SECTION>
<FILE>gimpenv</FILE>
gimp_directory
gimp_personal_rc_file
gimp_data_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_CHECK_SIZE
GIMP_CHECK_SIZE_SM
GIMP_CHECK_DARK
GIMP_CHECK_LIGHT
</SECTION>
<SECTION>
<FILE>gimpparasite</FILE>
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
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
</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>
GP_VERSION
GPConfig
GPTileReq
GPTileAck
GPTileData
GPParam
GPParamDef
GPProcRun
GPProcReturn
GPProcInstall
GPProcUninstall
gp_init
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>
SA_RESTART
GimpSignalHandlerFunc
gimp_signal_private
gimp_signal_syscallrestart
</SECTION>
<SECTION>
<FILE>gimpunit</FILE>
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
</SECTION>
<SECTION>
<FILE>gimputils</FILE>
gimp_strescape
gimp_strcompress
</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_CHECK_VERSION
</SECTION>

0
devel-docs/libgimpbase/libgimpbase.args Normal file
View File

21
devel-docs/libgimpbase/libgimpbase.hierarchy Normal file
View File

@ -0,0 +1,21 @@
GtkObject
GtkWidget
GtkRange
GtkScrollbar
GtkVScrollbar
GtkHScrollbar
GtkScale
GtkHScale
GtkVScale
GtkContainer
GtkBin
GtkButton
GtkToggleButton
GtkCheckButton
GtkRadioButton
GtkScrolledWindow
GtkPaned
GtkVPaned
GtkHPaned
GtkData
GtkAdjustment

0
devel-docs/libgimpbase/libgimpbase.signals Normal file
View File

3
devel-docs/libgimpbase/libgimpbase.types Normal file
View File

@ -0,0 +1,3 @@
#include <gtk/gtk.h>
#include "libgimpbase-include.c"

1
devel-docs/libgimpbase/tmpl/.cvsignore Normal file
View File

@ -0,0 +1 @@
libgimpbase-unused.sgml

16
devel-docs/libgimpbase/tmpl/gimpbase.sgml Normal file
View File

@ -0,0 +1,16 @@
<!-- ##### SECTION Title ##### -->
gimpbase
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

89
devel-docs/libgimpbase/tmpl/gimpbasetypes.sgml Normal file
View File

@ -0,0 +1,89 @@
<!-- ##### SECTION Title ##### -->
gimpbasetypes
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GimpParasite ##### -->
<para>
</para>
@name:
@flags:
@size:
@data:
<!-- ##### 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:
<!-- ##### 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:

96
devel-docs/libgimpbase/tmpl/gimpenv.sgml Normal file
View File

@ -0,0 +1,96 @@
<!-- ##### 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_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:

73
devel-docs/libgimpbase/tmpl/gimplimits.sgml Normal file
View File

@ -0,0 +1,73 @@
<!-- ##### 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>
</para>
<!-- ##### MACRO GIMP_MAX_IMAGE_SIZE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_MIN_RESOLUTION ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_MAX_RESOLUTION ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CHECK_SIZE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CHECK_SIZE_SM ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CHECK_DARK ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_CHECK_LIGHT ##### -->
<para>
</para>

197
devel-docs/libgimpbase/tmpl/gimpparasite.sgml Normal file
View 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>
<!-- ##### 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>
<!-- ##### 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:

50
devel-docs/libgimpbase/tmpl/gimpparasiteio.sgml Normal file
View 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:

261
devel-docs/libgimpbase/tmpl/gimpprotocol.sgml Normal file
View File

@ -0,0 +1,261 @@
<!-- ##### 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 GP_VERSION ##### -->
<para>
</para>
<!-- ##### STRUCT GPConfig ##### -->
<para>
</para>
@version:
@tile_width:
@tile_height:
@shm_ID:
@gamma:
@install_cmap:
@use_xshm:
@min_colors:
@gdisp_ID:
<!-- ##### 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_quit_write ##### -->
<para>
</para>
@channel:
@Returns:
<!-- ##### FUNCTION gp_config_write ##### -->
<para>
</para>
@channel:
@config:
@Returns:
<!-- ##### FUNCTION gp_tile_req_write ##### -->
<para>
</para>
@channel:
@tile_req:
@Returns:
<!-- ##### FUNCTION gp_tile_ack_write ##### -->
<para>
</para>
@channel:
@Returns:
<!-- ##### FUNCTION gp_tile_data_write ##### -->
<para>
</para>
@channel:
@tile_data:
@Returns:
<!-- ##### FUNCTION gp_proc_run_write ##### -->
<para>
</para>
@channel:
@proc_run:
@Returns:
<!-- ##### FUNCTION gp_proc_return_write ##### -->
<para>
</para>
@channel:
@proc_return:
@Returns:
<!-- ##### FUNCTION gp_temp_proc_run_write ##### -->
<para>
</para>
@channel:
@proc_run:
@Returns:
<!-- ##### FUNCTION gp_temp_proc_return_write ##### -->
<para>
</para>
@channel:
@proc_return:
@Returns:
<!-- ##### FUNCTION gp_proc_install_write ##### -->
<para>
</para>
@channel:
@proc_install:
@Returns:
<!-- ##### FUNCTION gp_proc_uninstall_write ##### -->
<para>
</para>
@channel:
@proc_uninstall:
@Returns:
<!-- ##### FUNCTION gp_extension_ack_write ##### -->
<para>
</para>
@channel:
@Returns:

58
devel-docs/libgimpbase/tmpl/gimpsignal.sgml Normal file
View File

@ -0,0 +1,58 @@
<!-- ##### 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>
<!-- ##### MACRO SA_RESTART ##### -->
<para>
This is just an alias for systems which do not define SA_RESTART.
</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:
<!-- ##### MACRO gimp_signal_syscallrestart ##### -->
<para>
Installs a signal handler in a way that system calls which were not finished
at the time of signal handler invocation will be silently restarted
by the system (without failing with an error of EINTR).
</para>
@signum: The number of the signal.
@handler: The signal handler.

190
devel-docs/libgimpbase/tmpl/gimpunit.sgml Normal file
View File

@ -0,0 +1,190 @@
<!-- ##### 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>
<!-- ##### FUNCTION gimp_unit_get_number_of_units ##### -->
<para>
Returns the number of units which are known to the #GimpUnit system.
</para>
@Returns: The number of defined units.
<!-- ##### FUNCTION gimp_unit_get_number_of_built_in_units ##### -->
<para>
Returns the number of #GimpUnit's which are hardcoded in the unit system
(UNIT_INCH, UNIT_MM, UNIT_POINT, UNIT_PICA and the "pseudo unit" UNIT_PIXEL).
</para>
@Returns: The number of built-in units.
<!-- ##### FUNCTION gimp_unit_new ##### -->
<para>
Returns the integer ID of the new #GimpUnit.
</para>
<para>
Note that a new unit is always created with it's deletion flag
set to #TRUE. You will have to set it to #FALSE with
gimp_unit_set_deletion_flag() to make the unit definition persistent.
</para>
@identifier: The unit's identifier string.
@factor: The unit's factor (how many units are in one inch).
@digits: The unit's suggested number of digits (see gimp_unit_get_digits()).
@symbol: The symbol of the unit (e.g. "''" for inch).
@abbreviation: The abbreviation of the unit.
@singular: The singular form of the unit.
@plural: The plural form of the unit.
@Returns: The ID of the new unit.
<!-- ##### FUNCTION gimp_unit_get_deletion_flag ##### -->
<para>
</para>
@unit: The unit you want to know the @deletion_flag of.
@Returns: The unit's @deletion_flag.
<!-- ##### FUNCTION gimp_unit_set_deletion_flag ##### -->
<para>
Sets a #GimpUnit's @deletion_flag. If the @deletion_flag of a unit is
#TRUE when GIMP exits, this unit will not be saved in the uses's
"unitrc" file.
</para>
<para>
Trying to change the @deletion_flag of a built-in unit will be silently
ignored.
</para>
@unit: The unit you want to set the @deletion_flag for.
@deletion_flag: The new deletion_flag.
<!-- ##### FUNCTION gimp_unit_get_factor ##### -->
<para>
A #GimpUnit's @factor is defined to be:
</para>
<para>
distance_in_units == (@factor * distance_in_inches)
</para>
<para>
Returns 0 for @unit == GIMP_UNIT_PIXEL.
</para>
@unit: The unit you want to know the factor of.
@Returns: The unit's factor.
<!-- ##### FUNCTION gimp_unit_get_digits ##### -->
<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 @unit == GIMP_UNIT_PIXEL.
</para>
@unit: The unit you want to know the digits of.
@Returns: The suggested number of digits.
<!-- ##### FUNCTION gimp_unit_get_identifier ##### -->
<para>
This is an unstranslated string.
</para>
<para>
NOTE: This string has to be g_free()'d by plugins but is a pointer to a
constant string when this function is used from inside the GIMP.
</para>
@unit: The unit you want to know the identifier of.
@Returns: The unit's identifier.
<!-- ##### FUNCTION gimp_unit_get_symbol ##### -->
<para>
This is e.g. "''" for UNIT_INCH.
</para>
<para>
NOTE: This string has to be g_free()'d by plugins but is a pointer to a
constant string when this function is used from inside the GIMP.
</para>
@unit: The unit you want to know the symbol of.
@Returns: The unit's symbol.
<!-- ##### FUNCTION gimp_unit_get_abbreviation ##### -->
<para>
For built-in units, this function returns the translated abbreviation
of the unit.
</para>
<para>
NOTE: This string has to be g_free()'d by plugins but is a pointer to a
constant string when this function is used from inside the GIMP.
</para>
@unit: The unit you want to know the abbreviation of.
@Returns: The unit's abbreviation.
<!-- ##### FUNCTION gimp_unit_get_singular ##### -->
<para>
For built-in units, this function returns the translated singular form
of the unit's name.
</para>
<para>
NOTE: This string has to be g_free()'d by plugins but is a pointer to a
constant string when this function is used from inside the GIMP.
</para>
@unit: The unit you want to know the singular form of.
@Returns: The unit's singular form.
<!-- ##### FUNCTION gimp_unit_get_plural ##### -->
<para>
For built-in units, this function returns the translated plural form
of the unit's name.
</para>
<para>
NOTE: This string has to be g_free()'d by plugins but is a pointer to a
constant string when this function is used from inside the GIMP.
</para>
@unit: The unit you want to know the plural form of.
@Returns: The unit's plural form.

37
devel-docs/libgimpbase/tmpl/gimputils.sgml Normal file
View File

@ -0,0 +1,37 @@
<!-- ##### SECTION Title ##### -->
gimputils
<!-- ##### SECTION Short_Description ##### -->
Simple utility functions that don't have their own category.
<!-- ##### SECTION Long_Description ##### -->
<para>
Right now all you find here is a function taken from glib-1.3 that
we need in several places. Since Gimp doesn't rely on glib-1.3, we
provide it here.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
g_strescape()
</para>
<!-- ##### FUNCTION gimp_strescape ##### -->
<para>
</para>
@source:
@exceptions:
@Returns:
<!-- ##### FUNCTION gimp_strcompress ##### -->
<para>
</para>
@source:
@Returns:

57
devel-docs/libgimpbase/tmpl/gimpversion.sgml Normal file
View File

@ -0,0 +1,57 @@
<!-- ##### 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_CHECK_VERSION ##### -->
<para>
</para>
@major:
@minor:
@micro:

292
devel-docs/libgimpbase/tmpl/gimpwire.sgml Normal file
View File

@ -0,0 +1,292 @@
<!-- ##### 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_FUNCTION WireWriteFunc ##### -->
<para>
</para>
@channel:
@msg:
<!-- ##### USER_FUNCTION WireDestroyFunc ##### -->
<para>
</para>
@msg:
<!-- ##### USER_FUNCTION WireIOFunc ##### -->
<para>
</para>
@channel:
@buf:
@count:
@Returns:
<!-- ##### USER_FUNCTION WireFlushFunc ##### -->
<para>
</para>
@channel:
@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:
@Returns:
<!-- ##### FUNCTION wire_write ##### -->
<para>
</para>
@channel:
@buf:
@count:
@Returns:
<!-- ##### FUNCTION wire_flush ##### -->
<para>
</para>
@channel:
@Returns:
<!-- ##### FUNCTION wire_error ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION wire_clear_error ##### -->
<para>
</para>
<!-- ##### FUNCTION wire_read_msg ##### -->
<para>
</para>
@channel:
@msg:
@Returns:
<!-- ##### FUNCTION wire_write_msg ##### -->
<para>
</para>
@channel:
@msg:
@Returns:
<!-- ##### FUNCTION wire_destroy ##### -->
<para>
</para>
@msg:
<!-- ##### FUNCTION wire_read_int32 ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns:
<!-- ##### FUNCTION wire_read_int16 ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns:
<!-- ##### FUNCTION wire_read_int8 ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns:
<!-- ##### FUNCTION wire_read_double ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns:
<!-- ##### FUNCTION wire_read_string ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns:
<!-- ##### FUNCTION wire_write_int32 ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns:
<!-- ##### FUNCTION wire_write_int16 ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns:
<!-- ##### FUNCTION wire_write_int8 ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns:
<!-- ##### FUNCTION wire_write_double ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns:
<!-- ##### FUNCTION wire_write_string ##### -->
<para>
</para>
@channel:
@data:
@count:
@Returns: