Struct gtk4::ToggleButton

#[repr(transparent)]
pub struct ToggleButton { /* private fields */ }

A ToggleButton 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 new() or with_label(). If using the former, it is advisable to pack a widget, (such as a Label and/or a Image), into the toggle button’s container. (See Button for more information).

The state of a ToggleButton can be set specifically using ToggleButtonExt::set_active(), and retrieved using ToggleButtonExt::is_active().

To simply switch the state of a toggle button, use ToggleButtonExt::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 ToggleButton to a group, use ToggleButtonExt::set_group().

CSS nodes

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

Creating two ToggleButton widgets.

⚠️ The following code is in c ⚠️

static void
output_state (GtkToggleButton *source,
              gpointer         user_data)
{
  g_print ("Toggle button "%s" is active: %s",
           gtk_button_get_label (GTK_BUTTON (source)),
           gtk_toggle_button_get_active (source) ? "Yes" : "No");
}

static 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 toggle button one";
  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 toggle button two";
  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);
}

Implements

ToggleButtonExt, ButtonExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, ActionableExt, WidgetExtManual, AccessibleExtManual, ActionableExtManual

Implementations

impl ToggleButton

pub const NONE: Option<&'static ToggleButton> = None

pub fn new() -> ToggleButton

Creates a new toggle button.

A widget should be packed into the button, as in Button::new().

Returns

a new toggle button.

pub fn with_label(label: &str) -> ToggleButton

Creates a new toggle button with a text label.

label

a string containing the message to be placed in the toggle button.

Returns

a new toggle button.

pub fn with_mnemonic(label: &str) -> ToggleButton

Creates a new ToggleButton containing a label.

The label will be created using Label::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

Returns

a new ToggleButton

pub fn builder() -> ToggleButtonBuilder

Creates a new builder-pattern struct instance to construct ToggleButton objects.

This method returns an instance of ToggleButtonBuilder which can be used to create ToggleButton objects.

Trait Implementations

impl Clone for ToggleButton

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToggleButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ToggleButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for ToggleButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for ToggleButton

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: ToggleButtonImpl> IsSubclassable<T> for ToggleButton

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for ToggleButton

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for ToggleButton

type Parent = Button

impl<OT: ObjectType> PartialEq<OT> for ToggleButton

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ToggleButton

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ToggleButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ToggleButton

impl IsA<Accessible> for ToggleButton

impl IsA<Actionable> for ToggleButton

impl IsA<Buildable> for ToggleButton

impl IsA<Button> for ToggleButton

impl IsA<ConstraintTarget> for ToggleButton

impl IsA<Widget> for ToggleButton