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

libgimp/gimpui.c libgimp/gimpunit.c libgimpbase/gimpenv.c

Browse Source 
2003-02-06  Sven Neumann  <sven@gimp.org>

	* libgimp/gimpui.c
	* libgimp/gimpunit.c
	* libgimpbase/gimpenv.c
	* libgimpmodule/gimpmodule.c
	* libgimpmodule/gimpmoduledb.c
	* libgimpwidgets/gimpchainbutton.c
	* libgimpwidgets/gimpdialog.c
	* libgimpwidgets/gimpfileselection.c
	* libgimpwidgets/gimphelpui.c
	* libgimpwidgets/gimpquerybox.c
	* libgimpwidgets/gimpsizeentry.c
	* libgimpwidgets/gimpunitmenu.c
	* libgimpwidgets/gimpwidgets.c: documentation fixes / improvements.
This commit is contained in:
Sven Neumann
2003-02-06 21:17:12 +00:00
committed by Sven Neumann
parent 799c3849fc
commit d26c1ce51b
16 changed files with 105 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
libgimpwidgets/gimpwidgets.c
View File

@ -82,8 +82,8 @@ gimp_widgets_init (void)
/**
* gimp_option_menu_new:
* @menu_only: #TRUE if the function should return a #GtkMenu only.
* @...: A #NULL terminated @va_list describing the menu items.
* @menu_only: %TRUE if the function should return a #GtkMenu only.
* @...: A %NULL-terminated @va_list describing the menu items.
*
* Convenience function to create a #GtkOptionMenu or a #GtkMenu.
*
@ -191,13 +191,13 @@ gimp_option_menu_new (gboolean menu_only,
/**
* gimp_option_menu_new2:
* @menu_only: #TRUE if the function should return a #GtkMenu only.
* @menu_only: %TRUE if the function should return a #GtkMenu only.
* @menu_item_callback: The callback each menu item's "activate" signal will
* be connected with.
* @menu_item_callback_data:
* The data which will be passed to g_signal_connect().
* @initial: The @item_data of the initially selected menu item.
* @...: A #NULL terminated @va_list describing the menu items.
* @...: A %NULL-terminated @va_list describing the menu items.
*
* Convenience function to create a #GtkOptionMenu or a #GtkMenu.
*
@ -380,9 +380,9 @@ gimp_option_menu_set_sensitive (GtkOptionMenu *option_menu,
/**
* gimp_radio_group_new:
* @in_frame: #TRUE if you want a #GtkFrame around the radio button group.
* @frame_title: The title of the Frame or #NULL if you don't want a title.
* @...: A #NULL terminated @va_list describing the radio buttons.
* @in_frame: %TRUE if you want a #GtkFrame around the radio button group.
* @frame_title: The title of the Frame or %NULL if you don't want a title.
* @...: A %NULL-terminated @va_list describing the radio buttons.
*
* Convenience function to create a group of radio buttons embedded into
* a #GtkFrame or #GtkVbox.
@ -483,16 +483,16 @@ gimp_radio_group_new (gboolean in_frame,
/**
* gimp_radio_group_new2:
* @in_frame: #TRUE if you want a #GtkFrame around the
* @in_frame: %TRUE if you want a #GtkFrame around the
* radio button group.
* @frame_title: The title of the Frame or #NULL if you don't want
* @frame_title: The title of the Frame or %NULL if you don't want
* a title.
* @radio_button_callback: The callback each button's "toggled" signal will
* be connected with.
* @radio_button_callback_data:
* The data which will be passed to g_signal_connect().
* @initial: The @item_data of the initially pressed radio button.
* @...: A #NULL terminated @va_list describing
* @...: A %NULL-terminated @va_list describing
* the radio buttons.
*
* Convenience function to create a group of radio buttons embedded into
@ -811,12 +811,12 @@ gimp_scale_entry_new_internal (gboolean color_scale,
* @step_increment: The step increment.
* @page_increment: The page increment.
* @digits: The number of decimal digits.
* @constrain: #TRUE if the range of possible values of the
* @constrain: %TRUE if the range of possible values of the
* #GtkSpinButton should be the same as of the #GtkHScale.
* @unconstrained_lower: The spinbutton's lower boundary
* if @constrain == #FALSE.
* if @constrain == %FALSE.
* @unconstrained_upper: The spinbutton's upper boundary
* if @constrain == #FALSE.
* if @constrain == %FALSE.
* @tooltip: A tooltip message for the scale and the spinbutton.
* @help_data: The widgets' help_data (see gimp_help_set_help_data()).
*
@ -1078,19 +1078,19 @@ gimp_coordinates_callback (GtkWidget *widget,
/**
* gimp_coordinates_new:
* @unit: The initial unit of the #GimpUnitMenu.
* @unit_format: The unit format string as passed to
* gimp_size_entry_new().
* @menu_show_pixels: #TRUE if the #GimpUnitMenu should contain an item for
* GIMP_UNIT_PIXEL.
* @menu_show_percent: #TRUE if the #GimpUnitMenu should contain an item for
* GIMP_UNIT_PERCENT.
* @unit_format: A printf-like unit-format string as is used with
* gimp_unit_menu_new().
* @menu_show_pixels: %TRUE if the #GimpUnitMenu should contain an item
* for GIMP_UNIT_PIXEL.
* @menu_show_percent: %TRUE if the #GimpUnitMenu should contain an item
* for GIMP_UNIT_PERCENT.
* @spinbutton_width: The horizontal size of the #GimpSizeEntry's
* #GtkSpinButton's.
* @update_policy: The update policy for the #GimpSizeEntry.
* @chainbutton_active: #TRUE if the attached #GimpChainButton should be
* @chainbutton_active: %TRUE if the attached #GimpChainButton should be
* active.
* @chain_constrains_ratio: #TRUE if the chainbutton should constrain the
* fields' aspect ratio. If #FALSE, the values will
* @chain_constrains_ratio: %TRUE if the chainbutton should constrain the
* fields' aspect ratio. If %FALSE, the values will
* be constrained.
* @xlabel: The label for the X coordinate.
* @x: The initial value of the X coordinate.
@ -1228,8 +1228,8 @@ gimp_coordinates_new (GimpUnit unit,
* @xpm_data: The XPM data which will be passed to gimp_pixmap_new().
* @text: An optional text which will appear right of the pixmap.
*
* Convenience function that creates a #GtkButton with a #GimpPixmap and an
* optional #GtkLabel.
* Convenience function that creates a #GtkButton with a #GimpPixmap
* and an optional #GtkLabel.
*
* Returns: The new #GtkButton.
**/
@ -1351,7 +1351,7 @@ gimp_toggle_button_update (GtkWidget *widget,
* gimp_radio_button_update:
* @widget: A #GtkRadioButton.
* @data: A pointer to a #gint variable which will store the value of
* GPOINTER_TO_INT (g_object_get_user_data(@widget, "gimp-item-data")).
* GPOINTER_TO_INT (g_object_get_data (@widget, "gimp-item-data")).
*
* Note that this function calls gimp_toggle_button_sensitive_update().
**/
@ -1376,7 +1376,7 @@ gimp_radio_button_update (GtkWidget *widget,
* gimp_menu_item_update:
* @widget: A #GtkMenuItem.
* @data: A pointer to a #gint variable which will store the value of
* GPOINTER_TO_INT (g_object_get_data(@widget, "gimp-item-data")).
* GPOINTER_TO_INT (g_object_get_data (@widget, "gimp-item-data")).
**/
void
gimp_menu_item_update (GtkWidget *widget,
@ -1507,16 +1507,16 @@ gimp_unit_menu_update (GtkWidget *widget,
* @table: The #GtkTable the widgets will be attached to.
* @column: The column to start with.
* @row: The row to attach the widgets.
* @label_text: The text for the #GtkLabel which will be attached left of the
* widget.
* @label_text: The text for the #GtkLabel which will be attached left of
* the widget.
* @xalign: The horizontal alignment of the #GtkLabel.
* @yalign: The vertival alignment of the #GtkLabel.
* @widget: The #GtkWidget to attach right of the label.
* @colspan: The number of columns the widget will use.
* @left_align: #TRUE if the widget should be left-aligned.
* @left_align: %TRUE if the widget should be left-aligned.
*
* Note that the @label_text can be #NULL and that the widget will be attached
* starting at (@column + 1) in this case, too.
* Note that the @label_text can be %NULL and that the widget will be
* attached starting at (@column + 1) in this case, too.
*
* Returns: The created #GtkLabel.
**/