GIMP Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# gimpwidgets

## Name

gimpwidgets -- A collection of convenient widget constructors, standard callbacks and helper functions.

## Synopsis

    GtkWidget*  gimp_option_menu_new            (gboolean menu_only,
                                                 ...);
    GtkWidget*  gimp_option_menu_new2           (gboolean menu_only,
                                                 GtkSignalFunc menu_item_callback,
                                                 gpointer data,
                                                 gpointer initial,
                                                 ...);
    void        gimp_option_menu_set_history    (GtkOptionMenu *option_menu,
                                                 gpointer user_data);
    GtkWidget*  gimp_radio_group_new            (gboolean in_frame,
                                                 const gchar *frame_title,
                                                 ...);
    GtkWidget*  gimp_radio_group_new2           (gboolean in_frame,
                                                 const gchar *frame_title,
                                                 GtkSignalFunc radio_button_callback,
                                                 gpointer data,
                                                 gpointer initial,
                                                 ...);
    GtkWidget*  gimp_spin_button_new            (GtkObject **adjustment,
                                                 gfloat value,
                                                 gfloat lower,
                                                 gfloat upper,
                                                 gfloat step_increment,
                                                 gfloat page_increment,
                                                 gfloat page_size,
                                                 gfloat climb_rate,
                                                 guint digits);
    GtkObject*  gimp_scale_entry_new            (GtkTable *table,
                                                 gint column,
                                                 gint row,
                                                 const gchar *text,
                                                 gint scale_usize,
                                                 gint spinbutton_usize,
                                                 gfloat value,
                                                 gfloat lower,
                                                 gfloat upper,
                                                 gfloat step_increment,
                                                 gfloat page_increment,
                                                 guint digits,
                                                 gboolean constrain,
                                                 gfloat unconstrained_lower,
                                                 gfloat unconstrained_upper,
                                                 const gchar *tooltip,
                                                 const gchar *help_data);
    #define     GIMP_SCALE_ENTRY_LABEL          (adj)
    #define     GIMP_SCALE_ENTRY_SCALE          (adj)
    #define     GIMP_SCALE_ENTRY_SCALE_ADJ      (adj)
    #define     GIMP_SCALE_ENTRY_SPINBUTTON     (adj)
    #define     GIMP_SCALE_ENTRY_SPINBUTTON_ADJ (adj)
    GtkWidget*  gimp_random_seed_new            (gint *seed,
                                                 gint *use_time,
                                                 gint time_true,
                                                 gint time_false);
    #define     GIMP_RANDOM_SEED_SPINBUTTON     (hbox)
    #define     GIMP_RANDOM_SEED_SPINBUTTON_ADJ (hbox)
    #define     GIMP_RANDOM_SEED_TOGGLEBUTTON   (hbox)
    GtkWidget*  gimp_coordinates_new            (GimpUnit unit,
                                                 const gchar *unit_format,
                                                 gboolean menu_show_pixels,
                                                 gboolean menu_show_percent,
                                                 gint spinbutton_usize,
                                                 GimpSizeEntryUpdatePolicy update_policy,
                                                 gboolean chainbutton_active,
                                                 gboolean chain_constrains_ratio,
                                                 const gchar *xlabel,
                                                 gdouble x,
                                                 gdouble xres,
                                                 gdouble lower_boundary_x,
                                                 gdouble upper_boundary_x,
                                                 gdouble xsize_0,
                                                 gdouble xsize_100,
                                                 const gchar *ylabel,
                                                 gdouble y,
                                                 gdouble yres,
                                                 gdouble lower_boundary_y,
                                                 gdouble upper_boundary_y,
                                                 gdouble ysize_0,
                                                 gdouble ysize_100);
    #define     GIMP_COORDINATES_CHAINBUTTON    (sizeentry)
    GtkWidget*  gimp_mem_size_entry_new         (GtkAdjustment *adjustment);
    #define     GIMP_MEM_SIZE_ENTRY_SPINBUTTON  (memsize)
    #define     GIMP_MEM_SIZE_ENTRY_SPINBUTTON_ADJ(memsize)
    #define     GIMP_MEM_SIZE_ENTRY_OPTIONMENU  (memsize)
    GtkWidget*  gimp_pixmap_button_new          (gchar **xpm_data,
                                                 const gchar *text);
    void        gimp_toggle_button_sensitive_update
                                                (GtkToggleButton *toggle_button);
    void        gimp_toggle_button_update       (GtkWidget *widget,
                                                 gpointer data);
    void        gimp_radio_button_update        (GtkWidget *widget,
                                                 gpointer data);
    void        gimp_menu_item_update           (GtkWidget *widget,
                                                 gpointer data);
    void        gimp_int_adjustment_update      (GtkAdjustment *adjustment,
                                                 gpointer data);
    void        gimp_uint_adjustment_update     (GtkAdjustment *adjustment,
                                                 gpointer data);
    void        gimp_float_adjustment_update    (GtkAdjustment *adjustment,
                                                 gpointer data);
    void        gimp_double_adjustment_update   (GtkAdjustment *adjustment,
                                                 gpointer data);
    void        gimp_unit_menu_update           (GtkWidget *widget,
                                                 gpointer data);
    void        gimp_table_attach_aligned       (GtkTable *table,
                                                 gint column,
                                                 gint row,
                                                 const gchar *label_text,
                                                 gfloat xalign,
                                                 gfloat yalign,
                                                 GtkWidget *widget,
                                                 gint colspan,
                                                 gboolean left_align);

