Class

GtkCellRendererToggle

Description [src]

class Gtk.CellRendererToggle : Gtk.CellRenderer {
  parent: GtkCellRenderer
}

GtkCellRendererToggle renders a toggle button in a cell. The button is drawn as a radio or a checkbutton, depending on the GtkCellRendererToggle:radio property. When activated, it emits the GtkCellRendererToggle::toggled signal.

Hierarchy

hierarchy this GtkCellRendererToggle ancestor_0 GtkCellRenderer ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Constructors

gtk_cell_renderer_toggle_new

Creates a new GtkCellRendererToggle. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with GtkTreeViewColumn, you can bind a property to a value in a GtkTreeModel. For example, you can bind the “active” property on the cell renderer to a boolean value in the model, thus causing the check button to reflect the state of the model.

Instance methods

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 (42)

Please see GObject for a full list of methods.

Properties

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

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 GtkCellRendererToggleClass {
  GtkCellRendererClass parent_class;
  void (* toggled) (
    GtkCellRendererToggle* cell_renderer_toggle,
    const gchar* path
  );
  void (* _gtk_reserved1) (
void
  );
  void (* _gtk_reserved2) (
void
  );
  void (* _gtk_reserved3) (
void
  );
  void (* _gtk_reserved4) (
void
  );
  
}
Class members
parent_class
GtkCellRendererClass
  No description available.
toggled
void (* toggled) (
    GtkCellRendererToggle* cell_renderer_toggle,
    const gchar* path
  )
  No description available.
_gtk_reserved1
void (* _gtk_reserved1) (
void
  )
  No description available.
_gtk_reserved2
void (* _gtk_reserved2) (
void
  )
  No description available.
_gtk_reserved3
void (* _gtk_reserved3) (
void
  )
  No description available.
_gtk_reserved4
void (* _gtk_reserved4) (
void
  )
  No description available.

Virtual methods

Gtk.CellRendererToggleClass.toggled
No description available.