GimpCellRendererToggle: GIMP Widgets Library Reference Manual

## GimpCellRendererToggle GimpCellRendererToggle — A GtkCellRendererToggle that displays icons instead of a checkbox. |

## Functions

GtkCellRenderer * | gimp_cell_renderer_toggle_new ()
void | gimp_cell_renderer_toggle_clicked ()

## Properties

char * | icon-name | Read / Write / Construct
gboolean | override-background | Read / Write / Construct
char * | stock-id | Read / Write / Construct
int | stock-size | Read / Write / Construct

## Signals

void | clicked | Run Last

## Types and Values

| GimpCellRendererToggle

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkObject
                ╰── GtkCellRenderer
                    ╰── GtkCellRendererToggle
                        ╰── GimpCellRendererToggle

## Description

A GtkCellRendererToggle that displays icons instead of a checkbox.

## Functions

### gimp_cell_renderer_toggle_new ()

    GtkCellRenderer *
    gimp_cell_renderer_toggle_new (const gchar *icon_name);

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`.

#### Parameters

icon_name | the icon name of the icon to use for the active state |

#### Returns

a new GimpCellRendererToggle

Since: 2.2

### gimp_cell_renderer_toggle_clicked ()

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

Emits the "clicked" signal from a GimpCellRendererToggle.

#### Parameters

cell | a GimpCellRendererToggle |
path | the path to the clicked row |
state | the modifier state |

Since: 2.2

## Types and Values

### GimpCellRendererToggle

    typedef struct _GimpCellRendererToggle GimpCellRendererToggle;

## Property Details

### The `“icon-name”` property

      “icon-name”                char *

The icon to display.

Owner: GimpCellRendererToggle

Flags: Read / Write / Construct

Default value: NULL

### The `“override-background”` property

      “override-background”      gboolean

Draw the background if the row is selected.

Owner: GimpCellRendererToggle

Flags: Read / Write / Construct

Default value: FALSE

### The `“stock-id”` property

      “stock-id”                 char *

The icon to display, deprecated.

Owner: GimpCellRendererToggle

Flags: Read / Write / Construct

Default value: NULL

### The `“stock-size”` property

      “stock-size”               int

The icon size to use.

Owner: GimpCellRendererToggle

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 4

## Signal Details

### The `“clicked”` signal

    void
    user_function (GimpCellRendererToggle *gimpcellrenderertoggle,
                   char                   *arg1,
                   GdkModifierType         arg2,
                   gpointer                user_data)

Flags: Run Last