Namespace
GimpUi – 3.0
GIMP UI library
Dependencies
Babl—0.1 | Pixel encoding and color space conversion engine |
Browse documentation | |
GLib—2.0 | C Utility Library |
Browse documentation | |
GObject—2.0 | The base type system library |
Browse documentation | |
Gio—2.0 | GObject interfaces and objects |
Browse documentation | |
GdkPixbuf—2.0 | Image loading and scaling |
Browse documentation | |
Gegl—0.4 | Generic Graphics Library |
Browse documentation | |
cairo—1.0 | A 2D graphics library with support for multiple output devices |
Browse documentation | |
Gimp—3.0 | GIMP Library |
Browse documentation | |
Gtk—3.0 | The GTK toolkit |
Browse documentation |
Classes
AspectPreview |
A widget providing a preview with fixed aspect ratio. |
Browser |
A base class for a documentation browser. |
BrushChooser |
A button which pops up a brush selection dialog. |
BusyBox |
|
Button |
|
CellRendererColor |
A |
CellRendererToggle |
A |
ChainButton |
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. |
ChannelComboBox | |
ColorArea |
Displays a |
ColorButton |
This widget provides a simple button with a preview showing the color. |
ColorDisplay |
Functions and definitions for creating pluggable GIMP display color correction modules. |
ColorDisplayStack |
A stack of color correction modules. |
ColorHexEntry |
Widget for entering a color’s hex triplet. The syntax follows CSS and SVG specifications, which means that only sRGB colors are supported. |
ColorNotebook |
The |
ColorProfileChooserDialog |
A |
ColorProfileComboBox |
A combo box for selecting color profiles. |
ColorProfileStore |
A |
ColorProfileView |
A widget for viewing the properties of a |
ColorScaleEntry |
This widget is a subclass of |
ColorSelection |
Widget for doing a color selection. |
ColorSelector |
Functions and definitions for creating pluggable GIMP color selector modules. |
Dialog |
Constructors for |
DrawableChooser |
The chooser contains an optional label and a button which queries the core process to pop up a drawable selection dialog. unstable since: 3.0 |
DrawableComboBox | |
DrawablePreview |
A widget providing a preview of a |
EnumComboBox |
A |
EnumLabel |
A |
EnumStore |
A |
FontChooser |
A button which pops up a font selection dialog. |
Frame |
A widget providing a HIG-compliant subclass of |
GradientChooser |
A button which pops up a gradient select dialog. |
HintBox |
Displays a wilber icon and a text. |
ImageComboBox |
A widget providing a popup menu of images. |
IntComboBox |
A widget providing a popup menu of integer values (e.g. enums). |
IntRadioFrame |
A widget providing a frame with title, containing grouped radio buttons, each associated with an integer value and random user data. |
IntStore |
A model for integer based name-value pairs (e.g. enums) |
LabelColor |
This widget is a subclass of |
Labeled |
This widget is a |
LabelEntry |
This widget is a subclass of |
LabelIntWidget |
This widget is a subclass of |
LabelSpin |
This widget is a subclass of |
LayerComboBox | |
MemsizeEntry |
Similar to a |
NumberPairEntry |
A |
OffsetArea |
Widget to control image offsets. |
PageSelector |
Use this for example for specifying what pages to import from a PDF or PS document. |
PaletteChooser |
A button which pops up a palette selection dialog. |
PathEditor |
This widget is used to edit file search paths. |
PatternChooser |
A button which pops up a pattern selection dialog. |
PickButton |
|
Preview |
A widget providing a |
PreviewArea |
A general purpose preview widget which caches its pixel data. |
ProcBrowserDialog |
The dialog for the procedure and plugin browsers. |
ProcedureDialog | |
ProgressBar |
A widget providing a progress bar that automatically redirects any progress calls to itself. |
ResourceChooser |
A button which pops up a resource selection dialog. unstable since: 3.0 |
Ruler |
A ruler widget with configurable unit and orientation. |
SaveProcedureDialog | |
ScaleEntry |
This widget is a |
ScrolledPreview |
A widget providing a |
SizeEntry |
This widget is used to enter pixel distances/sizes and resolutions. |
SpinButton |
|
SpinScale | |
StringComboBox |
A |
UnitComboBox |
|
UnitStore |
A model for |
VectorsComboBox | |
ZoomModel |
A model for zoom values. |
ZoomPreview |
A drawable preview with zooming capabilities. |
Structs
ColorScale | |
ColorScales | |
ColorSelect | |
Controller | |
FileEntry |
This widget is used to enter filenames or directories. |
SizeEntryField |
Enumerations
AspectType |
Aspect ratios. |
ChainPosition |
Possible chain positions for |
ColorAreaType |
The types of transparency display for |
ColorSelectorChannel |
An enum to specify the types of color channels edited in
|
ColorSelectorModel |
An enum to specify the types of color spaces edited in
since: 2.10 |
ExportReturn |
Possible return values of gimp_export_image(). |
IntComboBoxLayout |
Possible layouts for since: 2.10 |
IntStoreColumns |
The column types of |
PageSelectorTarget |
Import targets for |
SizeEntryUpdatePolicy |
Update policies for |
ZoomType |
The zoom types for |
Bitfields
ExportCapabilities |
The types of images and layers an export procedure can handle. |
Error Domains
WidgetsError |
Types of errors returned by libgimpwidgets functions. |
Callbacks
HelpFunc |
This is the prototype for all functions you pass as |
ImageConstraintFunc | |
IntRadioFrameSensitivityFunc |
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 |
IntSensitivityFunc | |
ItemConstraintFunc | |
QueryBooleanCallback |
The callback for a boolean query box. |
QueryDoubleCallback |
The callback for a double query box. |
QueryIntCallback |
The callback for an int query box. |
QuerySizeCallback |
The callback for a size query box. |
QueryStringCallback |
Note that you must not |
StringSensitivityFunc |
Functions
cairo_set_focus_line_pattern |
Sets color and dash pattern for stroking a focus line on the given
since: 2.6 |
cairo_set_source_color |
Sets unstable since: 3.0 |
cairo_surface_create_from_pixbuf |
Create a Cairo image surface from a GdkPixbuf. since: 2.6 |
context_help |
This function invokes the context help inspector. |
coordinates_new |
Convenience function that creates a |
dialogs_show_help_button |
This function is for internal use only. since: 2.2 |
double_adjustment_update | |
enum_icon_box_new |
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 since: 2.10 |
enum_icon_box_new_with_range |
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 |
enum_icon_box_set_child_padding |
Sets the padding of all buttons in a box created by gimp_enum_icon_box_new(). since: 2.10 |
enum_radio_box_new |
Creates a new group of since: 2.4 |
enum_radio_box_new_with_range |
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 |
enum_radio_frame_new |
Calls since: 2.4 |
enum_radio_frame_new_with_range |
Calls since: 2.4 |
event_triggers_context_menu |
Alternative of unstable since: 3.0 |
export_dialog_get_content_area |
Returns the vertical since: 2.8 |
export_dialog_new |
Creates a new export dialog. All file plug-ins should use this
dialog to get a consistent look on the export dialogs. Use
since: 2.8 |
export_image |
Takes an image and a drawable to be saved together with a description of the capabilities of the image_format. If the type of image doesn’t match the capabilities of the format a dialog is opened that informs the user that the image has to be exported and offers to do the necessary conversions. |
float_adjustment_update | |
get_monitor_at_pointer | |
grid_attach_aligned |
Note that the |
help_connect |
Note that this function is automatically called by all libgimp dialog constructors. You only have to call it for windows/dialogs you created “manually”. |
help_id_quark |
This function returns the since: 2.2 |
help_set_help_data |
The reason why we don’t use |
help_set_help_data_with_markup |
Just like gimp_help_set_help_data(), but supports to pass text which is marked up with Pango text markup language. since: 2.6 |
icons_init |
Initializes the GIMP stock icon factory. |
icons_set_icon_theme | |
init |
This function initializes GTK+ with gtk_init(). |
int_adjustment_update |
Note that the |
int_radio_group_new |
Convenience function to create a group of radio buttons embedded into
a |
int_radio_group_set_active |
Calls |
label_set_attributes |
Sets Pango attributes on a since: 2.2 |
monitor_get_color_profile |
This function returns the unstable since: 3.0 |
proc_view_new |
since: 2.4 |
prop_boolean_combo_box_new |
Creates a since: 2.4 |
prop_boolean_radio_frame_new |
Creates a pair of radio buttons which function to set and display
the specified boolean property.
If since: 2.4 |
prop_brush_chooser_new |
Creates a unstable since: 3.0 |
prop_check_button_new |
Creates a since: 2.4 |
prop_choice_combo_box_new |
Creates a since: 2.4 |
prop_color_area_new |
Creates a since: 2.4 |
prop_color_select_new |
Creates a unstable since: 3.0 |
prop_coordinates_connect | |
prop_coordinates_new |
Creates a since: 2.4 |
prop_drawable_chooser_new |
Creates a unstable since: 3.0 |
prop_entry_new |
Creates a since: 2.4 |
prop_enum_check_button_new |
Creates a since: 2.4 |
prop_enum_combo_box_new |
Creates a since: 2.4 |
prop_enum_icon_box_new |
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 since: 2.10 |
prop_enum_label_new |
since: 2.4 |
prop_enum_radio_box_new |
Creates a group of radio buttons which function to set and display
the specified enum property. The since: 2.4 |
prop_enum_radio_frame_new |
Creates a group of radio buttons which function to set and display
the specified enum property. The since: 2.4 |
prop_expander_new |
Creates a since: 2.4 |
prop_file_chooser_button_new |
Creates a since: 2.4 |
prop_file_chooser_button_new_with_dialog |
Creates a since: 2.4 |
prop_font_chooser_new |
Creates a unstable since: 3.0 |
prop_gradient_chooser_new |
Creates a unstable since: 3.0 |
prop_hscale_new |
Creates a horizontal scale to control the value of the specified integer or double property. since: 2.4 |
prop_icon_image_new |
Creates a widget to display a icon image representing the value of the
specified string property, which should encode an icon name.
See since: 2.10 |
prop_int_combo_box_new |
Creates a since: 2.4 |
prop_int_radio_frame_new |
Creates a group of radio buttons which function to set and display
the specified int property. If unstable since: 3.0 |
prop_label_color_new |
Creates a unstable since: 3.0 |
prop_label_entry_new |
Creates a unstable since: 3.0 |
prop_label_new |
Creates a since: 2.4 |
prop_label_spin_new |
Creates a since: 2.4 |
prop_memsize_entry_new |
Creates a since: 2.4 |
prop_palette_chooser_new |
Creates a unstable since: 3.0 |
prop_path_editor_new |
Creates a |
prop_pattern_chooser_new |
Creates a unstable since: 3.0 |
prop_pointer_combo_box_new |
Creates a since: 2.10 |
prop_scale_entry_new |
Creates a since: 2.4 |
prop_size_entry_new |
Creates a since: 2.4 |
prop_spin_button_new |
Creates a spin button to set and display the value of the specified double property. since: 2.4 |
prop_spin_scale_new |
Creates a spin scale to set and display the value of the specified int or double property. unstable since: 3.0 |
prop_string_combo_box_new |
Creates a since: 2.4 |
prop_switch_new |
Creates a unstable since: 3.0 |
prop_text_buffer_new |
Creates a since: 2.4 |
prop_unit_combo_box_new |
Creates a since: 2.8 |
prop_widget_set_factor |
Change the display factor of the property unstable since: 3.0 |
query_boolean_box |
Creates a new |
query_double_box |
Creates a new |
query_int_box |
Creates a new |
query_size_box |
Creates a new |
query_string_box |
Creates a new |
radio_button_update | |
random_seed_new |
Creates a widget that allows the user to control how the random number generator is initialized. |
scroll_adjustment_values | |
standard_help_func |
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. |
toggle_button_update | |
uint_adjustment_update |
Note that the |
widget_get_color_profile |
This function returns the unstable since: 3.0 |
widget_get_color_transform |
This function returns the since: 2.10 |
widget_get_monitor | |
widget_get_render_space | |
widget_set_native_handle |
This function is used to store the handle representing |
widget_track_monitor |
This function behaves as if since: 2.10 |
widgets_error_quark |
This function is never called directly. Use GIMP_WIDGETS_ERROR() instead. |
window_set_transient |
Indicates to the window manager that since: 2.4 |
window_set_transient_for_display |
Indicates to the window manager that since: 2.4 |
zoom_button_new |
Function Macros
COORDINATES_CHAINBUTTON | |
FILE_ENTRY_CLASS | |
QUERY_BOX_VBOX |
A macro to access the vertical |
RANDOM_SEED_SPINBUTTON | |
RANDOM_SEED_SPINBUTTON_ADJ | |
RANDOM_SEED_TOGGLE |