Struct kas_widgets::Label

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

A text label

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: StrLabel, StringLabel, AccelLabel.

Implementations

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

pub fn new(label: T) -> Self

Construct from label

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, text: T) -> 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<T: Clone + FormattableText + 'static> Clone for Label<T>

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

Returns a copy 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 for Label<T>where T: Default + FormattableText + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a str> for Label<String>

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

Converts to this type from the input type.

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

fn from(label: T) -> Self

Converts to this type from the input type.

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

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

impl<T> HasString for Label<T>where T: EditableText + FormattableText + 'static,

fn set_string(&mut self, string: String) -> Action

Set text from a string

fn set_str(&mut self, text: &str) -> Action

Set text from a &str

impl<'a> Layout for Label<&'a str>

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

Draw a widget and its children

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

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

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

Translate a coordinate to a WidgetId

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

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

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

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

Draw a widget and its children

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

Translate a coordinate to a WidgetId

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

fn pre_configure(&mut self, _: &mut ConfigMgr<'_>, id: WidgetId)

Pre-configuration

fn configure(&mut self, mgr: &mut ConfigMgr<'_>)

Configure widget

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn translation(&self) -> Offset

Get translation of children relative to this widget

fn nav_next( &mut self, mgr: &mut ConfigMgr<'_>, reverse: bool, from: Option<usize> ) -> Option<usize>

Navigation in spatial order

fn handle_event(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an Event sent to this widget

fn steal_event( &mut self, mgr: &mut EventMgr<'_>, id: &WidgetId, event: &Event ) -> Response

Potentially steal an event before it reaches a child

fn handle_unused(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an event sent to child index but left unhandled

fn handle_message(&mut self, mgr: &mut EventMgr<'_>)

Handler for messages from children/descendants

fn handle_scroll(&mut self, mgr: &mut EventMgr<'_>, scroll: Scroll)

Handler for scrolling

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

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn Widget>

Get a reference to a child widget by index, or None if the index is out of bounds.

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn Widget>

Mutable variant of get

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

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

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

Make an identifier for a child

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

fn id_ref(&self) -> &WidgetId

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 as_widget(&self) -> &dyn Widget

Erase type

fn as_widget_mut(&mut self) -> &mut dyn Widget

Erase type