Skip to content
QuickGUI

ToggleGroup

Coordinates single or multiple pressed values with roving keyboard focus.

Loading interactive demo…

#Import

Import ToggleGroup from quickgui.

use quickgui::*;

#Usage

let group = ToggleGroup::new("align", &state, &items);
group.root().flex_row()

#Anatomy

  • ToggleGroup::root
  • ToggleGroup::item

#API reference

Expand an entry for its description and complete signature. A dash means no declaration default is documented.

ToggleGroup

View source
pub fn new( root_id: impl Into<ElementId>, state: &'a ToggleGroupState, items: &'a [ToggleGroupItem], ) -> Self

Create a toggle group over the caller's ordered items. # Panics Panics with more than [`MAX_TOGGLE_GROUP_ITEMS`] items or duplicate item values.

verticalpub const fn vertical(mut self) -> Self—

Configures vertical for this part.

pub const fn vertical(mut self) -> Self
View source
loop_focuspub const fn loop_focus(mut self, loop_focus: bool) -> Self—

Configures loop focus for this part.

pub const fn loop_focus(mut self, loop_focus: bool) -> Self
View source
root_idpub const fn root_id(self) -> ElementId—

Configures root id for this part.

pub const fn root_id(self) -> ElementId
View source
itemspub const fn items(self) -> &'a [ToggleGroupItem]—

Configures items for this part.

pub const fn items(self) -> &'a [ToggleGroupItem]
View source
item_idpub fn item_id(self, value: impl Into<ElementId>) -> ElementId—

Configures item id for this part.

pub fn item_id(self, value: impl Into<ElementId>) -> ElementId
View source
roving_valuepub fn roving_value(self) -> Option<ElementId>—

The item that currently owns the group's single Tab stop. The controlled active value wins, then the first pressed enabled item, then the first enabled item.

pub fn roving_value(self) -> Option<ElementId>
View source
itempub fn item(self, value: impl Into<ElementId>) -> Option<ToggleGroupEntry<'a>>—

Describe one declared item.

pub fn item(self, value: impl Into<ElementId>) -> Option<ToggleGroupEntry<'a>>
View source

ToggleGroup::root_with

View source
pub fn root_with(self, root: Element) -> Element

Decorate an application-owned group root without adding layout or appearance.

ToggleGroup::root

View source
pub fn root(self) -> Element

Create the unstyled root part. Use [`Self::root_with`] to supply an existing element.