Commit d7e22851 authored by Nate Summers's avatar Nate Summers
Browse files

libgimp/gimpbrushmenu.c libgimp/gimpgradientmenu.c documented all

        * libgimp/gimpbrushmenu.c
        * libgimp/gimpgradientmenu.c
        * libgimp/gimppatternmenu.c: documented all publically visible
        functions

        * libgimp/gimpmenu.h: fixed a typo

        * devel-docs/libgimp/libgimp-sections.txt: did some rearranging,
        added all unused functions (except for temporary ones)

        * idevel-docs/libgimp/tmpl/gimp.sgml
        * devel-docs/libgimp/tmpl/gimpmenu.sgml
        * devel-docs/libgimp/tmpl/gimpmisc.sgml: regenerated
parent f62a30ec
2002-12-17 Nathan Summers <rock@gimp.org>
* libgimp/gimpbrushmenu.c
* libgimp/gimpgradientmenu.c
* libgimp/gimppatternmenu.c: documented all publically visible
functions
* libgimp/gimpmenu.h: fixed a typo
* devel-docs/libgimp/libgimp-sections.txt: did some rearranging,
added all unused functions (except for temporary ones)
* idevel-docs/libgimp/tmpl/gimp.sgml
* devel-docs/libgimp/tmpl/gimpmenu.sgml
* devel-docs/libgimp/tmpl/gimpmisc.sgml: regenerated
2002-12-17 Nathan Summers <rock@gimp.org>
 
