GtkCellRendererToggle
GtkCellRendererToggle — Renders a toggle button in a cell
|
|
Includes
#include <gtk/gtk.h>
Description
GtkCellRendererToggle renders a toggle button in a cell. The
button is drawn as a radio or a checkbutton, depending on the
“radio” property.
When activated, it emits the “toggled” signal.
Functions
gtk_cell_renderer_toggle_new ()
GtkCellRenderer *
gtk_cell_renderer_toggle_new (void);
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.
Returns
the new cell renderer
gtk_cell_renderer_toggle_get_radio ()
gboolean
gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle);
Returns whether we’re rendering radio toggles rather than checkboxes.
Returns
TRUE if we’re rendering radio toggles rather than checkboxes
gtk_cell_renderer_toggle_set_radio ()
void
gtk_cell_renderer_toggle_set_radio (GtkCellRendererToggle *toggle,
gboolean 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).
gtk_cell_renderer_toggle_set_active ()
void
gtk_cell_renderer_toggle_set_active (GtkCellRendererToggle *toggle,
gboolean setting);
Activates or deactivates a cell renderer.
gtk_cell_renderer_toggle_set_activatable ()
void
gtk_cell_renderer_toggle_set_activatable
(GtkCellRendererToggle *toggle,
gboolean setting);
Makes the cell renderer activatable.
Since: 2.18
Types and Values
struct GtkCellRendererToggle
struct GtkCellRendererToggle;
Property Details
The “activatable” property
“activatable” gboolean
The toggle button can be activated.
Owner: GtkCellRendererToggle
Flags: Read / Write
Default value: TRUE
The “active” property
“active” gboolean
The toggle state of the button.
Owner: GtkCellRendererToggle
Flags: Read / Write
Default value: FALSE
The “inconsistent” property
“inconsistent” gboolean
The inconsistent state of the button.
Owner: GtkCellRendererToggle
Flags: Read / Write
Default value: FALSE
The “indicator-size” property
“indicator-size” gint
Size of check or radio indicator.
Owner: GtkCellRendererToggle
Flags: Read / Write
Allowed values: >= 0
Default value: 0
The “radio” property
“radio” gboolean
Draw the toggle button as a radio button.
Owner: GtkCellRendererToggle
Flags: Read / Write
Default value: FALSE
Signal Details
The “toggled” signal
void
user_function (GtkCellRendererToggle *cell_renderer,
gchar *path,
gpointer user_data)
The ::toggled signal is emitted when the cell is toggled.
It is the responsibility of the application to update the model
with the correct value to store at path
. Often this is simply the
opposite of the value currently stored at path
.
Flags: Run Last