Struct kas::widgets::Text

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

A text label (derived from data)

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

A text label. 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. See also: StrText, StringText.

Implementations

impl<A, T> Text<A, T>

where T: Default + FormattableText + 'static,

pub fn new(label_fn: impl Fn(&ConfigCx<'_>, &A) -> T + 'static) -> Text<A, T>

Construct with a data binding

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) -> Text<A, T>

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) -> Text<A, T>

Enable/disable line wrapping (inline)

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

Get read access to the text object

Trait Implementations

impl<A, T> Default for Text<A, T>

where T: Default + FormattableText + 'static, &'a A: for<'a> Into<T>,

fn default() -> Text<A, T>

Returns the “default value” for a type.

impl<A, T> Events for Text<A, T>

where T: Default + FormattableText + 'static,

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

Update self using input data

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

Potentially steal an event before it reaches a child

fn handle_event( &mut self, _: &mut EventCx<'_>, _: &<Text<A, T> as Widget>::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_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<'a, A> Layout for Text<A, &'a str>

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 find_child_index(&self, id: &Id) -> Option<usize>

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

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

Navigation in spatial order

fn translation(&self) -> Offset

Get translation of children relative to this widget

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

Translate a coordinate to an Id

impl<A> Layout for Text<A, String>

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 find_child_index(&self, id: &Id) -> Option<usize>

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

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

Navigation in spatial order

fn translation(&self) -> Offset

Get translation of children relative to this widget

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

Translate a coordinate to an Id

impl<A, T> Layout for Text<A, T>

where T: Default + FormattableText + 'static,

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

default 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<A, T> Widget for Text<A, T>

where T: Default + FormattableText + 'static,

type Data = A

Input data type

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

Erase type

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

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