GimpUi.ColorDisplay¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gimp.ConfigInterface (14)
Structs:: GObject.ObjectClass (5)

	`changed` ()
	`clone` ()
	`configure` ()
	`configure_reset` ()
	`convert_buffer` (buffer, area)
	`get_config` ()
	`get_enabled` ()
	`get_managed` ()
	`load_state` (state)
	`save_state` ()
	`set_enabled` (enabled)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_changed` ()
	`do_configure` ()
	`do_convert_buffer` (buffer, area)

Properties¶

Name	Type	Flags	Short Description
`color-config`	`Gimp.ColorConfig`	r/w/co	The color config used for this filter
`color-managed`	`Gimp.ColorManaged`	r/w/co	The color managed pixel source that is filtered
`enabled`	`bool`	r/w/c	Whether this display filter is enabled

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`changed`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class GimpUi.ColorDisplay(**kwargs)¶

Bases:: GObject.Object, Gimp.ConfigInterface
Abstract:: Yes
Structure:: GimpUi.ColorDisplayClass

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

changed()¶

clone()¶

Returns:: a duplicate of self.
Return type:: GimpUi.ColorDisplay

Creates a copy of self.

New in version 2.0.

configure()¶

Returns:: a new configuration widget for self, or None if no specific widget exists.
Return type:: Gtk.Widget

Creates a configuration widget for self which can be added to a container widget.

New in version 2.0.

configure_reset()¶

convert_buffer(buffer, area)¶

Parameters:

buffer (Gegl.Buffer) – a Gegl.Buffer
area (Gegl.Rectangle) – area in buffer to convert

Converts all pixels in area of buffer.

New in version 2.10.

get_config()¶

Returns:: a pointer to the Gimp.ColorConfig object or None.
Return type:: Gimp.ColorConfig

New in version 2.4.

get_enabled()¶

Return type:: bool

get_managed()¶

Returns:: a pointer to the Gimp.ColorManaged object or None.
Return type:: Gimp.ColorManaged

New in version 2.4.

load_state(state)¶

Parameters:: state (Gimp.Parasite) – a Gimp.Parasite

Configures self from the contents of the parasite state. state must be a properly serialized configuration for a GimpUi.ColorDisplay, such as saved by GimpUi.ColorDisplay.save_state().

New in version 2.0.

save_state()¶

Returns:: a Gimp.Parasite
Return type:: Gimp.Parasite

Saves the configuration state of self as a new parasite.

New in version 2.0.

set_enabled(enabled)¶

Parameters:: enabled (bool) –

do_changed() virtual¶

do_configure() virtual¶

Returns:: a new configuration widget for display, or None if no specific widget exists.
Return type:: Gtk.Widget

Creates a configuration widget for display which can be added to a container widget.

New in version 2.0.

do_convert_buffer(buffer, area) virtual¶

Parameters:

buffer (Gegl.Buffer) – a Gegl.Buffer
area (Gegl.Rectangle) – area in buffer to convert

Converts all pixels in area of buffer.

New in version 2.10.

Signal Details¶

GimpUi.ColorDisplay.signals.changed(color_display)¶

Signal Name:: changed
Flags:: RUN_FIRST
Parameters:: color_display (GimpUi.ColorDisplay) – The object which received the signal

Property Details¶

GimpUi.ColorDisplay.props.color_config¶

Name:: color-config
Type:: Gimp.ColorConfig
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The color config used for this filter

GimpUi.ColorDisplay.props.color_managed¶

Name:: color-managed
Type:: Gimp.ColorManaged
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The color managed pixel source that is filtered

GimpUi.ColorDisplay.props.enabled¶

Name:: enabled
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, CONSTRUCT

Whether this display filter is enabled