Skip to main content

SettingsList

Struct SettingsList 

Source
pub struct SettingsList<Msg> { /* private fields */ }
Expand description

Settings, one per row: the label (and a faint description) on the left, its control anchored on the right.

Rows are bare until touched. The row under the pointer raises its surface with a soft pillar; the keyboard’s row, while the list has focus, raises it further with a breathing pillar. A focused list raises only one row: moving the pointer onto a row makes it the keyboard’s row. Only the label slides one cell right; the pillar and the control never move. The label column keeps one spare cell for that.

Nothing is cut on a narrow screen: a description wraps over the whole width of its row, and a label too long to share its line with the control takes the whole width, wrapping if it must, while the control moves to the line under it. So does a control that needs more than half the row, which then has the whole row. A row reports the height it wraps to.

The list takes focus as one control. ↑/↓ (and Home/End) move between enabled rows; every other key goes to the selected row’s control, so Enter or Space toggles a switch or opens a select and ←/→ change a segmented control. Keys the control does not use activate the row when it has SettingRow::on_activate. The pointer works on controls directly; clicking a label selects its row. The application owns every value; the keyboard’s row lives in the runtime.

One long list can hold a whole settings page inside a ScrollView: moving with the keys scrolls just enough to show the new row, and a click never scrolls, so the row stays under the pointer.

Style keys: setting-row (bg, pillar) with hover, selected, focus, disabled; setting-label (fg, bold) and setting-description (fg) with the same states; settings-heading (fg, bold).

Implementations§

Source§

impl<Msg: Clone + 'static> SettingsList<Msg>

Source

pub fn show<'v>( ui: &'v mut View<'_, Msg>, build: impl FnOnce(&mut SettingsRows<'_, Msg>), ) -> NodeMut<'v, Msg>

Adds a settings list with the headings and rows build adds to ui.

Trait Implementations§

Source§

impl<Msg: Clone + 'static> Widget<Msg> for SettingsList<Msg>

Source§

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.
Source§

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.
Source§

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.
Source§

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.
Source§

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.
Source§

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.
Source§

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

Auto Trait Implementations§

§

impl<Msg> !RefUnwindSafe for SettingsList<Msg>

§

impl<Msg> !Send for SettingsList<Msg>

§

impl<Msg> !Sync for SettingsList<Msg>

§

impl<Msg> !UnwindSafe for SettingsList<Msg>

§

impl<Msg> Freeze for SettingsList<Msg>
where Vec<Entry<Msg>>: Freeze, Vec<Node<Msg>>: Freeze,

§

impl<Msg> Unpin for SettingsList<Msg>
where Vec<Entry<Msg>>: Unpin, Vec<Node<Msg>>: Unpin,

§

impl<Msg> UnsafeUnpin for SettingsList<Msg>
where Vec<Entry<Msg>>: UnsafeUnpin, Vec<Node<Msg>>: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.