Struct gtk4::Switch

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

Switch is a “light switch” that has two states: on or off.

The user can control which state should be active by clicking the empty area, or by dragging the handle.

Switch can also handle situations where the underlying state changes with a delay. See signal::GtkSwitch::state-set for details.

CSS nodes

switch
├── label
├── label
╰── slider

Switch has four css nodes, the main node with the name switch and subnodes for the slider and the on and off labels. Neither of them is using any style classes.

Accessibility

Switch uses the AccessibleRole::Switch role.

Implements

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

Implementations

impl Switch

pub fn new() -> Switch

Creates a new Switch widget.

Returns

the newly created Switch instance

pub fn builder() -> SwitchBuilder

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

This method returns an instance of SwitchBuilder which can be used to create Switch objects.

pub fn is_active(&self) -> bool

Gets whether the Switch is in its “on” or “off” state.

Returns

true if the Switch is active, and false otherwise

pub fn state(&self) -> bool

Gets the underlying state of the Switch.

Returns

the underlying state

pub fn set_active(&self, is_active: bool)

Changes the state of @self to the desired one.

is_active

true if @self should be active, and false otherwise

pub fn set_state(&self, state: bool)

Sets the underlying state of the Switch.

Normally, this is the same as property::Switch::active, unless the switch is set up for delayed state changes. This function is typically called from a signal::Switch::state-set signal handler.

See signal::Switch::state-set for details.

state

the new state

pub fn connect_activate<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted to animate the switch.

Applications should never connect to this signal, but use the property::Switch::active property.

pub fn emit_activate(&self)

pub fn connect_state_set<F: Fn(&Self, bool) -> Inhibit + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted to change the underlying state.

The ::state-set signal is emitted when the user changes the switch position. The default handler keeps the state in sync with the property::Switch::active property.

To implement delayed state change, applications can connect to this signal, initiate the change of the underlying state, and call set_state() when the underlying state change is complete. The signal handler should return true to prevent the default handler from running.

Visually, the underlying state is represented by the trough color of the switch, while the property::Switch::active property is represented by the position of the switch.

state

the new state of the switch

Returns

true to stop the signal emission

pub fn connect_active_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_state_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Trait Implementations

impl Clone for Switch

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 Switch

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

Formats the value using the given formatter.

impl Default for Switch

fn default() -> Self

Returns the “default value” for a type.

impl Display for Switch

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

Formats the value using the given formatter.

impl Hash for Switch

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 Ord for Switch

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 Switch

type Parent = Widget

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

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 Switch

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 Switch

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Switch

impl IsA<Accessible> for Switch

impl IsA<Actionable> for Switch

impl IsA<Buildable> for Switch

impl IsA<ConstraintTarget> for Switch

impl IsA<Widget> for Switch