GtkToggleButton — Create buttons which retain their state
GtkWidget * | gtk_toggle_button_new () |
GtkWidget * | gtk_toggle_button_new_with_label () |
GtkWidget * | gtk_toggle_button_new_with_mnemonic () |
void | gtk_toggle_button_set_mode () |
gboolean | gtk_toggle_button_get_mode () |
void | gtk_toggle_button_toggled () |
gboolean | gtk_toggle_button_get_active () |
void | gtk_toggle_button_set_active () |
gboolean | gtk_toggle_button_get_inconsistent () |
void | gtk_toggle_button_set_inconsistent () |
gboolean | active | Read / Write |
gboolean | draw-indicator | Read / Write |
gboolean | inconsistent | Read / Write |
void | toggled | Run First |
struct | GtkToggleButton |
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkBin ╰── GtkButton ╰── GtkToggleButton ├── GtkCheckButton ╰── GtkMenuButton
GtkToggleButton implements AtkImplementorIface, GtkBuildable, GtkActionable and GtkActivatable.
#include <gtk/gtk.h>
A GtkToggleButton is a GtkButton which will remain “pressed-in” when clicked. Clicking again will cause the toggle button to return to its normal state.
A toggle button is created by calling either gtk_toggle_button_new()
or gtk_toggle_button_new_with_label()
. If using the former, it is advisable to pack a widget, (such as a GtkLabel and/or a GtkImage), into the toggle button’s container. (See GtkButton for more information).
The state of a GtkToggleButton can be set specifically using gtk_toggle_button_set_active()
, and retrieved using gtk_toggle_button_get_active()
.
To simply switch the state of a toggle button, use gtk_toggle_button_toggled()
.
GtkToggleButton has a single CSS node with name button. To differentiate it from a plain GtkButton, it gets the .toggle style class.
static void output_state (GtkToggleButton *source, gpointer user_data) { printf ("Active: %d\n", gtk_toggle_button_get_active (source)); } void make_toggles (void) { GtkWidget *window, *toggle1, *toggle2; GtkWidget *box; const char *text; window = gtk_window_new (GTK_WINDOW_TOPLEVEL); box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 12); text = "Hi, I’m a toggle button."; toggle1 = gtk_toggle_button_new_with_label (text); // Makes this toggle button invisible gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle1), TRUE); g_signal_connect (toggle1, "toggled", G_CALLBACK (output_state), NULL); gtk_container_add (GTK_CONTAINER (box), toggle1); text = "Hi, I’m a toggle button."; toggle2 = gtk_toggle_button_new_with_label (text); gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle2), FALSE); g_signal_connect (toggle2, "toggled", G_CALLBACK (output_state), NULL); gtk_container_add (GTK_CONTAINER (box), toggle2); gtk_container_add (GTK_CONTAINER (window), box); gtk_widget_show_all (window); }
GtkWidget *
gtk_toggle_button_new (void
);
Creates a new toggle button. A widget should be packed into the button, as in gtk_button_new()
.
a new toggle button.
GtkWidget *
gtk_toggle_button_new_with_label (const gchar *label
);
Creates a new toggle button with a text label.
label | a string containing the message to be placed in the toggle button. |
a new toggle button.
GtkWidget *
gtk_toggle_button_new_with_mnemonic (const gchar *label
);
Creates a new GtkToggleButton containing a label. The label will be created using gtk_label_new_with_mnemonic()
, so underscores in label
indicate the mnemonic for the button.
label | the text of the button, with an underscore in front of the mnemonic character |
a new GtkToggleButton
void gtk_toggle_button_set_mode (GtkToggleButton *toggle_button
,gboolean draw_indicator
);
Sets whether the button is displayed as a separate indicator and label. You can call this function on a checkbutton or a radiobutton with draw_indicator
= FALSE
to make the button look like a normal button.
This can be used to create linked strip of buttons that work like a GtkStackSwitcher.
This function only affects instances of classes like GtkCheckButton and GtkRadioButton that derive from GtkToggleButton, not instances of GtkToggleButton itself.
toggle_button | ||
draw_indicator | if |
gboolean
gtk_toggle_button_get_mode (GtkToggleButton *toggle_button
);
Retrieves whether the button is displayed as a separate indicator and label. See gtk_toggle_button_set_mode()
.
toggle_button |
TRUE
if the togglebutton is drawn as a separate indicator and label.
void
gtk_toggle_button_toggled (GtkToggleButton *toggle_button
);
Emits the “toggled” signal on the GtkToggleButton. There is no good reason for an application ever to call this function.
toggle_button |
gboolean
gtk_toggle_button_get_active (GtkToggleButton *toggle_button
);
Queries a GtkToggleButton and returns its current state. Returns TRUE
if the toggle button is pressed in and FALSE
if it is raised.
toggle_button |
a gboolean value.
void gtk_toggle_button_set_active (GtkToggleButton *toggle_button
,gboolean is_active
);
Sets the status of the toggle button. Set to TRUE
if you want the GtkToggleButton to be “pressed in”, and FALSE
to raise it. This action causes the “toggled” signal and the “clicked” signal to be emitted.
toggle_button | ||
is_active |
|
gboolean
gtk_toggle_button_get_inconsistent (GtkToggleButton *toggle_button
);
Gets the value set by gtk_toggle_button_set_inconsistent()
.
toggle_button |
TRUE
if the button is displayed as inconsistent, FALSE
otherwise
void gtk_toggle_button_set_inconsistent (GtkToggleButton *toggle_button
,gboolean setting
);
If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button, and the current values in that range are inconsistent, you may want to display the toggle in an “in between” state. This function turns on “in between” display. Normally you would turn off the inconsistent state again if the user toggles the toggle button. This has to be done manually, gtk_toggle_button_set_inconsistent()
only affects visual appearance, it doesn’t affect the semantics of the button.
toggle_button | ||
setting |
|
struct GtkToggleButton;
“active”
property“active” gboolean
If the toggle button should be pressed in.
Owner: GtkToggleButton
Flags: Read / Write
Default value: FALSE
“draw-indicator”
property“draw-indicator” gboolean
If the toggle part of the button is displayed.
Owner: GtkToggleButton
Flags: Read / Write
Default value: FALSE
“inconsistent”
property“inconsistent” gboolean
If the toggle button is in an "in between" state.
Owner: GtkToggleButton
Flags: Read / Write
Default value: FALSE
“toggled”
signalvoid user_function (GtkToggleButton *togglebutton, gpointer user_data)
Should be connected if you wish to perform an action whenever the GtkToggleButton's state is changed.
togglebutton | the object which received the signal. | |
user_data | user data set when the signal handler was connected. |
Flags: Run First
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.24/GtkToggleButton.html