Struct AccessLabel 

pub struct AccessLabel { /* private fields */ }

A label supporting an access key

An AccessLabel is a variant of Label supporting an access key, for example “&Edit” binds an action to Alt+E since by default Alt must be held to use access keys. The access key is parsed from the input text (see AccessString) and underlined when Alt is held.

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

Action bindings

This widget attempts to bind itself to its access key unless a different target is set. If the binding succeeds and the access key is used, the target will receive navigation focus (if supported; otherwise the first supporting ancestor is focussed) and Event::Command(Command::Activate) (likewise, an ancestor may handle the event). This AccessLabel does not support focus and will not handle the Command::Activate event.

Implementations

impl AccessLabel

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

Construct from text

pub fn set_target(&mut self, target: Id)

Set the access key target

This method should be called from Events::configure or Events::configure_recurse.

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 as_str(&self) -> &str

Get text contents

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

Get read access to the text object

pub fn set_text(&mut self, cx: &mut EventState, text: AccessString)

Set text in an existing Label

Trait Implementations

impl Clone for AccessLabel

fn clone(&self) -> AccessLabel

Returns a duplicate 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, _: &mut EventCx<'_>, _: &<AccessLabel as Widget>::Data, _: Event<'_>, ) -> IsUsed

Handle an Event

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

fn mouse_over_icon(&self) -> Option<CursorIcon>

The mouse cursor icon to use on mouse over

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 handle_mouse_over(&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 Layout for AccessLabel

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

Set size and position

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

Draw a widget and its children

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

Get size rules for the given axis

fn rect(&self) -> Rect

Get the widget’s region

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

Probe a coordinate for a widget’s Id

impl MacroDefinedLayout for AccessLabel

fn rect(&self) -> Rect

Get the widget’s region

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 try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

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

Draw a widget and its children

impl Tile for AccessLabel

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

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

Access a child as a dyn Tile, if available

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

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

Navigation in spatial order

fn probe(&self, coord: Coord) -> Id

Probe a coordinate for a widget’s Id

fn id(&self) -> Id

Get the widget’s identifier

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

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

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

fn translation(&self, index: usize) -> Offset

Get translation of child index 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 child_node<'__n>( &'__n mut self, data: &'__n <AccessLabel as Widget>::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available