Struct gtk4::CheckButton

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

A CheckButton places a label next to an indicator.

A CheckButton is created by calling either new() or with_label().

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

Inconsistent state

In addition to “on” and “off”, check buttons can be an “in between” state that is neither on nor off. This can be used e.g. when the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a check button, and the current values in that range are inconsistent.

To set a CheckButton to inconsistent state, use CheckButtonExt::set_inconsistent().

Grouping

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

Grouped check buttons use a different indicator, and are commonly referred to as radio buttons.

To add a CheckButton to a group, use CheckButtonExt::set_group().

CSS nodes

checkbutton[.text-button]
├── check
╰── [label]

A CheckButton has a main node with name checkbutton. If the property::CheckButton::label property is set, it contains a label child. The indicator node is named check when no group is set, and radio if the checkbutton is grouped together with other checkbuttons.

Accessibility

CheckButton uses the AccessibleRole::Checkbox role.

Implements

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

Implementations

impl CheckButton

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

pub fn new() -> CheckButton

Creates a new CheckButton.

Returns

a new CheckButton

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

Creates a new CheckButton with the given text.

label

the text for the check button.

Returns

a new CheckButton

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

Creates a new CheckButton with the given text and a mnemonic.

label

The text of the button, with an underscore in front of the mnemonic character

Returns

a new CheckButton

pub fn builder() -> CheckButtonBuilder

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

This method returns an instance of CheckButtonBuilder which can be used to create CheckButton objects.

Trait Implementations

impl Clone for CheckButton

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 CheckButton

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

Formats the value using the given formatter.

impl Default for CheckButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for CheckButton

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

Formats the value using the given formatter.

impl Hash for CheckButton

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: CheckButtonImpl> IsSubclassable<T> for CheckButton

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 CheckButton

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 CheckButton

type Parent = Widget

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

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 CheckButton

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 CheckButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for CheckButton

impl IsA<Accessible> for CheckButton

impl IsA<Actionable> for CheckButton

impl IsA<Buildable> for CheckButton

impl IsA<ConstraintTarget> for CheckButton

impl IsA<Widget> for CheckButton