Struct kas::widget::Label

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

A text label

This type is generic over the text type. Some aliases are available: StrLabel, StringLabel, AccelLabel.

Implementations

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

pub fn new(label: T) -> Self

Construct from label

pub fn with_reserve(self, text: T) -> Self

Reserve sufficient room for the given text

If this option is used, the label will be sized to fit this text, not the actual text.

pub fn set_text(&mut self, text: T) -> TkAction

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).

impl Label<AccelString>

pub fn keys(&self) -> &[VirtualKeyCode]

Get the accelerator keys

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

pub fn default() -> Label<T>

Returns the "default value" for a type.

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

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

Performs the conversion.

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

pub fn from(label: T) -> Self

Performs the conversion.

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

type Msg = VoidMsg

Type of message returned by this widget

pub fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

pub fn handle(
    &mut self,
    _: &mut Manager<'_>,
    event: Event
) -> Response<Self::Msg>

Handle an event and return a user-defined message

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

pub fn get_str(&self) -> &str

Get text by reference

pub fn get_string(&self) -> String

Get text as a String

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

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

Set text from a string

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

Set text from a &str

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

pub fn size_rules(
    &mut self,
    size_handle: &mut dyn SizeHandle,
    axis: AxisInfo
) -> SizeRules

Get size rules for the given axis

pub fn set_rect(&mut self, rect: Rect, align: AlignHints)

Apply a given rect to self

pub default fn draw(
    &self,
    draw_handle: &mut dyn DrawHandle,
    _: &ManagerState,
    _: bool
)

Draw a widget and its children

pub fn translation(&self, _child_index: usize) -> Coord

Get translation of a child

pub fn spatial_range(&self) -> (usize, usize)

Iterate through children in spatial order

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

Find a widget by coordinate

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

pub fn draw(&self, draw_handle: &mut dyn DrawHandle, _: &ManagerState, _: bool)

Draw a widget and its children

pub fn size_rules(
    &mut self,
    size_handle: &mut dyn SizeHandle,
    axis: AxisInfo
) -> SizeRules

Get size rules for the given axis

pub fn set_rect(&mut self, rect: Rect, _align: AlignHints)

Apply a given rect to self

pub fn translation(&self, _child_index: usize) -> Coord

Get translation of a child

pub fn spatial_range(&self) -> (usize, usize)

Iterate through children in spatial order

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

Find a widget by coordinate

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

pub fn send(
    &mut self,
    mgr: &mut Manager<'_>,
    id: WidgetId,
    event: Event
) -> Response<Self::Msg>

Send an event

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

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

pub fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

pub fn len(&self) -> usize

Get the number of child widgets

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

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

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

pub fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

pub fn is_ancestor_of(&self, id: WidgetId) -> bool

Check whether id is a descendant

pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

Find a child widget by identifier

pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

Find a child widget by identifier

pub fn walk<F: FnMut(&dyn WidgetConfig)>(&self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

pub fn walk_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

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

pub fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

pub fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

pub fn configure(&mut self, _: &mut Manager<'_>)

Configure widget

pub fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)

Configure self and children

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

pub fn as_any(&self) -> &dyn Any

Get self as type Any

pub fn as_any_mut(&mut self) -> &mut dyn Any

Get self as type Any (mutable)

pub fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

pub fn core_data_mut(&mut self) -> &mut CoreData

pub fn widget_name(&self) -> &'static str

Get the name of the widget struct

pub fn as_widget(&self) -> &dyn WidgetConfig

Erase type

pub fn as_widget_mut(&mut self) -> &mut dyn WidgetConfig

Erase type

pub fn id(&self) -> WidgetId

Get the widget's numeric identifier

pub fn is_disabled(&self) -> bool

Get whether the widget is disabled

pub fn set_disabled(&mut self, disabled: bool) -> TkAction

Set the disabled state of a widget

pub fn with_disabled(self, disabled: bool) -> Self where
    Self: Sized, 

Set disabled state (chaining)

pub fn rect(&self) -> Rect

Get the widget's region, relative to its parent.

pub fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState

Construct InputState