Struct kas::widgets::AccessLabel

pub struct AccessLabel { /* private fields */ }

A label supporting an access key

An AccessLabel is a variant of Label supporting AccessString, for example “&Edit” binds an action to Alt+E. When the corresponding key-sequence is pressed this widget sends the message kas::messages::Activate which should be handled by a parent.

A text label. Vertical alignment defaults to centred, horizontal alignment depends on the script direction if not specified. Line-wrapping is enabled by default.

Implementations

impl AccessLabel

pub fn new(label: impl Into<AccessString>) -> AccessLabel

Construct from label

pub fn class(&self) -> TextClass

Get text class

pub fn set_class(&mut self, class: TextClass)

Set text class

Default: AccessLabel::Label(true)

pub fn with_class(self, class: TextClass) -> AccessLabel

Set text class (inline)

Default: AccessLabel::Label(true)

pub fn wrap(&self) -> bool

Get whether line-wrapping is enabled

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

Enable/disable line wrapping

This is equivalent to label.set_class(TextClass::AccessLabel(wrap)).

By default this is enabled.

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

Enable/disable line wrapping (inline)

pub fn text(&self) -> &Text<AccessString>

Get read access to the text object

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

Set text in an existing Label

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

Trait Implementations

impl Clone for AccessLabel

fn clone(&self) -> AccessLabel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccessLabel

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

Formats the value using the given formatter.

impl Default for AccessLabel

fn default() -> AccessLabel

Returns the “default value” for a type.

impl Events for AccessLabel

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

Configure self

fn handle_event( &mut self, cx: &mut EventCx<'_>, _: &<AccessLabel as Widget>::Data, event: Event ) -> IsUsed

Handle an Event

fn steal_event( &mut self, _: &mut EventCx<'_>, _: &<AccessLabel as Widget>::Data, _: &Id, _: &Event ) -> IsUsed

Potentially steal an event before it reaches a child

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

Make an identifier for a child

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) -> IsUsed

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 HasStr for AccessLabel

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

impl Layout for AccessLabel

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)

Set size and position

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

Draw a widget and its children

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 nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

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

Translate a coordinate to an Id

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 Widget for AccessLabel

type Data = ()

Input data type

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

Erase type

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

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