### Class

# GimpUi CellRendererToggle

#### Description [src]

    class GimpUi.CellRendererToggle : Gtk.CellRendererToggle {
      parent_instance: GtkCellRendererToggle,
      priv: GimpCellRendererTogglePrivate*
    }

A `GtkCellRendererToggle` that displays icons instead of a checkbox.

#### Ancestors

- GtkCellRendererToggle
- GtkCellRenderer
- GInitiallyUnowned
- GObject

#### Constructors

###### gimp_cell_renderer_toggle_new

Creates a custom version of the `GtkCellRendererToggle`. 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`.

Available since: 2.2

#### Instance methods

###### gimp_cell_renderer_toggle_clicked

Emits the “clicked” signal from a `GimpCellRendererToggle`.

Available since: 2.2

##### Methods inherited from GtkCellRendererToggle (6)

###### gtk_cell_renderer_toggle_get_activatable

Returns whether the cell renderer is activatable. See gtk_cell_renderer_toggle_set_activatable().

Available since: 2.18

###### gtk_cell_renderer_toggle_get_active

Returns whether the cell renderer is active. See gtk_cell_renderer_toggle_set_active().

###### gtk_cell_renderer_toggle_get_radio

Returns whether we’re rendering radio toggles rather than checkboxes.

###### gtk_cell_renderer_toggle_set_activatable

Makes the cell renderer activatable.

Available since: 2.18

###### gtk_cell_renderer_toggle_set_active

Activates or deactivates a cell renderer.

###### gtk_cell_renderer_toggle_set_radio

If `radio` is `TRUE`, the cell renderer renders a radio toggle (i.e. a toggle in a group of mutually-exclusive toggles). If `FALSE`, it renders a check toggle (a standalone boolean option). This can be set globally for the cell renderer, or changed just before rendering each cell in the model (for `GtkTreeView`, you set up a per-row setting using `GtkTreeViewColumn` to associate model columns with cell renderer properties).

##### Methods inherited from GtkCellRenderer (24)

Please see GtkCellRenderer for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Properties

###### GimpUi.CellRendererToggle:icon-name

No description available.

###### GimpUi.CellRendererToggle:icon-size

No description available.

###### GimpUi.CellRendererToggle:override-background

No description available.

##### Properties inherited from GtkCellRendererToggle (5)

###### Gtk.CellRendererToggle:activatable

No description available.

###### Gtk.CellRendererToggle:active

No description available.

###### Gtk.CellRendererToggle:inconsistent

No description available.

###### Gtk.CellRendererToggle:indicator-size

No description available.

###### Gtk.CellRendererToggle:radio

No description available.

##### Properties inherited from GtkCellRenderer (16)

###### Gtk.CellRenderer:cell-background

No description available.

###### Gtk.CellRenderer:cell-background-gdk

Cell background as a `GdkColor`.

Deprecated since: 3.4

###### Gtk.CellRenderer:cell-background-rgba

Cell background as a `GdkRGBA`.

Available since: 3.0

###### Gtk.CellRenderer:cell-background-set

No description available.

###### Gtk.CellRenderer:editing

No description available.

###### Gtk.CellRenderer:height

No description available.

###### Gtk.CellRenderer:is-expanded

No description available.

###### Gtk.CellRenderer:is-expander

No description available.

###### Gtk.CellRenderer:mode

No description available.

###### Gtk.CellRenderer:sensitive

No description available.

###### Gtk.CellRenderer:visible

No description available.

###### Gtk.CellRenderer:width

No description available.

###### Gtk.CellRenderer:xalign

No description available.

###### Gtk.CellRenderer:xpad

No description available.

###### Gtk.CellRenderer:yalign

No description available.

###### Gtk.CellRenderer:ypad

No description available.

#### Signals

###### GimpUi.CellRendererToggle::clicked

No description available.

##### Signals inherited from GtkCellRendererToggle (1)

###### Gtk.CellRendererToggle::toggled

The ::toggled signal is emitted when the cell is toggled.

##### Signals inherited from GtkCellRenderer (2)

###### Gtk.CellRenderer::editing-canceled

This signal gets emitted when the user cancels the process of editing a cell. For example, an editable cell renderer could be written to cancel editing when the user presses Escape.

Available since: 2.4

###### Gtk.CellRenderer::editing-started

This signal gets emitted when a cell starts to be edited. The intended use of this signal is to do special setup on `editable`, e.g. adding a `GtkEntryCompletion` or setting up additional columns in a `GtkComboBox`.

Available since: 2.6

##### Signals inherited from GObject (1)

###### GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct GimpUiCellRendererToggleClass {
      GtkCellRendererToggleClass parent_class;
      void (* clicked) (
        GimpCellRendererToggle* cell,
        const gchar* path,
        GdkModifierType state
      );
      void (* _gimp_reserved1) (
    void
      );
      void (* _gimp_reserved2) (
    void
      );
      void (* _gimp_reserved3) (
    void
      );
      void (* _gimp_reserved4) (
    void
      );
      void (* _gimp_reserved5) (
    void
      );
      void (* _gimp_reserved6) (
    void
      );
      void (* _gimp_reserved7) (
    void
      );
      void (* _gimp_reserved8) (
    void
      );

    }

###### Class members

`parent_class`

    GtkCellRendererToggleClass

| No description available.

`clicked`

    void (* clicked) (
        GimpCellRendererToggle* cell,
        const gchar* path,
        GdkModifierType state
      )

| No description available.

`_gimp_reserved1`

    void (* _gimp_reserved1) (
    void
      )

| No description available.

`_gimp_reserved2`

    void (* _gimp_reserved2) (
    void
      )

| No description available.

`_gimp_reserved3`

    void (* _gimp_reserved3) (
    void
      )

| No description available.

`_gimp_reserved4`

    void (* _gimp_reserved4) (
    void
      )

| No description available.

`_gimp_reserved5`

    void (* _gimp_reserved5) (
    void
      )

| No description available.

`_gimp_reserved6`

    void (* _gimp_reserved6) (
    void
      )

| No description available.

`_gimp_reserved7`

    void (* _gimp_reserved7) (
    void
      )

| No description available.

`_gimp_reserved8`

    void (* _gimp_reserved8) (
    void
      )

| No description available.

#### Virtual methods

###### GimpUi.CellRendererToggleClass.clicked

Emits the “clicked” signal from a `GimpCellRendererToggle`.

Available since: 2.2