## Description

## Details

### gimp_option_menu_new ()

    GtkWidget*  gimp_option_menu_new            (gboolean menu_only,
                                                 ...);

The `va_list` describing the GtkMenuItem's has the following format:

gchar *label, | The menu item's label.
GtkSignalFunc callback, | The callback which will be connected to the menu item's "activate" signal
gpointer data, | The callback data which will be used in gtk_signal_connect().
gpointer user_data, | The menu item's `user_data` which will be set with gtk_object_set_user_data().
GtkWidget **widget_ptr, | A pointer to store the created menu item in.
gboolean active, | TRUE if this should be the initially selected menu item.

`menu_only` : | TRUE if the function should return a GtkMenu only.
`...` : | A NULL terminated `va_list` describing the menu items.
Returns : | A GtkOptionMenu or a GtkMenu (depending on `menu_only`).

### gimp_option_menu_new2 ()

    GtkWidget*  gimp_option_menu_new2           (gboolean menu_only,
                                                 GtkSignalFunc menu_item_callback,
                                                 gpointer data,
                                                 gpointer initial,
                                                 ...);

The `va_list` describing the GtkMenuItem's has the following format:

gchar *label, | The menu item's label.
gpointer user_data, | The menu item's `user_data` which will be set with gtk_object_set_user_data().
GtkWidget **widget_ptr, | A pointer to store the created menu item in.

`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.
`data` : | The data which will be passed to gtk_signal_connect().
`initial` : | The `user_data` of the initially selected menu item.
`...` : | A NULL terminated `va_list` describing the menu items.
Returns : | A GtkOptionMenu or a GtkMenu (depending on `menu_only`).

### gimp_option_menu_set_history ()

    void        gimp_option_menu_set_history    (GtkOptionMenu *option_menu,
                                                 gpointer user_data);

`option_menu` : | A GtkOptionMenu as returned by gimp_option_menu_new() or gimp_option_menu_new2().
`user_data` : | The `user_data` of the menu item you want to select.

### gimp_radio_group_new ()

    GtkWidget*  gimp_radio_group_new            (gboolean in_frame,
                                                 const gchar *frame_title,
                                                 ...);

The `va_list` describing the GtkRadioButton's has the following format:

gchar *label, | The radio button's label.
GtkSignalFunc callback, | The callback which will be connected to the radio button's "toggled" signal
gpointer data, | The callback data which will be used in gtk_signal_connect().
gpointer user_data, | The radio button's `user_data` which will be set with gtk_object_set_user_data().
GtkWidget **widget_ptr, | A pointer to store the created radio button in.
gboolean active, | TRUE if this should be the initially pressed radio button.

`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.
Returns : | A GtkFrame or GtkVbox (depending on `in_frame`).

### gimp_radio_group_new2 ()

    GtkWidget*  gimp_radio_group_new2           (gboolean in_frame,
                                                 const gchar *frame_title,
                                                 GtkSignalFunc radio_button_callback,
                                                 gpointer data,
                                                 gpointer initial,
                                                 ...);

The `va_list` describing the GtkRadioButton's has the following format:

gchar *label, | The radio button's label.
gpointer user_data, | The radio button's `user_data` which will be set with gtk_object_set_user_data().
GtkWidget **widget_ptr, | A pointer to store the created radio button in.

