Class

GtkToggleButton

Description [src]

class Gtk.ToggleButton : Gtk.Button {
  /* No available fields */
}

A GtkToggleButton is a button which remains “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().

Grouping

Toggle buttons can be grouped together, to form mutually exclusive groups - only one of the buttons can be toggled at a time, and toggling another one will switch the currently toggled one off.

To add a GtkToggleButton to a group, use gtk_toggle_button_set_group().

CSS nodes

GtkToggleButton has a single CSS node with name button. To differentiate it from a plain GtkButton, it gets the .toggle style class.

Creating two `GtkToggleButton` widgets.

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 ();
  box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 12);

  text = "Hi, I’m a toggle button.";
  toggle1 = gtk_toggle_button_new_with_label (text);

  g_signal_connect (toggle1, "toggled",
                    G_CALLBACK (output_state),
                    NULL);
  gtk_box_append (GTK_BOX (box), toggle1);

  text = "Hi, I’m a toggle button.";
  toggle2 = gtk_toggle_button_new_with_label (text);
  g_signal_connect (toggle2, "toggled",
                    G_CALLBACK (output_state),
                    NULL);
  gtk_box_append (GTK_BOX (box), toggle2);

  gtk_window_set_child (GTK_WINDOW (window), box);
  gtk_widget_show (window);
}

Hierarchy

Ancestors

GtkButton
GtkWidget
GInitiallyUnowned
GObject

Implements

Constructors

gtk_toggle_button_new

Creates a new toggle button.

gtk_toggle_button_new_with_label

Creates a new toggle button with a text label.

gtk_toggle_button_new_with_mnemonic

Creates a new GtkToggleButton containing a label.

Instance methods

gtk_toggle_button_get_active

Queries a GtkToggleButton and returns its current state.

gtk_toggle_button_set_active

Sets the status of the toggle button.

gtk_toggle_button_set_group

Adds self to the group of group.

gtk_toggle_button_toggled

Emits the ::toggled signal on the GtkToggleButton.

Methods inherited from GtkButton (10)

gtk_button_get_child

Gets the child widget of button.

gtk_button_get_has_frame

Returns whether the button has a frame.

gtk_button_get_icon_name

Returns the icon name of the button.

gtk_button_get_label

Fetches the text from the label of the button.

gtk_button_get_use_underline

Gets whether underlines are interpreted as mnemonics.

gtk_button_set_child

Sets the child widget of button.

gtk_button_set_has_frame

Sets the style of the button.

gtk_button_set_icon_name

Adds a GtkImage with the given icon name as a child.

gtk_button_set_label

Sets the text of the label of the button to label.

gtk_button_set_use_underline

Sets whether to use underlines as mnemonics.

Methods inherited from GtkWidget (159)

gtk_widget_action_set_enabled

Enable or disable an action installed with gtk_widget_class_install_action().

gtk_widget_activate

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

gtk_widget_activate_action

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_action_variant

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_default

Activates the default.activate action from widget.

gtk_widget_add_controller

Adds controller to widget so that it will receive events.

gtk_widget_add_css_class

Adds a style class to widget.

gtk_widget_add_mnemonic_label

Adds a widget to the list of mnemonic labels for this widget.

gtk_widget_add_tick_callback

Queues an animation frame update and adds a callback to be called before each frame.

gtk_widget_allocate

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

gtk_widget_child_focus

Called by widgets as the user moves around the window using keyboard shortcuts.

gtk_widget_compute_bounds

Computes the bounds for widget in the coordinate space of target.

gtk_widget_compute_expand

Computes whether a container should give this widget extra space when possible.

gtk_widget_compute_point

Translates the given point in widget‘s coordinates to coordinates relative to target’s coordinate system.

gtk_widget_compute_transform

Computes a matrix suitable to describe a transformation from widget‘s coordinate system into target‘s coordinate system.

gtk_widget_contains

Tests if the point at (x, y) is contained in widget.

gtk_widget_create_pango_context

Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.

gtk_widget_create_pango_layout

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

gtk_drag_check_threshold

Checks to see if a drag movement has passed the GTK drag threshold.

gtk_widget_error_bell

Notifies the user about an input-related error on this widget.

gtk_widget_get_allocated_baseline

Returns the baseline that has currently been allocated to widget.

gtk_widget_get_allocated_height

Returns the height that has currently been allocated to widget.

gtk_widget_get_allocated_width

Returns the width that has currently been allocated to widget.

Methods inherited from GtkBuildable (1)

gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Properties

Gtk.ToggleButton:active

If the toggle button should be pressed in.

Gtk.ToggleButton:group

The toggle button whose group this widget belongs to.

Properties inherited from GtkAccessible (1)

Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkActionable (2)

Gtk.Actionable:action-name

No description available.

Gtk.Actionable:action-target

No description available.

Signals

Gtk.ToggleButton::toggled

Emitted whenever the GtkToggleButton‘s state is changed.

Signals inherited from GtkButton (2)

Gtk.Button::activate

Emitted to animate press then release.

Gtk.Button::clicked

Emitted when the button has been activated (pressed and released).

Class structure

struct GtkToggleButtonClass {
  GtkButtonClass parent_class;
  void (* toggled) (
    GtkToggleButton* toggle_button
  );
  
}

Class members

`parent_class`	`GtkButtonClass`
	No description available.
`toggled`	`void (* toggled) ( GtkToggleButton* toggle_button )`
	No description available.

Virtual methods

Gtk.ToggleButtonClass.toggled