GimpUi.ColorSelector¶

Subclasses:: GimpUi.ColorNotebook

Methods¶

Inherited:: Gtk.Box (14), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Orientable (2)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

	`enable_simulation` (enabled)
	`get_channel` ()
	`get_color` ()
	`get_model_visible` (model)
	`get_show_alpha` ()
	`get_simulation` (profile, intent, bpc)
	`get_toggles_sensitive` ()
	`get_toggles_visible` ()
	`set_channel` (channel)
	`set_color` (color)
	`set_config` (config)
	`set_format` (format)
	`set_model_visible` (model, visible)
	`set_show_alpha` (show_alpha)
	`set_simulation` (profile, intent, bpc)
	`set_toggles_sensitive` (sensitive)
	`set_toggles_visible` (visible)

Virtual Methods¶

Inherited:: Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

	`do_channel_changed` (channel)
	`do_color_changed` (color)
	`do_model_visible_changed` (model, visible)
	`do_set_channel` (channel)
	`do_set_color` (color)
	`do_set_config` (config)
	`do_set_format` (format)
	`do_set_model_visible` (model, visible)
	`do_set_show_alpha` (show_alpha)
	`do_set_simulation` (profile, intent, bpc)
	`do_set_toggles_sensitive` (sensitive)
	`do_set_toggles_visible` (visible)
	`do_simulation` (enabled)

Properties¶

Inherited:: Gtk.Box (3), Gtk.Container (3), Gtk.Widget (39), Gtk.Orientable (1)

Child Properties¶

Inherited:: Gtk.Box (5)

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Short Description
`channel-changed`
`color-changed`
`model-visible-changed`
`simulation`

