GimpUnitMenu

GimpUnitMenu — Widget for selecting a GimpUnit.

Functions

Signals

void unit-changed Run First

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBin
                        ╰── GtkButton
                            ╰── GtkOptionMenu
                                ╰── GimpUnitMenu

Implemented Interfaces

GimpUnitMenu implements AtkImplementorIface, GtkBuildable and GtkActivatable.

Description

This widget provides a GtkOptionMenu which contains a list of GimpUnit's.

You can specify the string that will be displayed for each unit by passing a printf-like format string to gimp_unit_menu_new().

The constructor also lets you choose if the menu should contain items for GIMP_UNIT_PIXEL, GIMP_UNIT_PERCENT and a "More..." item which will pop up a dialog for selecting user-defined units.

Whenever the user selects a unit from the menu or the dialog, the "unit_changed" signal will be emitted.

Functions

gimp_unit_menu_new ()

GtkWidget *
gimp_unit_menu_new (const gchar *format,
                    GimpUnit unit,
                    gboolean show_pixels,
                    gboolean show_percent,
                    gboolean show_custom);

gimp_unit_menu_new is deprecated and should not be used in newly-written code.

Creates a new GimpUnitMenu widget.

For the format string's possible expansions, see gimp_unit_format_string().

Parameters

format

A printf-like format string which is used to create the unit strings.

 

unit

The initially selected unit.

 

show_pixels

TRUE if the unit menu should contain an item for GIMP_UNIT_PIXEL.

 

show_percent

TRUE in the unit menu should contain an item for GIMP_UNIT_PERCENT.

 

show_custom

TRUE if the unit menu should contain a "More..." item for opening the user-defined-unit selection dialog.

 

Returns

A pointer to the new GimpUnitMenu widget.


gimp_unit_menu_set_unit ()

void
gimp_unit_menu_set_unit (GimpUnitMenu *menu,
                         GimpUnit unit);

gimp_unit_menu_set_unit is deprecated and should not be used in newly-written code.

Sets a new GimpUnit for the specified GimpUnitMenu.

Parameters

menu

The unit menu you want to set the unit for.

 

unit

The new unit.

 

gimp_unit_menu_get_unit ()

GimpUnit
gimp_unit_menu_get_unit (GimpUnitMenu *menu);

gimp_unit_menu_get_unit is deprecated and should not be used in newly-written code.

Returns the GimpUnit the user has selected from the GimpUnitMenu.

Parameters

menu

The unit menu you want to know the unit of.

 

Returns

The unit the user has selected.


gimp_unit_menu_get_pixel_digits ()

gint
gimp_unit_menu_get_pixel_digits (GimpUnitMenu *menu);

gimp_unit_menu_get_pixel_digits is deprecated and should not be used in newly-written code.

Retrieve the number of digits for a pixel size as set by gimp_unit_menu_set_pixel_digits().

Parameters

menu

a GimpUnitMenu

 

Returns

the configured number of digits for a pixel size


gimp_unit_menu_set_pixel_digits ()

void
gimp_unit_menu_set_pixel_digits (GimpUnitMenu *menu,
                                 gint digits);

gimp_unit_menu_set_pixel_digits is deprecated and should not be used in newly-written code.

A GimpUnitMenu can be setup to control the number of digits shown by attached spinbuttons. Please refer to the documentation of gimp_unit_menu_update() to see how this is done.

This function specifies the number of digits shown for a size in pixels. Usually this is 0 (only full pixels). If you want to allow the user to specify sub-pixel sizes using the attached spinbuttons, specify the number of digits after the decimal point here. You should do this after attaching your spinbuttons.

Parameters

menu

a GimpUnitMenu

 

digits

the number of digits to display for a pixel size

 

Types and Values

GimpUnitMenu

typedef struct _GimpUnitMenu GimpUnitMenu;

GimpUnitMenu is deprecated and should not be used in newly-written code.

Signal Details

The “unit-changed” signal

void
user_function (GimpUnitMenu *gimpunitmenu,
               gpointer      user_data)

This signal is emitted whenever the user selects a GimpUnit from the GimpUnitMenu.

Parameters

user_data

user data set when the signal handler was connected.

 

Flags: Run First

See Also

GimpUnit, GimpSizeEntry, gimp_coordinates_new()