`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.
`radio_button_callback` : | The callback each button's "toggled" signal will be connected with.
`data` : | The data which will be passed to gtk_signal_connect().
`initial` : | The `user_data` of the initially pressed radio button.
`...` : | A NULL terminated `va_list` describing the radio buttons.
Returns : | A GtkFrame or GtkVbox (depending on `in_frame`).

### gimp_spin_button_new ()

    GtkWidget*  gimp_spin_button_new            (GtkObject **adjustment,
                                                 gfloat value,
                                                 gfloat lower,
                                                 gfloat upper,
                                                 gfloat step_increment,
                                                 gfloat page_increment,
                                                 gfloat page_size,
                                                 gfloat climb_rate,
                                                 guint digits);

This function is a shortcut for gtk_adjustment_new() and a subsequent gtk_spin_button_new() and does some more initialisation stuff like setting a standard minimun horizontal size.

`adjustment` : | Returns the spinbutton's GtkAdjustment.
`value` : | The initial value of the spinbutton.
`lower` : | The lower boundary.
`upper` : | The uppper boundary.
`step_increment` : | The spinbutton's step increment.
`page_increment` : | The spinbutton's page increment (mouse button 2).
`page_size` : | The spinbutton's page size.
`climb_rate` : | The spinbutton's climb rate.
`digits` : | The spinbutton's number of decimal digits.
Returns : | A GtkSpinbutton and it's GtkAdjustment.

### gimp_scale_entry_new ()

    GtkObject*  gimp_scale_entry_new            (GtkTable *table,
                                                 gint column,
                                                 gint row,
                                                 const gchar *text,
                                                 gint scale_usize,
                                                 gint spinbutton_usize,
                                                 gfloat value,
                                                 gfloat lower,
                                                 gfloat upper,
                                                 gfloat step_increment,
                                                 gfloat page_increment,
                                                 guint digits,
                                                 gboolean constrain,
                                                 gfloat unconstrained_lower,
                                                 gfloat unconstrained_upper,
                                                 const gchar *tooltip,
                                                 const gchar *help_data);

This function creates a GtkLabel, a GtkHScale and a GtkSpinButton and attaches them to a 3-column GtkTable.

Note that if you pass a `tooltip` or `help_data` to this function you'll have to initialize GIMP's help system with gimp_help_init() before using it.

`table` : | The GtkTable the widgets will be attached to.
`column` : | The column to start with.
`row` : | The row to attach the widgets.
`text` : | The text for the GtkLabel which will appear left of the GtkHScale.
`scale_usize` : | The minimum horizontal size of the GtkHScale.
`spinbutton_usize` : | The minimum horizontal size of the GtkSpinButton.
`value` : | The initial value.
`lower` : | The lower boundary.
`upper` : | The upper boundary.
`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 GtkSpinButton should be the same as of the GtkHScale.
`unconstrained_lower` : | The spinbutton's lower boundary if `constrain` == FALSE.
`unconstrained_upper` : | The spinbutton's upper boundary 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()).
Returns : | The GtkSpinButton's GtkAdjustment.

### GIMP_SCALE_ENTRY_LABEL()

    #define     GIMP_SCALE_ENTRY_LABEL(adj)

Returns the scale_entry's GtkLabel.

`adj` : | The GtkAdjustment returned by gimp_scale_entry_new().

### GIMP_SCALE_ENTRY_SCALE()

    #define     GIMP_SCALE_ENTRY_SCALE(adj)

Returns the scale_entry's GtkHScale.

`adj` : | The GtkAdjustment returned by gimp_scale_entry_new().

### GIMP_SCALE_ENTRY_SCALE_ADJ()

    #define     GIMP_SCALE_ENTRY_SCALE_ADJ(adj)

Returns the GtkAdjustment of the scale_entry's GtkHScale.

`adj` : | The GtkAdjustment returned by gimp_scale_entry_new().

### GIMP_SCALE_ENTRY_SPINBUTTON()

    #define     GIMP_SCALE_ENTRY_SPINBUTTON(adj)

Returns the scale_entry's GtkSpinButton.

`adj` : | The GtkAdjustment returned by gimp_scale_entry_new().

### GIMP_SCALE_ENTRY_SPINBUTTON_ADJ()

    #define     GIMP_SCALE_ENTRY_SPINBUTTON_ADJ(adj)

Returns the GtkAdjustment of the scale_entry's GtkSpinButton.

`adj` : | The GtkAdjustment returned by gimp_scale_entry_new().

### gimp_random_seed_new ()

    GtkWidget*  gimp_random_seed_new            (gint *seed,
                                                 gint *use_time,
                                                 gint time_true,
                                                 gint time_false);

Note that this widget automatically sets tooltips with gimp_help_set_help_data(), so you'll have to initialize GIMP's help system with gimp_help_init() before using it.