* libgimp/gimp.[ch]
......
......@@ -399,6 +399,18 @@ gimp_message_set_handler
<SECTION>
<FILE>gimpmisc</FILE>
gimp_version
<SUBSECTION>
gimp_pixel_fetcher_new
gimp_pixel_fetcher_destroy
gimp_pixel_fetcher_get_pixel
gimp_pixel_fetcher_get_pixel2
gimp_pixel_fetcher_set_bg_color
GimpRgnFunc1
GimpRgnFunc2
gimp_rgn_iterate1
gimp_rgn_iterate2
<SUBSECTION>
gimp_get_bg_guchar
</SECTION>
<SECTION>
......@@ -577,23 +589,29 @@ gimp_undo_push_group_end
<FILE>gimpmenu</FILE>
GimpConstraintFunc
GimpMenuCallback
GimpRunBrushCallback
GimpRunPatternCallback
GimpRunGradientCallback
gimp_image_menu_new
gimp_layer_menu_new
gimp_channel_menu_new
gimp_drawable_menu_new
gimp_interactive_selection_brush
<SUBSECTION>
gimp_brush_select_widget
GimpRunBrushCallback
gimp_brush_select_widget_set_popup
gimp_brush_select_widget_close_popup
<SUBSECTION>
gimp_interactive_selection_pattern
<SUBSECTION>
gimp_pattern_select_widget
GimpRunPatternCallback
gimp_pattern_select_widget_close_popup
gimp_pattern_select_widget_set_popup
<SUBSECTION>
gimp_interactive_selection_gradient
<SUBSECTION>
gimp_gradient_select_widget
GimpRunGradientCallback
gimp_gradient_select_widget_close_popup
gimp_gradient_select_widget_set_popup
</SECTION>
......@@ -157,7 +157,7 @@ all other GIMP Library headers.
<!-- ##### MACRO MAIN ##### -->
<para>
</para>
......
......@@ -36,48 +36,6 @@ Widgets and functions for selecting images, layers, brushes, patterns etc.
@id:
<!-- ##### USER_FUNCTION GimpRunBrushCallback ##### -->
<para>
</para>
@name:
@opacity:
@spacing:
@paint_mode:
@width:
@height:
@mask_data:
@dialog_closing:
@user_data:
<!-- ##### USER_FUNCTION GimpRunPatternCallback ##### -->
<para>
</para>
@name:
@width:
@height:
@bpp:
@mask_data:
@dialog_closing:
@user_data:
<!-- ##### USER_FUNCTION GimpRunGradientCallback ##### -->
<para>
</para>
@name:
@width:
@grad_data:
@dialog_closing:
@user_data:
<!-- ##### FUNCTION gimp_image_menu_new ##### -->
<para>
......@@ -160,17 +118,34 @@ Widgets and functions for selecting images, layers, brushes, patterns etc.
@Param7:
<!-- ##### USER_FUNCTION GimpRunBrushCallback ##### -->
<para>
</para>
@name:
@opacity:
@spacing:
@paint_mode:
@width:
@height:
@mask_data:
@dialog_closing:
@user_data:
<!-- ##### FUNCTION gimp_brush_select_widget_set_popup ##### -->
<para>
</para>
@widget:
@pname:
@bname:
@opacity:
@spacing:
@paint_mode:
<!-- # Unused Parameters # -->
@pname:
@Returns:
@w:
......@@ -214,6 +189,20 @@ Widgets and functions for selecting images, layers, brushes, patterns etc.
@Param4:
<!-- ##### USER_FUNCTION GimpRunPatternCallback ##### -->
<para>
</para>
@name:
@width:
@height:
@bpp:
@mask_data:
@dialog_closing:
@user_data:
<!-- ##### FUNCTION gimp_pattern_select_widget_close_popup ##### -->
<para>
......@@ -266,6 +255,18 @@ Widgets and functions for selecting images, layers, brushes, patterns etc.
@Param4:
<!-- ##### USER_FUNCTION GimpRunGradientCallback ##### -->
<para>
</para>
@name:
@width:
@grad_data:
@dialog_closing:
@user_data:
<!-- ##### FUNCTION gimp_gradient_select_widget_close_popup ##### -->
<para>
......
......@@ -23,3 +23,104 @@ Miscellaneous functions: gimp_version.
@Returns:
<!-- ##### FUNCTION gimp_pixel_fetcher_new ##### -->
<para>
</para>
@drawable:
@Returns:
<!-- ##### FUNCTION gimp_pixel_fetcher_destroy ##### -->
<para>
</para>
@pf:
<!-- ##### FUNCTION gimp_pixel_fetcher_get_pixel ##### -->
<para>
</para>
@pf:
@x:
@y:
@pixel:
<!-- ##### FUNCTION gimp_pixel_fetcher_get_pixel2 ##### -->
<para>
</para>
@pf:
@x:
@y:
@wrapmode:
@pixel:
<!-- ##### FUNCTION gimp_pixel_fetcher_set_bg_color ##### -->
<para>
</para>
@pf:
<!-- ##### USER_FUNCTION GimpRgnFunc1 ##### -->
<para>
</para>
@src:
@bpp:
@Param3:
<!-- ##### USER_FUNCTION GimpRgnFunc2 ##### -->
<para>
</para>
@src:
@dest:
@bpp:
@Param4:
<!-- ##### FUNCTION gimp_rgn_iterate1 ##### -->
<para>
</para>
@drawable:
@run_mode:
@func:
@data:
<!-- ##### FUNCTION gimp_rgn_iterate2 ##### -->
<para>
</para>
@drawable:
@run_mode:
@func:
@data:
<!-- ##### FUNCTION gimp_get_bg_guchar ##### -->
<para>
</para>
@drawable:
@transparent:
@bg:
......@@ -315,6 +315,22 @@ brush_select_callback (GtkWidget *widget,
bsel);
}
/**
* gimp_brush_select_widget:
* @dname: Title of the dialog to use. NULL means to use the default title.
* @ibrush: Initial brush name. NULL means to use current selection.
* @opacity: Initial opacity. -1 means to use current opacity.
* @spacing: Initial spacing. -1 means to use current spacing.
* @paint_mode: Initial paint mode. -1 means to use current paint mode.
* @cback: a function to call when the selected brush changes.
* @data: a pointer to arbitary data to be used in the call to @cback.
*
* Creates a new #GtkWidget that completely controls the selection of a
* #GimpBrush. This widget is suitable for placement in a table in a
* plug-in dialog.
*
* Returns:A #GtkWidget that you can use in your UI.
*/
GtkWidget *
gimp_brush_select_widget (gchar *dname,
gchar *ibrush,
......@@ -338,6 +354,7 @@ gimp_brush_select_widget (gchar *dname,
gchar *brush_name;
BSelect *bsel;
bsel = g_new (BSelect, 1);
hbox = gtk_hbox_new (FALSE, 3);
......@@ -414,6 +431,12 @@ gimp_brush_select_widget (gchar *dname,
}
/**
* gimp_brush_select_widget_close_popup:
* @widget: A brush select widget.
*
* Closes the popup window associated with @widget.
*/
void
gimp_brush_select_widget_close_popup (GtkWidget *widget)
{
......@@ -428,6 +451,18 @@ gimp_brush_select_widget_close_popup (GtkWidget *widget)
}
}
/**
* gimp_brush_select_widget_set_popup:
* @widget: A brush select widget.
* @bname: Brush name to set. NULL means no change.
* @opacity: Opacity to set. -1 means no change.
* @spacing: Spacing to set. -1 means no change.
* @paint_mode: Paint mode to set. -1 means no change.
*
* Sets the current brush and other values for the brush
* select widget. Calls the callback function if one was
* supplied in the call to gimp_brush_select_widget().
*/
void
gimp_brush_select_widget_set_popup (GtkWidget *widget,
gchar *bname,
......
......@@ -182,6 +182,19 @@ gradient_preview_callback (GtkWidget *widget,
gsel);
}
/**
* gimp_gradient_select_widget:
* @dname: Title of the dialog to use. NULL means to use the default title.
* @igradient: Initial gradient name. NULL means to use current selection.
* @cback: a function to call when the selected gradient changes.
* @data: a pointer to arbitary data to be used in the call to @cback.
*
* Creates a new #GtkWidget that completely controls the selection of a
* gradient. This widget is suitable for placement in a table in a
* plug-in dialog.
*
* Returns:A #GtkWidget that you can use in your UI.
*/
GtkWidget *
gimp_gradient_select_widget (gchar *dname,
gchar *igradient,
......@@ -250,6 +263,12 @@ gimp_gradient_select_widget (gchar *dname,
}
/**
* gimp_gradient_select_widget_close_popup:
* @widget: A gradient select widget.
*
* Closes the popup window associated with @widget.
*/
void
gimp_gradient_select_widget_close_popup (GtkWidget *widget)
{
......@@ -264,6 +283,15 @@ gimp_gradient_select_widget_close_popup (GtkWidget *widget)
}
}
/**
* gimp_gradient_select_widget_set_popup:
* @widget: A gradient select widget.
* @gname: gradient name to set.
*
* Sets the current gradient for the gradient
* select widget. Calls the callback function if one was
* supplied in the call to gimp_gradient_select_widget().
*/
void
gimp_gradient_select_widget_set_popup (GtkWidget *widget,
gchar *gname)
......
......@@ -95,7 +95,7 @@ GtkWidget * gimp_brush_select_widget (gchar *dname,
gpointer data);
void gimp_brush_select_widget_set_popup (GtkWidget *widget,
gchar *pname,
gchar *bname,
gdouble opacity,
gint spacing,
gint paint_mode);
......
......@@ -288,6 +288,19 @@ patterns_select_callback (GtkWidget *widget,
pattern_select_invoker,psel);
}
/**
* gimp_pattern_select_widget:
* @dname: Title of the dialog to use. NULL means to use the default title.
* @ipattern: Initial pattern name. NULL means to use current selection.
* @cback: a function to call when the selected pattern changes.
* @data: a pointer to arbitary data to be used in the call to @cback.
*
* Creates a new #GtkWidget that completely controls the selection of a
* pattern. This widget is suitable for placement in a table in a
* plug-in dialog.
*
* Returns:A #GtkWidget that you can use in your UI.
*/
GtkWidget *
gimp_pattern_select_widget (gchar *dname,
gchar *ipattern,
......@@ -371,6 +384,12 @@ gimp_pattern_select_widget (gchar *dname,
return hbox;
}
/**
* gimp_pattern_select_widget_close_popup:
* @widget: A pattern select widget.
*
* Closes the popup window associated with @widget.
*/
void
gimp_pattern_select_widget_close_popup (GtkWidget *widget)
{
......@@ -385,6 +404,15 @@ gimp_pattern_select_widget_close_popup (GtkWidget *widget)
}
}
/**
* gimp_pattern_select_widget_set_popup:
* @widget: A pattern select widget.
* @pname: Pattern name to set. NULL means no change.
*
* Sets the current pattern for the pattern
* select widget. Calls the callback function if one was
* supplied in the call to gimp_pattern_select_widget().
*/
void
gimp_pattern_select_widget_set_popup (GtkWidget *widget,
gchar *pname)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment