added GimpStock section, removed GimpWidgetTypes.

2002-05-13  Sven Neumann  <sven@gimp.org>

	* libgimpwidgets/libgimpwidgets-docs.sgml: added GimpStock section,
	removed GimpWidgetTypes.

	* libgimpwidgets/libgimpwidgets-sections.txt: updated.

	* libgimpwidgets/tmpl/gimpstock.sgml: added GimpStock templates.

	* libgimpwidgets/tmpl/gimpwidgetstypes.sgml: removed.

	* libgimpwidgets/tmpl/gimpbutton.sgml
	* libgimpwidgets/tmpl/gimpchainbutton.sgml
	* libgimpwidgets/tmpl/gimpcolorarea.sgml
	* libgimpwidgets/tmpl/gimpcolorbutton.sgml
	* libgimpwidgets/tmpl/gimpdialog.sgml
	* libgimpwidgets/tmpl/gimpfileselection.sgml
	* libgimpwidgets/tmpl/gimphelpui.sgml
	* libgimpwidgets/tmpl/gimpoffsetarea.sgml
	* libgimpwidgets/tmpl/gimppatheditor.sgml
	* libgimpwidgets/tmpl/gimppixmap.sgml
	* libgimpwidgets/tmpl/gimpquerybox.sgml
	* libgimpwidgets/tmpl/gimpsizeentry.sgml
	* libgimpwidgets/tmpl/gimpunitmenu.sgml
	* libgimpwidgets/tmpl/gimpwidgets.sgml: updated.
This commit is contained in:
Sven Neumann 2002-05-13 10:37:53 +00:00 committed by Sven Neumann
parent 2216807dca
commit 1be6408590
19 changed files with 892 additions and 164 deletions

View file

@ -14,6 +14,12 @@ GimpButton
</para>
<!-- ##### STRUCT GimpButton ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_button_new ##### -->
<para>
@ -22,3 +28,12 @@ GimpButton
@Returns:
<!-- ##### FUNCTION gimp_button_extended_clicked ##### -->
<para>
</para>
@button:
@state:

View file

