Struct gtk::ToggleButton

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

A ToggleButton is a Button 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 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().

CSS nodes

GtkToggleButton 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) {
  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);
}

Implements

ToggleButtonExt, ButtonExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, ActionableExt, ContainerExtManual, WidgetExtManual, BuildableExtManual

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.

const 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,

Feeds a slice of this type into the given Hasher.

impl Ord for ToggleButton

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

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: 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 ==.

const 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.

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

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

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

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

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

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

const 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<Actionable> for ToggleButton

impl IsA<Bin> for ToggleButton

impl IsA<Buildable> for ToggleButton

impl IsA<Button> for ToggleButton

impl IsA<Container> for ToggleButton

impl IsA<ToggleButton> for CheckButton

impl IsA<ToggleButton> for MenuButton

impl IsA<ToggleButton> for RadioButton

impl IsA<Widget> for ToggleButton