Commit 2b775b6b authored by Michael Natterer's avatar Michael Natterer 😴 Committed by Michael Natterer

libgimp/gimp.h libgimp/gimpcolordisplay.h libgimp/gimpcolorselector.h

2000-05-28  Michael Natterer  <mitch@gimp.org>

	* libgimp/gimp.h
	* libgimp/gimpcolordisplay.h
	* libgimp/gimpcolorselector.h
	* libgimp/gimpmatrix.h
	* libgimp/gimpmodule.h
	* libgimp/gimpunit_pdb.c: purely cosmetic stuff and added some
	typedefs to make the html documentation nicer. Moved the module
	documentation from the headers to the sgml files.

	* app/module_db.[ch]: The type of the "init" and "unload" functions
	has changed. Code cleanup.

2000-05-28  Michael Natterer  <mitch@gimp.org>

	* libgimp/libgimp-decl.txt
	* libgimp/libgimp-docs.sgml
	* libgimp/libgimp-sections.txt
	* libgimp/tmpl/gimp.sgml
	* libgimp/tmpl/gimpcolorbutton.sgml
	* libgimp/tmpl/gimpcolordisplay.sgml
	* libgimp/tmpl/gimpcolorselector.sgml
	* libgimp/tmpl/gimpcolorspace.sgml
	* libgimp/tmpl/gimpcompat.sgml
	* libgimp/tmpl/gimpenums.sgml
	* libgimp/tmpl/gimpfeatures.sgml
	* libgimp/tmpl/gimplimits.sgml
	* libgimp/tmpl/gimpmath.sgml
	* libgimp/tmpl/gimpmodule.sgml
	* libgimp/tmpl/gimpparasite.sgml
	* libgimp/tmpl/gimpparasiteio.sgml
	* libgimp/tmpl/gimppixmap.sgml
	* libgimp/tmpl/gimpprotocol.sgml
	* libgimp/tmpl/gimpsignal.sgml
	* libgimp/tmpl/gimpui.sgml
	* libgimp/tmpl/gimpunit.sgml
	* libgimp/tmpl/gimputils.sgml
	* libgimp/tmpl/gimpvector.sgml
	* libgimp/tmpl/gimpwire.sgml
	* libgimp/tmpl/libgimp-unused.sgml: Moved the module documentation
	from the libgimp headers here, updates, cleanups.
