GimpUi – 3.0

A widget providing a preview with fixed aspect ratio.

A base class for a documentation browser.

A button which pops up a brush selection dialog.

GimpBusyBox displays a styled message, providing indication of an ongoing operation.

GimpButton adds an extra signal to the GtkButton widget that allows the callback to distinguish a normal click from a click that was performed with modifier keys pressed.

A GtkCellRenderer to display a GeglColor color.

A GtkCellRendererToggle that displays icons instead of a checkbox.

This widget provides a button showing either a linked or a broken chain that can be used to link two entries, spinbuttons, colors or other GUI elements and show that they may be locked. Use it for example to connect X and Y ratios to provide the possibility of a constrained aspect ratio.

Displays a GeglColor, optionally with alpha-channel.

This widget provides a simple button with a preview showing the color.

Functions and definitions for creating pluggable GIMP display color correction modules.

A stack of color correction modules.

Widget for entering a color’s hex triplet. The syntax follows CSS and SVG specifications, which means that only sRGB colors are supported.

The GimpColorNotebook widget is an implementation of a GimpColorSelector. It serves as a container for GimpColorSelectors.

A GtkFileChooser subclass for selecting color profiles.

A combo box for selecting color profiles.

A GtkListStore subclass that keep color profiles.

A widget for viewing the properties of a GimpColorProfile.

Fancy colored sliders.

This widget is a subclass of GimpScaleEntry showing a GimpColorScale instead of a GtkScale.

Widget for doing a color selection.

Functions and definitions for creating pluggable GIMP color selector modules.

Constructors for GtkDialog‘s and action_areas as well as other dialog-related stuff.

The chooser contains an optional label and a button which queries the core process to pop up a drawable selection dialog.

since: 3.0

A widget providing a preview of a GimpDrawable.

A GtkComboBox subclass for selecting an enum value.

A GtkLabel subclass that displays an enum value.

A GimpIntStore subclass that keeps enum values.

A button which pops up a font selection dialog.

A widget providing a HIG-compliant subclass of GtkFrame.

A button which pops up a gradient select dialog.

Displays a wilber icon and a text.

A widget providing a popup menu of images.

A widget providing a popup menu of integer values (e.g. enums).

A widget providing a frame with title, containing grouped radio buttons, each associated with an integer value and random user data.

A model for integer based name-value pairs (e.g. enums)

This widget is a subclass of GimpLabeled with a GtkColor.

This widget is a GtkGrid showing a GtkLabel used as mnemonic on another widget.

This widget is a subclass of GimpLabeled with a GtkEntry.

This widget is a subclass of GimpLabeled.

This widget is a subclass of GimpLabeled with a GimpSpinButton.

This widget is a subclass of GimpLabeled.

Similar to a GimpSizeEntry but instead of lengths, this widget is used to let the user enter memory sizes. A combo box allows one to switch between Kilobytes, Megabytes and Gigabytes. Used in the GIMP preferences dialog.

A GtkEntry subclass to enter ratios.

Widget to control image offsets.

Use this for example for specifying what pages to import from a PDF or PS document.

A button which pops up a palette selection dialog.

This widget is used to edit file search paths.

A button which pops up a pattern selection dialog.

GimpPickButton is a specialized button. When clicked, it changes the cursor to a color-picker pipette and allows the user to pick a color from any point on the screen.

A widget providing a GimpPreviewArea plus framework to update the preview.

A general purpose preview widget which caches its pixel data.

The dialog for the procedure and plugin browsers.

A widget providing a progress bar that automatically redirects any progress calls to itself.

A button which pops up a resource selection dialog.

since: 3.0

A ruler widget with configurable unit and orientation.

This widget is a GtkGrid showing a GtkSpinButton and a GtkScale bound together. It also displays a GtkLabel which is used as mnemonic on the GtkSpinButton.

A widget providing a GimpPreview enhanced by scrolling capabilities.

This widget is used to enter pixel distances/sizes and resolutions.

GimpSpinButton is a drop-in replacement for GtkSpinButton, with the following changes:

A GtkComboBox subclass to select strings.

GimpUnitComboBox selects units stored in a GimpUnitStore.

A model for GimpUnit views.

A model for zoom values.