`seed` : | A pointer to the variable which stores the random seed.
`use_time` : | A pointer to the variable which stores the `use_time` toggle boolean.
`time_true` : | The value to write to `use_time` if the toggle button is checked.
`time_false` : | The value to write to `use_time` if the toggle button is unchecked.
Returns : | A GtkHBox containing a GtkSpinButton for the random seed and a GtkToggleButton for toggling the `use_time` behaviour.

### GIMP_RANDOM_SEED_SPINBUTTON()

    #define     GIMP_RANDOM_SEED_SPINBUTTON(hbox)

Returns the random_seed's GtkSpinButton.

`hbox` : | The GtkHBox returned by gimp_random_seed_new().

### GIMP_RANDOM_SEED_SPINBUTTON_ADJ()

    #define     GIMP_RANDOM_SEED_SPINBUTTON_ADJ(hbox)

Returns the GtkAdjustment of the random_seed's GtkSpinButton.

`hbox` : | The GtkHBox returned by gimp_random_seed_new().

### GIMP_RANDOM_SEED_TOGGLEBUTTON()

    #define     GIMP_RANDOM_SEED_TOGGLEBUTTON(hbox)

Returns the random_seed's GtkToggleButton.

`hbox` : | The GtkHBox returned by gimp_random_seed_new().

### gimp_coordinates_new ()

    GtkWidget*  gimp_coordinates_new            (GimpUnit unit,
                                                 const gchar *unit_format,
                                                 gboolean menu_show_pixels,
                                                 gboolean menu_show_percent,
                                                 gint spinbutton_usize,
                                                 GimpSizeEntryUpdatePolicy update_policy,
                                                 gboolean chainbutton_active,
                                                 gboolean chain_constrains_ratio,
                                                 const gchar *xlabel,
                                                 gdouble x,
                                                 gdouble xres,
                                                 gdouble lower_boundary_x,
                                                 gdouble upper_boundary_x,
                                                 gdouble xsize_0,
                                                 gdouble xsize_100,
                                                 const gchar *ylabel,
                                                 gdouble y,
                                                 gdouble yres,
                                                 gdouble lower_boundary_y,
                                                 gdouble upper_boundary_y,
                                                 gdouble ysize_0,
                                                 gdouble ysize_100);

`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.
`spinbutton_usize` : | The horizontal usize of the GimpSizeEntry's GtkSpinButton's.
`update_policy` : | The update policy for the GimpSizeEntry.
`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 be constrained.
`xlabel` : | The label for the X coordinate.
`x` : | The initial value of the X coordinate.
`xres` : | The horizontal resolution in DPI.
`lower_boundary_x` : | The lower boundary of the X coordinate.
`upper_boundary_x` : | The upper boundary of the X coordinate.
`xsize_0` : | The X value which will be treated as 0%.
`xsize_100` : | The X value which will be treated as 100%.
`ylabel` : | The label for the Y coordinate.
`y` : | The initial value of the Y coordinate.
`yres` : | The vertical resolution in DPI.
`lower_boundary_y` : | The lower boundary of the Y coordinate.
`upper_boundary_y` : | The upper boundary of the Y coordinate.
`ysize_0` : | The Y value which will be treated as 0%.
`ysize_100` : | The Y value which will be treated as 100%.
Returns : | A GimpSizeEntry with two fields for x/y coordinates/sizes with a GimpChainButton attached to constrain either the two fields' values or the ratio between them.

### GIMP_COORDINATES_CHAINBUTTON()

    #define     GIMP_COORDINATES_CHAINBUTTON(sizeentry)

Returns the GimpChainButton which is attached to the GimpSizeEntry.

`sizeentry` : | The GimpSizeEntry returned by gimp_coordinates_new().

### gimp_mem_size_entry_new ()

    GtkWidget*  gimp_mem_size_entry_new         (GtkAdjustment *adjustment);

`adjustment` : | The adjustment containing the memsize and it's limits.
Returns : | A GtkHBox with a GtkSpinButton and a GtkOptionMenu.

### GIMP_MEM_SIZE_ENTRY_SPINBUTTON()

    #define     GIMP_MEM_SIZE_ENTRY_SPINBUTTON(memsize)

`memsize` : |

### GIMP_MEM_SIZE_ENTRY_SPINBUTTON_ADJ()

    #define     GIMP_MEM_SIZE_ENTRY_SPINBUTTON_ADJ(memsize)

`memsize` : |

### GIMP_MEM_SIZE_ENTRY_OPTIONMENU()

    #define     GIMP_MEM_SIZE_ENTRY_OPTIONMENU(memsize)

`memsize` : |

