Struct Text 

pub struct Text<A, T: Default + FormattableText + 'static = String> { /* private fields */ }

A text label (derived from data)

Text derives its contents from input data. Use Label instead for fixed contents.

By default, this uses TextClass::Standard; see Self::set_class and Self::with_class.

See also macros format_text and format_label which construct a Text widget.

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

Implementations

impl<A> Text<A, String>

pub fn new_str(as_str: impl Fn(&A) -> &str + 'static) -> Self

Construct with an str accessor

impl<A, T: Default + FormattableText + 'static> Text<A, T>

pub fn new_gen(gen_text: impl Fn(&ConfigCx<'_>, &A) -> T + 'static) -> Self

Construct with a generator function

gen_text is called on each widget update to generate text from input data.

pub fn new_update( update_text: impl Fn(&ConfigCx<'_>, &A, &mut T) -> bool + 'static, ) -> Self

Construct with an update function

update_text is called on each widget update to generate text from input data. It must return true when the input text is changed (or updated text will not be displayed) and should return false otherwise (or the text will be re-prepared needlessly, which can be expensive).

pub fn class(&self) -> TextClass

Get text class

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

Set text class

Default: TextClass::Standard

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

Set text class (inline)

Default: TextClass::Standard

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 text(&self) -> &Text<T>

Get read access to the text object

pub fn as_str(&self) -> &str

Read the text contents as an str

Trait Implementations

impl<A, T: Default + FormattableText + 'static> Default for Text<A, T>

where for<'a> &'a A: Into<T>,

fn default() -> Self

Returns the “default value” for a type.

impl<A, T: Default + FormattableText + 'static> Events for Text<A, T>

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

Configure self

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

Update self using input data

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 pointer icon to use on mouse over

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

Make an identifier for a child

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

Probe a coordinate for a widget’s Id

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

Configure self (post-child-configuration actions)

fn recurse_indices(&self) -> ChildIndices

Recursion control

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

Mouse focus handler

fn child_nav_focus(&mut self, cx: &mut EventCx<'_>, id: Id)

Notification that a child received navigation focus

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

Handler for messages from children/descendants

fn handle_resize( &mut self, cx: &mut ConfigCx<'_>, data: &Self::Data, ) -> Option<ActionResize>

Handler for resize requests

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

Handler for scrolling

impl<A, T: Default + FormattableText + 'static> Layout for Text<A, T>

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

Set size and position

fn rect(&self) -> Rect

Get the widget’s region

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

Calculate size requirements for an axis

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

Draw a widget and its children

impl<A, T: Default + FormattableText + 'static> MacroDefinedLayout for Text<A, T>

fn rect(&self) -> Rect

Get the widget’s region

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

Get size rules for the given axis

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

Set size and position

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

Draw a widget and its children

impl<A, T: Default + FormattableText + 'static> Tile for Text<A, 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 try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

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

Navigation in spatial order

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<A, T: Default + FormattableText + 'static> Widget for Text<A, T>

type Data = A

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