A drawable preview with zooming capabilities.

Aspect ratios.

Possible chain positions for GimpChainButton.

The types of transparency display for GimpColorArea.

An enum to specify the types of color channels edited in GimpColorSelector widgets.

An enum to specify the types of color spaces edited in GimpColorSelector widgets.

since: 2.10

Possible layouts for GimpIntComboBox.

since: 2.10

The column types of GimpIntStore.

Import targets for GimpPageSelector.

Update policies for GimpSizeEntry.

The zoom types for GimpZoomModel.

Types of errors returned by libgimpwidgets functions.

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.

Signature for a function called on each radio button value and data, each time the %GimpIntRadioFrame is drawn, to make some radio button insensitive. If the function returns FALSE, it usually means that the value is not a valid choice in current situation. In this case, you might want to toggle instead another value automatically. Set new_value to the value to toggle. If you leave this untouched, the radio button will stay toggled despite being insensitive. This is up to you to decide whether this is meaningful.

The callback for a boolean query box.

The callback for a double query box.

The callback for an int query box.

The callback for a size query box.

Note that you must not g_free() the passed string.

Sets color and dash pattern for stroking a focus line on the given cr. The line pattern is taken from widget.

since: 2.6

Sets color as the source pattern within cr, taking into account the profile of the GdkMonitor which widget is displayed on.

since: 3.0

Create a Cairo image surface from a GdkPixbuf.

since: 2.6

This function invokes the context help inspector.

Convenience function that creates 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.

This function is for internal use only.

since: 2.2

Creates a horizontal box of radio buttons with named icons. The icon name for each icon is created by appending the enum_value’s nick to the given icon_prefix.

since: 2.10

Just like gimp_enum_icon_box_new(), this function creates a group of radio buttons, but additionally it supports limiting the range of available enum values.

since: 2.10

Sets the padding of all buttons in a box created by gimp_enum_icon_box_new().

since: 2.10

Sets the icon size of all buttons in a box created by gimp_enum_icon_box_new().

since: 3.0

Creates a new group of GtkRadioButtons representing the enum values. A group of radiobuttons is a good way to represent enums with up to three or four values. Often it is better to use a GimpEnumComboBox instead.

since: 2.4

Just like gimp_enum_radio_box_new(), this function creates a group of radio buttons, but additionally it supports limiting the range of available enum values.

since: 2.4

Calls gimp_enum_radio_box_new() and puts the resulting vbox into a GtkFrame.

since: 2.4

Calls gimp_enum_radio_box_new_with_range() and puts the resulting vertical box into a GtkFrame.

since: 2.4

Alternative of gdk_event_triggers_context_menu() with the additional feature of allowing a menu triggering to happen on a button release event. All the other rules on whether event should trigger a contextual menu are exactly the same. Only the swapping to release state as additional feature is different.

since: 3.0

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 this function is automatically called by all libgimp dialog constructors. You only have to call it for windows/dialogs you created “manually”.

This function returns the GQuark which should be used as key when attaching help IDs to widgets and objects.

since: 2.2

The reason why we don’t use gtk_widget_set_tooltip_text() is that elements in the GIMP user interface should, if possible, also have a help_id set for context-sensitive help.

Just like gimp_help_set_help_data(), but supports to pass text which is marked up with Pango text markup language.

since: 2.6

Initializes the GIMP stock icon factory.

This function initializes GTK+ with gtk_init(). It also initializes Gegl and Babl.

