GtkCellRendererToggle — Renders a toggle button in a cell
GtkCellRenderer * | gtk_cell_renderer_toggle_new () |
gboolean | gtk_cell_renderer_toggle_get_radio () |
void | gtk_cell_renderer_toggle_set_radio () |
gboolean | gtk_cell_renderer_toggle_get_active () |
void | gtk_cell_renderer_toggle_set_active () |
gboolean | gtk_cell_renderer_toggle_get_activatable () |
void | gtk_cell_renderer_toggle_set_activatable () |
gboolean | activatable | Read / Write |
gboolean | active | Read / Write |
gboolean | inconsistent | Read / Write |
gboolean | radio | Read / Write |
void | toggled | Run Last |
GObject ╰── GInitiallyUnowned ╰── GtkCellRenderer ╰── GtkCellRendererToggle
#include <gtk/gtk.h>
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.
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.
the new cell renderer
gboolean
gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle
);
Returns whether we’re rendering radio toggles rather than checkboxes.
toggle |
TRUE
if we’re rendering radio toggles rather than checkboxes
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).
toggle | ||
radio |
|
gboolean
gtk_cell_renderer_toggle_get_active (GtkCellRendererToggle *toggle
);
Returns whether the cell renderer is active. See gtk_cell_renderer_toggle_set_active()
.
toggle |
TRUE
if the cell renderer is active.
void gtk_cell_renderer_toggle_set_active (GtkCellRendererToggle *toggle
,gboolean setting
);
Activates or deactivates a cell renderer.
toggle | ||
setting | the value to set. |
gboolean
gtk_cell_renderer_toggle_get_activatable
(GtkCellRendererToggle *toggle
);
Returns whether the cell renderer is activatable. See gtk_cell_renderer_toggle_set_activatable()
.
toggle |
TRUE
if the cell renderer is activatable.
void gtk_cell_renderer_toggle_set_activatable (GtkCellRendererToggle *toggle
,gboolean setting
);
Makes the cell renderer activatable.
toggle | ||
setting | the value to set. |
typedef struct _GtkCellRendererToggle GtkCellRendererToggle;
“activatable”
property“activatable” gboolean
The toggle button can be activated.
Owner: GtkCellRendererToggle
Flags: Read / Write
Default value: TRUE
“active”
property“active” gboolean
The toggle state of the button.
Owner: GtkCellRendererToggle
Flags: Read / Write
Default value: FALSE
“inconsistent”
property“inconsistent” gboolean
The inconsistent state of the button.
Owner: GtkCellRendererToggle
Flags: Read / Write
Default value: FALSE
“radio”
property“radio” gboolean
Draw the toggle button as a radio button.
Owner: GtkCellRendererToggle
Flags: Read / Write
Default value: FALSE
“toggled”
signalvoid user_function (GtkCellRendererToggle *cell_renderer, char *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
.
cell_renderer | the object which received the signal | |
path | string representation of GtkTreePath describing the event location | |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk4/4.0/GtkCellRendererToggle.html