### gimp_pixmap_button_new ()

    GtkWidget*  gimp_pixmap_button_new          (gchar **xpm_data,
                                                 const gchar *text);

`xpm_data` : | The XPM data which will be passed to gimp_pixmap_new().
`text` : | An optional text which will appear right of the pixmap.
Returns : | A GtkButton with a GimpPixmap and an optional GtkLabel.

### gimp_toggle_button_sensitive_update ()

    void        gimp_toggle_button_sensitive_update
                                                (GtkToggleButton *toggle_button);

If you attached a pointer to a GtkWidget with gtk_object_set_data() and the "set_sensitive" key to the GtkToggleButton, the sensitive state of the attached widget will be set according to the toggle button's "active" state.

You can attach an arbitrary list of widgets by attaching another "set_sensitive" data pointer to the first widget (and so on...).

This function can also set the sensitive state according to the toggle button's inverse "active" state by attaching widgets with the "inverse_sensitive" key.

`toggle_button` : | The GtkToggleButton the "set_sensitive" and "inverse_sensitive" lists are attached to.

### gimp_toggle_button_update ()

    void        gimp_toggle_button_update       (GtkWidget *widget,
                                                 gpointer data);

Note that this function calls gimp_toggle_button_sensitive_update().

`widget` : | A GtkToggleButton.
`data` : | A pointer to a gint variable which will store the value of gtk_toggle_button_get_active().

### gimp_radio_button_update ()

    void        gimp_radio_button_update        (GtkWidget *widget,
                                                 gpointer data);

Note that this function calls gimp_toggle_button_sensitive_update().

`widget` : | A GtkRadioButton.
`data` : | A pointer to a gint variable which will store the value of GPOINTER_TO_INT (gtk_object_get_user_data()).

### gimp_menu_item_update ()

    void        gimp_menu_item_update           (GtkWidget *widget,
                                                 gpointer data);

`widget` : | A GtkMenuItem.
`data` : | A pointer to a gint variable which will store the value of GPOINTER_TO_INT (gtk_object_get_user_data()).

### gimp_int_adjustment_update ()

    void        gimp_int_adjustment_update      (GtkAdjustment *adjustment,
                                                 gpointer data);

Note that the GtkAdjustment's value (which is a gfloat) will be rounded with RINT().

`adjustment` : | A GtkAdjustment.
`data` : | A pointer to a gint variable which will store the `adjustment`'s value.

### gimp_uint_adjustment_update ()

    void        gimp_uint_adjustment_update     (GtkAdjustment *adjustment,
                                                 gpointer data);

Note that the GtkAdjustment's value (which is a gfloat) will be rounded with (guint) (value + 0.5).

`adjustment` : | A GtkAdjustment.
`data` : | A pointer to a guint variable which will store the `adjustment`'s value.

### gimp_float_adjustment_update ()

    void        gimp_float_adjustment_update    (GtkAdjustment *adjustment,
                                                 gpointer data);

`adjustment` : | A GtkAdjustment.
`data` : | A pointer to a gfloat varaiable which willl store the `adjustment`'s value.

### gimp_double_adjustment_update ()

    void        gimp_double_adjustment_update   (GtkAdjustment *adjustment,
                                                 gpointer data);

`adjustment` : | A GtkAdjustment.
`data` : | A pointer to a gdouble variable which will store the `adjustment`'s value.

### gimp_unit_menu_update ()

    void        gimp_unit_menu_update           (GtkWidget *widget,
                                                 gpointer data);

This callback can set the number of decimal digits of an arbitrary number of GtkSpinButton's. To use this functionality, attach the spinbuttons as list of data pointers attached with gtk_object_set_data() with the "set_digits" key.

See gimp_toggle_button_sensitive_update() for a description of how to set up the list.

`widget` : | A GimpUnitMenu.
`data` : | A pointer to a GimpUnit variable which will store the unit menu's value.

### gimp_table_attach_aligned ()

    void        gimp_table_attach_aligned       (GtkTable *table,
                                                 gint column,
                                                 gint row,
                                                 const gchar *label_text,
                                                 gfloat xalign,
                                                 gfloat yalign,
                                                 GtkWidget *widget,
                                                 gint colspan,
                                                 gboolean left_align);

Note that the `label_text` can be NULL and that the widget will be attached starting at (`column` + 1) in this case, too.

`table` : | The GtkTable the widgets will be attached to.
`column` : | The column to start with.
`row` : | The row to attach the eidgets.
`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.

<<< Previous Page | Home | Up | Next Page >>>
gimpquerybox | GIMP Module Header Files