Struct WithLabel

pub struct WithLabel<W: Widget, D: Directional = Direction> { /* private fields */ }

A wrapper widget with a label

The label supports access keys, which activate self.inner on usage.

Mouse/touch input on the label sends events to the inner widget.

Implementations

impl<W: Widget, D: Directional> WithLabel<W, D>

pub fn new<T: Into<AccessString>>(inner: W, label: T) -> Self

where D: Default,

Construct a wrapper around inner placing a label in the given direction

impl<W: Widget> WithLabel<W, Left>

pub fn left<T: Into<AccessString>>(inner: W, label: T) -> Self

Construct from inner widget and label

impl<W: Widget> WithLabel<W, Right>

pub fn right<T: Into<AccessString>>(inner: W, label: T) -> Self

Construct from inner widget and label

impl<W: Widget, D: Directional> WithLabel<W, D>

pub fn new_dir<T: Into<AccessString>>(inner: W, direction: D, label: T) -> Self

Construct a wrapper around inner placing a label in the given direction

pub fn direction(&self) -> Direction

Get the direction

pub fn take_inner(self) -> W

Take inner

pub fn layout_storage(&mut self) -> &mut impl RowStorage

Access layout storage

The number of columns/rows is fixed at two: the inner widget, and the label (in this order, regardless of direction).

pub fn wrap(&self) -> bool

Get whether line-wrapping is enabled

pub fn set_wrap(&mut self, wrap: bool)

Enable/disable line wrapping

By default this is enabled.

pub fn with_wrap(self, wrap: bool) -> Self

Enable/disable line wrapping (inline)

pub fn set_text<T: Into<AccessString>>(&mut self, text: T) -> Action

Set text

Note: this must not be called before fonts have been initialised (usually done by the theme when the main loop starts).

Trait Implementations

impl<W: Clone + Widget, D: Clone + Directional> Clone for WithLabel<W, D>

fn clone(&self) -> WithLabel<W, D>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<W: Default + Widget, D: Default + Directional> Default for WithLabel<W, D>

fn default() -> WithLabel<W, D>

Returns the “default value” for a type.

impl<W: Widget, D: Directional> Deref for WithLabel<W, D>

type Target = W

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<W: Widget, D: Directional> DerefMut for WithLabel<W, D>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<W: Widget, D: Directional> Events for WithLabel<W, D>

fn handle_event( &mut self, _: &mut EventCx<'_>, _: &Self::Data, _: Event, ) -> IsUsed

Handle an Event

fn make_child_id(&mut self, index: usize) -> Id

Make an identifier for a child

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Configure children

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update self using input data

fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update children

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn handle_hover(&mut self, cx: &mut EventCx<'_>, state: bool)

Mouse focus handler

fn handle_messages(&mut self, cx: &mut EventCx<'_>, data: &Self::Data)

Handler for messages from children/descendants

fn handle_scroll( &mut self, cx: &mut EventCx<'_>, data: &Self::Data, scroll: Scroll, )

Handler for scrolling

impl<W: Widget, D: Directional> Layout for WithLabel<W, D>

fn find_id(&mut self, coord: Coord) -> Option<Id>

Translate a coordinate to an Id

fn as_layout(&self) -> &dyn Layout

Get as a dyn Layout

fn id_ref(&self) -> &Id

Get the widget’s identifier

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

fn widget_name(&self) -> &'static str

Get the name of the widget struct

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, index: usize) -> Option<&dyn Layout>

Access a child as a dyn Layout

fn size_rules(&mut self, sizer: SizeCx<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect, hints: AlignHints)

Set size and position

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn draw(&mut self, draw: DrawCx<'_>)

Draw a widget and its children

fn find_child_index(&self, id: &Id) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn translation(&self) -> Offset

Get translation of children relative to this widget

impl<W: Widget, D: Directional> LayoutVisitor for WithLabel<W, D>

fn layout_visitor(&mut self) -> Visitor<impl Visitable>

Layout defined by a Visitor

impl<W: Widget, D: Directional> Widget for WithLabel<W, D>

type Data = <W as Widget>::Data

Input data type

fn as_node<'a>(&'a mut self, data: &'a Self::Data) -> Node<'a>

Erase type

fn for_child_node( &mut self, data: &Self::Data, index: usize, closure: Box<dyn FnOnce(Node<'_>) + '_>, )

Call closure on child with given index, if index < self.num_children().