Fields¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Gtk.Box`	r

Class Details¶

class GimpUi.ColorSelector(*args, **kwargs)¶

Bases:: Gtk.Box
Abstract:: Yes
Structure:: GimpUi.ColorSelectorClass

Functions and definitions for creating pluggable GIMP color selector modules.

enable_simulation(enabled)¶

Parameters:: enabled (bool) –
Return type:: bool

get_channel()¶

Returns:: The GimpUi.ColorSelectorChannel currently shown by the self.
Return type:: GimpUi.ColorSelectorChannel

Returns the self's current channel.

New in version 2.10.

get_color()¶

Returns:: a copy of the selected color.
Return type:: Gegl.Color

Retrieves the color shown in the self widget.

New in version 2.10.

get_model_visible(model)¶

Parameters:: model (GimpUi.ColorSelectorModel) – The GimpUi.ColorSelectorModel.
Returns:: whether model is visible in self.
Return type:: bool

New in version 2.10.

get_show_alpha()¶

Returns:: True if the GimpUi.ColorSelector has alpha controls.
Return type:: bool

Returns the self's show_alpha property.

New in version 2.10.

get_simulation(profile, intent, bpc)¶

Parameters:

profile (Gimp.ColorProfile) –
intent (Gimp.ColorRenderingIntent) –
bpc (bool) –

Return type:

bool

get_toggles_sensitive()¶

Returns:: True if the GimpUi.ColorSelector's toggles are sensitive.
Return type:: bool

Returns the sensitive property of the self's toggles.

New in version 2.10.

get_toggles_visible()¶

Returns:: True if the GimpUi.ColorSelector's toggles are visible.
Return type:: bool

Returns the visible property of the self's toggles.

New in version 2.10.

set_channel(channel)¶

Parameters:: channel (GimpUi.ColorSelectorChannel) – The new channel setting.

Sets the channel property of the self widget.

Changes between displayed channels if this self instance has the ability to show different channels. This will also update the color model if needed.

set_color(color)¶

Parameters:: color (Gegl.Color) – The new color.

Sets the color shown in the self widget.

set_config(config)¶

Parameters:: config (Gimp.ColorConfig) – a Gimp.ColorConfig object.

Sets the color management configuration to use with this color selector.

New in version 2.4.

set_format(format)¶

Parameters:: format (Babl.Object) – a Babl.Object format, with space.

Sets the babl format representing the color model and the space this self is supposed to display values for. Depending on the type of color selector, it may trigger various UX changes, or none at all.

New in version 3.0.

set_model_visible(model, visible)¶

Parameters:

model (GimpUi.ColorSelectorModel) – The affected GimpUi.ColorSelectorModel.
visible (bool) – The new visible setting.

Sets the model visible/invisible on the self widget.

Toggles visibility of displayed models if this self instance has the ability to show different color models.

New in version 2.10.

set_show_alpha(show_alpha)¶

Parameters:: show_alpha (bool) – The new show_alpha setting.

Sets the show_alpha property of the self widget.

set_simulation(profile, intent, bpc)¶

Parameters:

profile (Gimp.ColorProfile) – a Gimp.ColorProfile object.
intent (Gimp.ColorRenderingIntent) – a Gimp.ColorRenderingIntent enum.
bpc (bool) – a bool.

Sets the simulation options to use with this color selector.

New in version 3.0.

set_toggles_sensitive(sensitive)¶

Parameters:: sensitive (bool) – The new sensitive setting.

Sets the sensitive property of the self's toggles.

This function has no effect if this self instance has no toggles to switch channels.

set_toggles_visible(visible)¶

Parameters:: visible (bool) – The new visible setting.

Sets the visible property of the self's toggles.

This function has no effect if this self instance has no toggles to switch channels.

do_channel_changed(channel) virtual¶

Parameters:: channel (GimpUi.ColorSelectorChannel) –

do_color_changed(color) virtual¶

Parameters:: color (Gegl.Color) –

do_model_visible_changed(model, visible) virtual¶

Parameters:

model (GimpUi.ColorSelectorModel) –
visible (bool) –

do_set_channel(channel) virtual¶

Parameters:: channel (GimpUi.ColorSelectorChannel) – The new channel setting.

Sets the channel property of the selector widget.

Changes between displayed channels if this selector instance has the ability to show different channels. This will also update the color model if needed.

do_set_color(color) virtual¶

Parameters:: color (Gegl.Color) – The new color.

Sets the color shown in the selector widget.

do_set_config(config) virtual¶

Parameters:: config (Gimp.ColorConfig) – a Gimp.ColorConfig object.

Sets the color management configuration to use with this color selector.

New in version 2.4.

do_set_format(format) virtual¶

Parameters:: format (Babl.Object) – a Babl.Object format, with space.

Sets the babl format representing the color model and the space this selector is supposed to display values for. Depending on the type of color selector, it may trigger various UX changes, or none at all.

New in version 3.0.

do_set_model_visible(model, visible) virtual¶

Parameters:

model (GimpUi.ColorSelectorModel) – The affected GimpUi.ColorSelectorModel.
visible (bool) – The new visible setting.

Sets the model visible/invisible on the selector widget.

Toggles visibility of displayed models if this selector instance has the ability to show different color models.

New in version 2.10.

do_set_show_alpha(show_alpha) virtual¶

Parameters:: show_alpha (bool) – The new show_alpha setting.

Sets the show_alpha property of the selector widget.

do_set_simulation(profile, intent, bpc) virtual¶

Parameters:

profile (Gimp.ColorProfile) – a Gimp.ColorProfile object.
intent (Gimp.ColorRenderingIntent) – a Gimp.ColorRenderingIntent enum.
bpc (bool) – a bool.

Sets the simulation options to use with this color selector.

New in version 3.0.

do_set_toggles_sensitive(sensitive) virtual¶

Parameters:: sensitive (bool) – The new sensitive setting.

Sets the sensitive property of the selector's toggles.

This function has no effect if this selector instance has no toggles to switch channels.

do_set_toggles_visible(visible) virtual¶

Parameters:: visible (bool) – The new visible setting.

Sets the visible property of the selector's toggles.

This function has no effect if this selector instance has no toggles to switch channels.

do_simulation(enabled) virtual¶

Parameters:: enabled (bool) –

Signal Details¶

GimpUi.ColorSelector.signals.channel_changed(color_selector, object)¶

Signal Name:

channel-changed

Flags:

RUN_FIRST

Parameters:

color_selector (GimpUi.ColorSelector) – The object which received the signal
object (GimpUi.ColorSelectorChannel) –

GimpUi.ColorSelector.signals.color_changed(color_selector, object)¶

Signal Name:

color-changed

Flags:

RUN_FIRST

Parameters:

color_selector (GimpUi.ColorSelector) – The object which received the signal
object (Gegl.Color) –

GimpUi.ColorSelector.signals.model_visible_changed(color_selector, object, p0)¶

Signal Name:

model-visible-changed

Flags:

RUN_FIRST

Parameters:

color_selector (GimpUi.ColorSelector) – The object which received the signal
object (GimpUi.ColorSelectorModel) –
p0 (bool) –

GimpUi.ColorSelector.signals.simulation(color_selector, object)¶

Signal Name:

simulation

Flags:

RUN_FIRST

Parameters:

color_selector (GimpUi.ColorSelector) – The object which received the signal
object (bool) –