Struct Label 

pub struct Label<T: FormattableText + 'static> { /* private fields */ }

A text label

Label text is set at construction time. It may also be set by Self::set_text or Self::set_string.

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

This type is generic over the text type.

Implementations

impl<T: FormattableText + 'static> Label<T>

pub fn new(text: T) -> Self

Construct from text

pub fn new_any<A>(text: T) -> MapAny<A, Self>

Construct from text, mapping to support any data type

pub fn class(&self) -> TextClass

Get text class

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

Set text class

Default: TextClass::Label(true)

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

Set text class (inline)

Default: TextClass::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::Label(wrap)).

By default this is enabled.

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

Enable/disable line wrapping (inline)

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

Get read access to the text object

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

Set text in an existing Label

pub fn as_str(&self) -> &str

Get text contents

impl Label<String>

pub fn set_string(&mut self, cx: &mut EventState, string: String)

Set text contents from a string

Trait Implementations

impl<T: Clone + FormattableText + 'static> Clone for Label<T>

fn clone(&self) -> Label<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + FormattableText + 'static> Debug for Label<T>

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

Formats the value using the given formatter.

impl<T: Default + FormattableText + 'static> Default for Label<T>

fn default() -> Label<T>

Returns the “default value” for a type.

impl<T: FormattableText + 'static> Events for Label<T>

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

Configure self

fn handle_event( &mut self, _: &mut EventCx<'_>, _: &Self::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<'a> From<&'a str> for Label<String>

fn from(text: &'a str) -> Self

Converts to this type from the input type.

impl<T: FormattableText + 'static> From<T> for Label<T>

fn from(text: T) -> Self

Converts to this type from the input type.

impl<T: FormattableText + 'static> Layout for Label<T>

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

Set size and position

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

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

Draw a widget and its children

impl<T: FormattableText + 'static> MacroDefinedLayout for Label<T>

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<T: FormattableText + 'static> Tile for Label<T>

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<T: FormattableText + 'static> Widget for Label<T>

type Data = ()

Input data type

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

Erase type

fn child_node<'__n>( &'__n mut self, data: &'__n Self::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available