GtkToggleButton

## GtkToggleButton GtkToggleButton — Create buttons which retain their state |

## Includes

    #include <gtk/gtk.h>

## Description

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 GtkPixmap), 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.

Example 9. Creating two GtkToggleButton widgets.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    void make_toggles (void) {
       GtkWidget *dialog, *toggle1, *toggle2;
       dialog = gtk_dialog_new ();
       toggle1 = gtk_toggle_button_new_with_label ("Hi, i'm a toggle button.");
       /* 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_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->action_area),
                           toggle1, FALSE, FALSE, 2);
       toggle2 = gtk_toggle_button_new_with_label ("Hi, i'm another toggle button.");
       gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle2), FALSE);
       g_signal_connect (toggle2, "toggled",
                         G_CALLBACK (output_state), NULL);
       gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->action_area),
                           toggle2, FALSE, FALSE, 2);
       gtk_widget_show_all (dialog);
    }

## Functions

## Types and Values

## See Also

GtkButton | a more general button.
GtkCheckButton | another way of presenting a toggle option.
GtkCheckMenuItem | a GtkToggleButton as a menu item.