GimpUi.CellRendererToggle¶

Subclasses:: None

Methods¶

Inherited:: Gtk.CellRendererToggle (7), Gtk.CellRenderer (25), GObject.Object (37)
Structs:: Gtk.CellRendererClass (1), GObject.ObjectClass (5)

class	`new` (icon_name)
	`clicked` (path, state)

Virtual Methods¶

Inherited:: Gtk.CellRendererToggle (1), Gtk.CellRenderer (12), GObject.Object (7)

Properties¶

Inherited:: Gtk.CellRendererToggle (5), Gtk.CellRenderer (16)

Name	Type	Flags	Short Description
`icon-name`	`str`	r/w/c	The icon to display
`icon-size`	`int`	r/w/c	The desired icon size to use in pixel (before applying scaling factor)
`override-background`	`bool`	r/w/c	Draw the background if the row is selected

Signals¶

Inherited:: Gtk.CellRendererToggle (1), Gtk.CellRenderer (2), GObject.Object (1)

Name	Short Description
`clicked`

Fields¶

Inherited:: Gtk.CellRendererToggle (1), Gtk.CellRenderer (2), GObject.Object (1)

Class Details¶

class GimpUi.CellRendererToggle(**kwargs)¶

Bases:: Gtk.CellRendererToggle
Abstract:: No
Structure:: GimpUi.CellRendererToggleClass

A Gtk.CellRendererToggle that displays icons instead of a checkbox.

classmethod new(icon_name)¶

Parameters:: icon_name (str) – the icon name of the icon to use for the active state
Returns:: a new GimpUi.CellRendererToggle
Return type:: Gtk.CellRenderer

Creates a custom version of the Gtk.CellRendererToggle. Instead of showing the standard toggle button, it shows a named icon if the cell is active and no icon otherwise. This cell renderer is for example used in the Layers treeview to indicate and control the layer’s visibility by showing %GIMP_STOCK_VISIBLE.

New in version 2.2.

clicked(path, state)¶

Parameters:

path (str) – the path to the clicked row
state (Gdk.ModifierType) – the modifier state

Emits the “clicked” signal from a GimpUi.CellRendererToggle.

New in version 2.2.

Signal Details¶

GimpUi.CellRendererToggle.signals.clicked(cell_renderer_toggle, object, p0)¶

Signal Name:

clicked

Flags:

RUN_LAST

Parameters:

cell_renderer_toggle (GimpUi.CellRendererToggle) – The object which received the signal
object (str) –
p0 (Gdk.ModifierType) –

Property Details¶

GimpUi.CellRendererToggle.props.icon_name¶

Name:: icon-name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

The icon to display

GimpUi.CellRendererToggle.props.icon_size¶

Name:: icon-size
Type:: int
Default Value:: 16
Flags:: READABLE, WRITABLE, CONSTRUCT

The desired icon size to use in pixel (before applying scaling factor)

GimpUi.CellRendererToggle.props.override_background¶

Name:: override-background
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

Draw the background if the row is selected