Note that the GtkAdjustment‘s value (which is a #gdouble) will be rounded with RINT().

Convenience function to create a group of radio buttons embedded into a GtkFrame or GtkBox. This function does the same thing as gimp_radio_group_new2(), but it takes integers as item_data instead of pointers, since that is a very common case (mapping an enum to a radio group).

Calls gtk_toggle_button_set_active() with the radio button that was created with a matching item_data. This function does the same thing as gimp_radio_group_set_active(), but takes integers as item_data instead of pointers.

Sets Pango attributes on a GtkLabel in a more convenient way than gtk_label_set_attributes().

since: 2.2

This function returns the GimpColorProfile of monitor or NULL if there is no profile configured.

since: 3.0

since: 2.4

Creates a GtkComboBox widget to display and set the specified boolean property. The combo box will have two entries, one displaying the true_text label, the other displaying the false_text label.

since: 2.4

Creates a pair of radio buttons which function to set and display the specified boolean property. If title is NULL, the property_name‘s nick will be used as label of the returned frame.

since: 2.4

Creates a GimpBrushChooser controlled by the specified property.

since: 3.0

Creates a GtkCheckButton that displays and sets the specified boolean property. If label is NULL, the property_name‘s nick will be used as label of the returned button.

since: 2.4

Creates a GimpStringComboBox widget to display and set the specified property.

Creates a GimpIntRadioFrame widget to display and set the specified GimpChoice property.

Creates a GimpColorArea to set and display the value of an RGB property.

since: 2.4

Creates a GimpColorButton to set and display the value of a color property.

since: 3.0

Creates a GimpSizeEntry to set and display two double or int properties, which will usually represent X and Y coordinates, and their associated unit property.

since: 2.4

Creates a GimpDrawableChooser controlled by the specified property.

since: 3.0

Creates a GtkEntry to set and display the value of the specified string property.

since: 2.4

Creates a GtkCheckButton that displays and sets the specified property of type Enum. Note that this widget only allows two values for the enum, one corresponding to the “checked” state and the other to the “unchecked” state. If label is NULL, the property_name‘s nick will be used as label of the returned button.

since: 2.4

Creates a GimpIntComboBox widget to display and set the specified enum property. The mimimum_value and maximum_value give the possibility of restricting the allowed range to a subset of the enum. If the two values are equal (e.g., 0, 0), then the full range of the Enum is used.

since: 2.4

Creates a horizontal box of radio buttons with named icons, which function to set and display the value of the specified Enum property. The icon name for each icon is created by appending the enum_value’s nick to the given icon_prefix. See gimp_enum_icon_box_new() for more information.

since: 2.10

since: 2.4

Creates a group of radio buttons which function to set and display the specified enum property. The minimum and maximum arguments allow only a subset of the enum to be used. If the two arguments are equal (e.g., 0, 0), then the full range of the enum will be used. If you want to assign a label to the group of radio buttons, use gimp_prop_enum_radio_frame_new() instead of this function.

since: 2.4

Creates a group of radio buttons which function to set and display the specified enum property. The minimum and maximum arguments allow only a subset of the enum to be used. If the two arguments are equal (e.g., 0, 0), then the full range of the enum will be used. If title is NULL, the property_name‘s nick will be used as label of the returned frame.

since: 2.4

Creates a GtkExpander controlled by the specified boolean property. A value of TRUE for the property corresponds to the expanded state for the widget. If label is NULL, the property_name‘s nick will be used as label of the returned widget.

since: 2.4

Creates a GtkFileChooserButton to edit the specified path property. property_name must represent either a GIMP_PARAM_SPEC_CONFIG_PATH or a G_PARAM_SPEC_OBJECT where value_type == G_TYPE_FILE.

since: 2.4

Creates a GtkFileChooserButton to edit the specified path property.

since: 2.4

Creates a GimpFontChooser controlled by the specified property.

since: 3.0

Creates a GimpGradientChooser controlled by the specified property.

since: 3.0

Creates a horizontal scale to control the value of the specified integer or double property.

since: 2.4

Creates a widget to display a icon image representing the value of the specified string property, which should encode an icon name. See gtk_image_new_from_icon_name() for more information.

since: 2.10

Creates a GimpIntComboBox widget to display and set the specified property. The contents of the widget are determined by store, which should be created using gimp_int_store_new().

since: 2.4

Creates a group of radio buttons which function to set and display the specified int property. If title is NULL, the property_name‘s nick will be used as label of the returned frame.

since: 3.0

Creates a GimpLabelColor to set and display the value of an RGB property.

since: 3.0

Creates a GimpLabelEntry to set and display the value of the specified string property.

since: 3.0

Creates a GtkLabel to display the value of the specified property. The property should be a string property or at least transformable to a string. If the user should be able to edit the string, use gimp_prop_entry_new() instead.

since: 2.4

Creates a GimpLabelSpin to set and display the value of the specified double property.

since: 2.4

Creates a GimpMemsizeEntry (spin button and option menu) to set and display the value of the specified memsize property. See gimp_memsize_entry_new() for more information.

since: 2.4

Creates a GimpPaletteChooser controlled by the specified property.

since: 3.0

Creates a GimpPathEditor to edit the specified path and writable path properties.

Creates a GimpPatternChooser controlled by the specified property.

since: 3.0

Creates a GimpIntComboBox widget to display and set the specified property. The contents of the widget are determined by store, which should be created using gimp_int_store_new(). Values are GType/gpointer data, and therefore must be stored in the “user-data” column, instead of the usual “value” column.

since: 2.10

Creates a GimpScaleEntry (slider and spin button) to set and display the value of a specified int or double property with sensible default settings depending on the range (decimal places, increments, etc.). These settings can be overridden by the relevant widget methods.

since: 2.4

Creates a GimpSizeEntry to set and display the specified double or int property, and its associated unit property. Note that this function is only suitable for creating a size entry holding a single value. Use gimp_prop_coordinates_new() to create a size entry holding two values.

since: 2.4

Creates a spin button to set and display the value of the specified double property.

since: 2.4

Creates a spin scale to set and display the value of the specified int or double property.

since: 3.0

Creates a GimpStringComboBox widget to display and set the specified property. The contents of the widget are determined by store.

since: 2.4

Creates a GtkBox with a switch and a label that displays and sets the specified boolean property. If label is NULL, the property_name‘s nick will be used as label.

since: 3.0

Creates a GtkTextBuffer to set and display the value of the specified string property. Unless the string is expected to contain multiple lines or a large amount of text, use gimp_prop_entry_new() instead. See GtkTextView for information on how to insert a text buffer into a visible widget.

since: 2.4

Creates a GimpUnitComboBox to set and display the value of a Unit property. See gimp_unit_combo_box_new() for more information.

since: 2.8

Change the display factor of the property widget relatively to the property it was bound to. Currently the only types of widget accepted as input are those created by gimp_prop_spin_scale_new() and gimp_prop_spin_button_new().

since: 3.0

Creates a new GtkDialog that asks the user to do a boolean decision.

Creates a new GtkDialog that queries the user for a double value.

Creates a new GtkDialog that queries the user for an integer value.

Creates a new GtkDialog that queries the user for a size using a GimpSizeEntry.

Creates a new GtkDialog that queries the user for a string value.

Creates a widget that allows the user to control how the random number generator is initialized.

This is the standard GIMP help function which does nothing but calling gimp_help(). It is the right function to use in almost all cases.

Note that the GtkAdjustment‘s value (which is a #gdouble) will be rounded with (#guint) (value + 0.5).

This function attempts to read the user’s system preference for showing animation. It can be used to turn off or hide unnecessary animations such as the scrolling credits or Easter Egg animations.

since: 3.0

Disposes a widget’s native window handle created asynchronously after a previous call to gimp_widget_set_native_handle. This disposes what the pointer points to, a *GBytes, if any. Call this when the widget and the window handle it owns is being disposed.

This function returns the GimpColorProfile of the monitor widget is currently displayed on, or NULL if there is no profile configured.

since: 3.0

This function returns the GimpColorTransform that transforms pixels from src_profile to the profile of the GdkMonitor the widget is displayed on.

since: 2.10

This function is used to store the handle representing window into handle so that it can later be reused to set other windows as transient to this one (even in other processes, such as plug-ins).

This function behaves as if GtkWidget had a signal.

since: 2.10

This function is never called directly. Use GIMP_WIDGETS_ERROR() instead.

Indicates to the window manager that window is a transient dialog associated with the GIMP window that the plug-in has been started from. See also gimp_window_set_transient_for_display().

since: 2.4

Indicates to the window manager that window is a transient dialog to the window identified by handle.

since: 3.0

Indicates to the window manager that window is a transient dialog associated with the GIMP image window that is identified by its display. See gdk_window_set_transient_for() for more information.

since: 2.4

A macro to access the vertical GtkBox in a #libgimpwidgets-gimpquerybox. Useful if you want to add more widgets.

The suggested width for a color bar in a GimpColorSelector implementation.

The suggested size for a color area in a GimpColorSelector implementation.