@ -26,6 +26,12 @@ You may want to use the convenience function gimp_coordinates_new() to set
up two GimpSizeEntries (see #GimpSizeEntry) linked with a #GimpChainButton.
</para>
<!-- ##### STRUCT GimpChainButton ##### -->
<para>
</para>
<!-- ##### ENUM GimpChainPosition ##### -->
<para>

View file

@ -14,6 +14,13 @@ GimpColorArea
</para>
<!-- ##### STRUCT GimpColorArea ##### -->
<para>
</para>
@parent_instance:
<!-- ##### ENUM GimpColorAreaType ##### -->
<para>

View file

@ -21,6 +21,12 @@ color, the "color_changed" signal is emitted.
#libgimpcolor-gimpcolorspace
</para>
<!-- ##### STRUCT GimpColorButton ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_color_button_new ##### -->
<para>

View file

@ -15,6 +15,13 @@ dialog-related stuff.
</para>
<!-- ##### STRUCT GimpDialog ##### -->
<para>
</para>
@parent_instance:
<!-- ##### FUNCTION gimp_dialog_new ##### -->
<para>

View file

@ -31,6 +31,12 @@ will be emitted.
#GimpPathEditor
</para>
<!-- ##### STRUCT GimpFileSelection ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_file_selection_new ##### -->
<para>

View file

@ -15,6 +15,36 @@ system.
</para>
<!-- ##### USER_FUNCTION GimpHelpFunc ##### -->
<para>
This is the prototype for all functions you pass as @help_func to the
various GIMP dialog constructors like gimp_dialog_new(),
gimp_query_int_box() etc.
</para>
<para>
Note that all help paths are relative to the root of the help system
in the current language. So if your language is "C", a help path of
"filters/foo_bar.html" will expand to
"${gimp_data_dir}/help/C/filters/foo_bar.html".
</para>
<para>
All these functions finally call gimp_help_connect_help_accel() which
does the work of installing the "F1" accelerator.
</para>
<para>
In most cases it will be ok to use gimp_plugin_help_func() which does
nothing but passing the @help_data string to gimp_help(). If your
plug-in needs some more sophisticated help handling you can provide
your own @help_func which has to call gimp_help() to actually display
the help.
</para>
@help_data: A string containing the path to a HTML page.
<!-- ##### FUNCTION gimp_help_init ##### -->
<para>
@ -63,6 +93,16 @@ See #GimpHelpFunc for the naming conventions of HTML help files.
@help_data: A string containing the path to a HTML page.
<!-- ##### FUNCTION gimp_help_connect ##### -->
<para>
</para>
@widget:
@help_func:
@help_data:
<!-- ##### FUNCTION gimp_help_set_help_data ##### -->
<para>

View file

@ -14,6 +14,21 @@ GimpOffsetArea
</para>
<!-- ##### STRUCT GimpOffsetArea ##### -->
<para>
</para>
@parent_instance:
@orig_width:
@orig_height:
@width:
@height:
@offset_x:
@offset_y:
@display_ratio_x:
@display_ratio_y:
<!-- ##### FUNCTION gimp_offset_area_new ##### -->
<para>

View file

@ -30,6 +30,12 @@ the search path, the "path_changed" signal will be emitted.
#G_SEARCHPATH_SEPARATOR
</para>
<!-- ##### STRUCT GimpPathEditor ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_path_editor_new ##### -->
<para>

View file

@ -26,6 +26,12 @@ gimp_pixmap_button_new()
#GtkPixmap
</para>
<!-- ##### STRUCT GimpPixmap ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_pixmap_new ##### -->
<para>

View file

@ -179,3 +179,11 @@ Note that you have to g_free() the returned string.
@eek:
<!-- ##### MACRO GIMP_QUERY_BOX_VBOX ##### -->
<para>
</para>
@qbox:

View file

@ -42,12 +42,27 @@ real-world-unit.
gimp_coordinates_new()
</para>
<!-- ##### STRUCT GimpSizeEntry ##### -->
<para>
</para>
<!-- ##### STRUCT GimpSizeEntryField ##### -->
<para>
</para>
<!-- ##### ENUM GimpSizeEntryUpdatePolicy ##### -->
<para>
</para>
@GIMP_SIZE_ENTRY_UPDATE_NONE:
@GIMP_SIZE_ENTRY_UPDATE_SIZE:
@GIMP_SIZE_ENTRY_UPDATE_RESOLUTION:
<!-- ##### FUNCTION gimp_size_entry_new ##### -->
<para>

View file

@ -0,0 +1,548 @@
<!-- ##### SECTION Title ##### -->
gimpstock
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_stock_init ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_ANCHOR ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_DUPLICATE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_EDIT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_LINKED ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_PASTE_AS_NEW ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_PASTE_INTO ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_RESET ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_VISIBLE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_HCHAIN ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_HCHAIN_BROKEN ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_VCHAIN ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_VCHAIN_BROKEN ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_SELECTION_REPLACE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_SELECTION_ADD ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_SELECTION_SUBTRACT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_SELECTION_INTERSECT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_SELECTION_STROKE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_SELECTION_TO_PATH ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_PATH_STROKE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_CONVERT_RGB ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_CONVERT_GRAYSCALE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_CONVERT_INDEXED ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_MERGE_DOWN ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_RESHOW_FILTER ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_ROTATE_90 ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_ROTATE_180 ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_ROTATE_270 ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_RESIZE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_SCALE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_SELECTION_TO_CHANNEL ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_NAVIGATION ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_QMASK_OFF ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_QMASK_ON ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_INFO ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_WARNING ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_WILBER ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_AIRBRUSH ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_BEZIER_SELECT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_BLEND ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_BLUR ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_BRIGHTNESS_CONTRAST ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_BUCKET_FILL ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_BY_COLOR_SELECT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_CLONE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_COLOR_BALANCE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_COLOR_PICKER ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_CROP ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_CURVES ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_DODGE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_ELLIPSE_SELECT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_ERASER ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_FLIP ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_FREE_SELECT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_FUZZY_SELECT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_HISTOGRAM ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_HUE_SATURATION ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_INK ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_ISCISSORS ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_LEVELS ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_MEASURE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_MOVE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_PAINTBRUSH ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_PATH ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_PENCIL ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_PERSPECTIVE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_POSTERIZE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_RECT_SELECT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_ROTATE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_SCALE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_SHEAR ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_SMUDGE ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_TEXT ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_THRESHOLD ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_TOOL_ZOOM ##### -->
<para>
</para>
<!-- ##### MACRO GIMP_STOCK_WILBER_EEK ##### -->
<para>
</para>

View file

@ -33,6 +33,12 @@ Whenever the user selects a unit from the menu or the dialog, the
gimp_coordinates_new()
</para>
<!-- ##### STRUCT GimpUnitMenu ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_unit_menu_new ##### -->
<para>

View file

@ -15,6 +15,13 @@ helper functions.
</para>
<!-- ##### FUNCTION gimp_widgets_init ##### -->
<para>
</para>
<!-- ##### FUNCTION gimp_option_menu_new ##### -->
<para>
@ -115,6 +122,26 @@ gtk_object_set_user_data().</entry>
@user_data:
<!-- ##### FUNCTION gimp_option_menu_set_sensitive ##### -->
<para>
</para>
@option_menu:
@callback:
@callback_data:
<!-- ##### USER_FUNCTION GimpOptionMenuSensitivityCallback ##### -->
<para>
</para>
@item_data:
@callback_data:
@Returns:
<!-- ##### FUNCTION gimp_radio_group_new ##### -->
<para>
@ -206,6 +233,15 @@ gtk_object_set_user_data().</entry>
@data:
<!-- ##### FUNCTION gimp_radio_group_set_active ##### -->
<para>
</para>
@radio_button:
@item_data:
<!-- ##### FUNCTION gimp_spin_button_new ##### -->
<para>

View file

@ -1,125 +0,0 @@
<!-- ##### SECTION Title ##### -->
gimpwidgetstypes
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GimpSizeEntryUpdatePolicy ##### -->
<para>
</para>
@GIMP_SIZE_ENTRY_UPDATE_NONE:
@GIMP_SIZE_ENTRY_UPDATE_SIZE:
@GIMP_SIZE_ENTRY_UPDATE_RESOLUTION:
<!-- ##### STRUCT GimpButton ##### -->
<para>
</para>
<!-- ##### STRUCT GimpChainButton ##### -->
<para>
</para>
<!-- ##### STRUCT GimpColorArea ##### -->
<para>
</para>
@parent_instance:
<!-- ##### STRUCT GimpColorButton ##### -->
<para>
</para>
<!-- ##### STRUCT GimpFileSelection ##### -->
<para>
</para>
<!-- ##### STRUCT GimpOffsetArea ##### -->
<para>
</para>
@parent_instance:
@orig_width:
@orig_height:
@width:
@height:
@offset_x:
@offset_y:
@display_ratio_x:
@display_ratio_y:
<!-- ##### STRUCT GimpPathEditor ##### -->
<para>
</para>
<!-- ##### STRUCT GimpPixmap ##### -->
<para>
</para>
<!-- ##### STRUCT GimpSizeEntry ##### -->
<para>
</para>
<!-- ##### STRUCT GimpUnitMenu ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GimpHelpFunc ##### -->
<para>
This is the prototype for all functions you pass as @help_func to the
various GIMP dialog constructors like gimp_dialog_new(),
gimp_query_int_box() etc.
</para>
<para>
Note that all help paths are relative to the root of the help system
in the current language. So if your language is "C", a help path of
"filters/foo_bar.html" will expand to
"${gimp_data_dir}/help/C/filters/foo_bar.html".
</para>
<para>
All these functions finally call gimp_help_connect_help_accel() which
does the work of installing the "F1" accelerator.
</para>
<para>
In most cases it will be ok to use gimp_plugin_help_func() which does
nothing but passing the @help_data string to gimp_help(). If your
plug-in needs some more sophisticated help handling you can provide
your own @help_func which has to call gimp_help() to actually display
the help.
</para>
@help_data: A string containing the path to a HTML page.