parent f2e4a9a4
2000-05-28 Michael Natterer <mitch@gimp.org>
* libgimp/gimp.h
* libgimp/gimpcolordisplay.h
* libgimp/gimpcolorselector.h
* libgimp/gimpmatrix.h
* libgimp/gimpmodule.h
* libgimp/gimpunit_pdb.c: purely cosmetic stuff and added some
typedefs to make the html documentation nicer. Moved the module
documentation from the headers to the sgml files.
* app/module_db.[ch]: The type of the "init" and "unload" functions
has changed. Code cleanup.
2000-05-27 Sven Neumann <sven@gimp.org>
* app/color_select.c: use spinbuttons in the GIMP
......
This diff is collapsed.
......@@ -17,14 +17,14 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef __MODULE_DB_H__
/* Load any modules we find on the module-path set in the gimprc */
void module_db_init (void);
void module_db_init (void);
/* Unload all modules, in case a module needs some cleanups */
void module_db_free (void);
void module_db_free (void);
GtkWidget *module_db_browser_new (void);
......
This diff is collapsed.
......@@ -17,14 +17,14 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef __MODULE_DB_H__
/* Load any modules we find on the module-path set in the gimprc */
void module_db_init (void);
void module_db_init (void);
/* Unload all modules, in case a module needs some cleanups */
void module_db_free (void);
void module_db_free (void);
GtkWidget *module_db_browser_new (void);
......
This diff is collapsed.
......@@ -17,14 +17,14 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef __MODULE_DB_H__
/* Load any modules we find on the module-path set in the gimprc */
void module_db_init (void);
void module_db_init (void);
/* Unload all modules, in case a module needs some cleanups */
void module_db_free (void);
void module_db_free (void);
GtkWidget *module_db_browser_new (void);
......
2000-05-28 Michael Natterer <mitch@gimp.org>
* libgimp/libgimp-decl.txt
* libgimp/libgimp-docs.sgml
* libgimp/libgimp-sections.txt
* libgimp/tmpl/gimp.sgml
* libgimp/tmpl/gimpcolorbutton.sgml
* libgimp/tmpl/gimpcolordisplay.sgml
* libgimp/tmpl/gimpcolorselector.sgml
* libgimp/tmpl/gimpcolorspace.sgml
* libgimp/tmpl/gimpcompat.sgml
* libgimp/tmpl/gimpenums.sgml
* libgimp/tmpl/gimpfeatures.sgml
* libgimp/tmpl/gimplimits.sgml
* libgimp/tmpl/gimpmath.sgml
* libgimp/tmpl/gimpmodule.sgml
* libgimp/tmpl/gimpparasite.sgml
* libgimp/tmpl/gimpparasiteio.sgml
* libgimp/tmpl/gimppixmap.sgml
* libgimp/tmpl/gimpprotocol.sgml
* libgimp/tmpl/gimpsignal.sgml
* libgimp/tmpl/gimpui.sgml
* libgimp/tmpl/gimpunit.sgml
* libgimp/tmpl/gimputils.sgml
* libgimp/tmpl/gimpvector.sgml
* libgimp/tmpl/gimpwire.sgml
* libgimp/tmpl/libgimp-unused.sgml: Moved the module documentation
from the libgimp headers here, updates, cleanups.
2000-05-27 Michael Natterer <mitch@gimp.org>
* libgimp/*: lotsa files removed/added/changed to reflect the
......
This diff is collapsed.
......@@ -66,6 +66,7 @@
<chapter id="libgimpui">
<title>GIMP User Interface Library</title>
&libgimp-gimpui;
&GimpChainButton;
&GimpColorButton;
&GimpFileSelection;
......@@ -78,7 +79,6 @@
&libgimp-gimphelpui;
&libgimp-gimpmenu;
&libgimp-gimpquerybox;
&libgimp-gimpui;
&libgimp-gimpwidgets;
</chapter>
......
......@@ -227,7 +227,6 @@ gimp_parasite_find
gimp_parasite_attach
gimp_attach_new_parasite
gimp_parasite_detach
gimp_plugin_help_func
gimp_help
gimp_plugin_help_register
gimp_plugin_domain_add_with_path
......@@ -528,6 +527,7 @@ GimpColorSelector_SetColorFunc
GimpColorSelectorMethods
GimpColorSelectorID
gimp_color_selector_register
GimpColorSelectorFinishedCB
gimp_color_selector_unregister
</SECTION>
......@@ -535,6 +535,9 @@ gimp_color_selector_unregister
<FILE>gimpmodule</FILE>
GimpModuleStatus
GimpModuleInfo
GimpModuleInitFunc
GimpModuleCompletedCB
GimpModuleUnloadFunc
</SECTION>
<SECTION>
......@@ -631,6 +634,7 @@ gimp_image_disable_undo
gimp_image_enable_undo
gimp_image_freeze_undo
gimp_image_thaw_undo
gimp_plugin_help_func
Parasite
PARASITE_PERSISTENT
PARASITE_UNDOABLE
......
......@@ -2,10 +2,13 @@
gimp
<!-- ##### SECTION Short_Description ##### -->
Main functions needed for building a GIMP plug-in. This header includes
all other GIMP Library headers.
<!-- ##### SECTION Long_Description ##### -->
<para>
Main functions needed for building a GIMP plug-in. This header includes
all other GIMP Library headers.
</para>
......@@ -2177,15 +2180,6 @@ gimp
@name:
<!-- ##### MACRO gimp_plugin_help_func ##### -->
<para>
</para>
<!-- # Unused Parameters # -->
@help_data:
<!-- ##### FUNCTION gimp_help ##### -->
<para>
......
......@@ -21,7 +21,7 @@ Note that the color is changed in place.
<!-- ##### SECTION See_Also ##### -->
<para>
#libgimp-gimpcolorspace
</para>
<!-- ##### STRUCT GimpColorButton ##### -->
......
......@@ -2,16 +2,22 @@
gimpcolordisplay
<!-- ##### SECTION Short_Description ##### -->
Functions and definitiions for creating a pluggable GIMP
display color correction module.
<!-- ##### SECTION Long_Description ##### -->
<para>
Functions and definitiions for creating a pluggable GIMP
display color correction module.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GModule
</para>
<para>
#libgimp-gimpmodule
</para>
<!-- ##### USER_FUNCTION GimpColorDisplayInit ##### -->
......
......@@ -2,61 +2,91 @@
gimpcolorselector
<!-- ##### SECTION Short_Description ##### -->
Functions and definitiions for creating a pluggable GIMP
color selector module.
<!-- ##### SECTION Long_Description ##### -->
<para>
Functions and definitiions for creating a pluggable GIMP
color selector module.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GModule
</para>
<para>
#libgimp-gimpmodule
</para>
<!-- ##### USER_FUNCTION GimpColorSelector_Callback ##### -->
<para>
A function of this type should be called by the color selector each
time the user modifies the selected color.
</para>
@data:
@r:
@g:
@b:
@data: The @data passed to the #GimpColorSelector_NewFunc function.
@r: The new color's red component.
@g: The new color's green component.
@b: The new color's blue component.
<!-- ##### USER_FUNCTION GimpColorSelector_NewFunc ##### -->
<para>
A function of this type is called to create a new instance of the
color selector. The new selector should set its current color to
the RGB triple given (each component is in the range 0 - 255
inclusive, with white at 255,255,255 and black at 0,0,0).
</para>
<para>
The selector should call @cb with argument @data each time the
user modifies the selected color.
</para>
<para>
The selector must return a #GtkWidget which implements the color
selection UI. The selector can optionally return @selector_data,
an opaque pointer which will be passed in to subsequent invokations
on the selector.
</para>
@r:
@g:
@b:
@cb:
@data:
@selector_data:
@Returns:
@r: The red component of intitial color.
@g: The green component of intitial color.
@b: The blue component of intitial color.
@cb: The function to call each time the user modifies the selected color.
@data: The @data to pass to @cb.
@selector_data: An optional data pointer which will be passed in to subsequent invokations on the selector.
@Returns: A #GtkWidget which implements the color selection UI.
<!-- ##### USER_FUNCTION GimpColorSelector_FreeFunc ##### -->
<para>
A function of this type is called when the color selector is no
longer required. This function should *not* free widgets that are
containted within the UI widget returned by new(), since they are
destroyed on behalf of the selector by the caller of this
function.
</para>
@selector_data:
@selector_data: The @selector_data pointer returned by the #GimpColorSelector_NewFunc function.
<!-- ##### USER_FUNCTION GimpColorSelector_SetColorFunc ##### -->
<para>
A function of this type is called to change the selector's current
color. The required color is specified as in the new() function.
If the @set_current parameter is #FALSE, then only the old color
should be set - if @set_current is #TRUE, both the old color and
the current color should be set to the RGB triple given. This
function merely gives a hint to the color selector; the selector
can choose to ignore this information.
</para>
@selector_data:
@r:
@g:
@b:
@set_current:
@selector_data: The @selector_data pointer returned by the #GimpColorSelector_NewFunc function.
@r: The new color's red component.
@g: The new color's green component.
@b: The new color's blue component.
@set_current: Set the current color.
<!-- ##### STRUCT GimpColorSelectorMethods ##### -->
......@@ -73,23 +103,40 @@ gimpcolorselector
<!-- ##### FUNCTION gimp_color_selector_register ##### -->
<para>
Register a color selector. Returns an identifier for the color
selector on success, or #NULL if the name is already in use. Both
the @name and @methods table are internalised, so may be g_free()'d after
this call.
</para>
@name: The color selector's name.
@help_page: The help page.
@methods: The color selector's methods.
@Returns: The #GimpColorSelectorID of the new color selector.
<!-- ##### USER_FUNCTION GimpColorSelectorFinishedCB ##### -->
<para>
A function of this type will be called once all instances of a color
selector have finished after the selector module called
gimp_color_selector_unregister().
</para>
@name:
@help_page:
@methods:
@Returns:
@finished_data: The @finished_data as specified in gimp_color_selector_register().
<!-- ##### FUNCTION gimp_color_selector_unregister ##### -->
<para>
Remove the selector @id from active service. New instances of the
selector will not be created, but existing ones are allowed to
continue. If @finished_cb is non-#NULL, it will be called once all
instances have finished. The callback could be used to unload
dynamiclly loaded code, for example.
</para>
@id:
@callback:
@data:
@Returns:
@id: The @id as returned by gimp_color_selector_register().
@finished_cb: Optional callback which will be called once all instances have finished.
@finished_data: The @finished_data which will be passed to @finished_cb.
@Returns: #TRUE on success, #FALSE if @id was not found.
......@@ -2,10 +2,14 @@
gimpcolorspace
<!-- ##### SECTION Short_Description ##### -->
Utility functions which convert colors between different color models.
<!-- ##### SECTION Long_Description ##### -->
<para>
When programming pixel data manipulation functions you will often use
algorithms operating on a color model different from the one GIMP
uses. This file provides utility functions to concert colors between
different color spaces.
</para>
......
......@@ -6,6 +6,7 @@ Compatibility definitions for older plug-ins.
<!-- ##### SECTION Long_Description ##### -->
<para>
Compatibility definitions for older plug-ins.
</para>
......@@ -147,6 +148,15 @@ Compatibility definitions for older plug-ins.
<!-- ##### MACRO gimp_plugin_help_func ##### -->
<para>
</para>
<!-- # Unused Parameters # -->
@help_data:
<!-- ##### MACRO Parasite ##### -->
<para>
......
......@@ -2,10 +2,11 @@
gimpenums
<!-- ##### SECTION Short_Description ##### -->
Enums and definitions.
<!-- ##### SECTION Long_Description ##### -->
<para>
Enums and definitions.
</para>
......
......@@ -2,10 +2,13 @@
gimpfeatures
<!-- ##### 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>
......
......@@ -2,10 +2,11 @@
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>
......
......@@ -6,6 +6,7 @@ Mathematical definitions and macros.
<!-- ##### SECTION Long_Description ##### -->
<para>
Mathematical definitions and macros.
</para>
......
......@@ -2,16 +2,17 @@
gimpmodule
<!-- ##### SECTION Short_Description ##### -->
Common definitions for creating a pluggable GIMP module.
<!-- ##### SECTION Long_Description ##### -->
<para>
Common definitions for creating a pluggable GIMP module.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GModule
</para>
<!-- ##### ENUM GimpModuleStatus ##### -->
......@@ -26,3 +27,59 @@ gimpmodule
</para>
<!-- ##### USER_FUNCTION GimpModuleInitFunc ##### -->
<para>
GIMP modules should #G_MODULE_EXPORT a function named "module_init"
of this type.
</para>
<para>
The "module_init" function is called by the GIMP at startup,
and should return either #GIMP_MODULE_OK if it sucessfully initialised or
#GIMP_MODULE_UNLOAD if the module failed to hook whatever functions
it wanted. #GIMP_MODULE_UNLOAD causes the module to be closed, so
the module must not have registered any internal functions or given
out pointers to its data to anyone.
</para>
<para>
If the module returns #GIMP_MODULE_OK, it should also return a
#GimpModuleInfo structure describing itself.
</para>
@module_info: Returns the #GimpModuleInfo desribing the module.
@Returns: A #GimpModuleStatus value indicating success.
<!-- ##### USER_FUNCTION GimpModuleCompletedCB ##### -->
<para>
The type of the @completed_cb passed to the "module_unload" function
(see below).
</para>
@completed_data: <para>
Must be the @completed_data pointer provided by the "module_unload"
function.
</para>
<!-- ##### USER_FUNCTION GimpModuleUnloadFunc ##### -->
<para>
If GIMP modules want to allow themselves to be unloaded, they
should #G_MODULE_EXPORT a function named "module_unload" of
this type.
</para>
<para>
GIMP calls the "module_unload" unload request function to ask
a module to prepare itself to be unloaded. It is called with the
value of @shutdown_data supplied in the #GimpModuleInfo struct.
The module should ensure that none of its code or data are being
used, and then call the supplied @completed_cb callback function with
the @completed_data provided. Typically the shutdown request function
will queue de-registration activities then return. Only when the
de-registration has finished should the @completed_cb be invoked.
</para>
@shutdown_data: The @shutdown_data supplied in the #GimpModuleInfo struct.
@completed_cb: The function to call after successful unload.
@completed_data: Has to be passed to the @completed_cb.
......@@ -2,16 +2,18 @@
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 ##### -->
......
......@@ -2,16 +2,17 @@
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 ##### -->
......
......@@ -6,13 +6,25 @@ Widget which creates a #GtkPixmap from XPM data.
<!-- ##### SECTION Long_Description ##### -->
<para>
Widget which creates a #GtkPixmap from XPM data.
</para>
<para>
Use this widget instead of #GtkPixmap if you don't want to worry about
the parent container's "realized" state.
</para>
<para>
Note that the drawback of the easy interface is that the actual #GdkPixmap
and it's mask have to be constructed every time you call gimp_pixmap_new()
and cannot be cached in memory without doing bad hacks.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
gimp_pixmap_button_new()
</para>
<para>
#GtkPixmap
</para>
<!-- ##### STRUCT GimpPixmap ##### -->
<para>
......
......@@ -2,16 +2,17 @@
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 ##### -->
......
......@@ -6,6 +6,7 @@ Portable signal handling.
<!-- ##### SECTION Long_Description ##### -->
<para>
Portable signal handling.
</para>
......
......@@ -2,10 +2,13 @@
gimpui
<!-- ##### SECTION Short_Description ##### -->
Common user interface functions.
Common user interface functions. This header includes all other GIMP User
Interface Library headers.
<!-- ##### SECTION Long_Description ##### -->
<para>
Common user interface functions. This header includes all other GIMP User
Interface Library headers.
</para>
......
......@@ -7,6 +7,8 @@ user-defined units.
<!-- ##### SECTION Long_Description ##### -->
<para>
Provides a collection of predefined units and functions for creating
user-defined units.
</para>
......
......@@ -13,7 +13,7 @@ provide it here.
<!-- ##### SECTION See_Also ##### -->
<para>
g_strescape()
</para>
<!-- ##### FUNCTION gimp_strescape ##### -->
......
......@@ -6,6 +6,7 @@ Utilities to set up and manipulate vectors.
<!-- ##### SECTION Long_Description ##### -->
<para>
Utilities to set up and manipulate vectors.
</para>
......
......@@ -2,16 +2,19 @@
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 ##### -->
......
......@@ -96,14 +96,14 @@ parasiteF
<!-- ##### SECTION ./tmpl/parasiteF.sgml:Long_Description ##### -->
<para>
<!-- ##### SECTION ./tmpl/color_selector.sgml:Short_Description ##### -->
</para>
<!-- ##### SECTION ./tmpl/color_selector.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/parasiteF.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/parasiteio.sgml:See_Also ##### -->
......
This diff is collapsed.
......@@ -62,14 +62,15 @@ struct _GimpColorDisplayMethods
GimpColorDisplayConfigureCancel cancel;
};