Struct kas_widgets::TextButton

pub struct TextButton<M: 'static> { /* fields omitted */ }

A push-button with a text label

This is a specialised variant of Button supporting key shortcuts from an AccelString label and using a custom text class (and thus theme colour).

Default alignment of the button is to stretch horizontally and centre vertically. The text label is always centred (irrespective of alignment parameters).

Implementations

impl TextButton<VoidMsg>

pub fn new<S: Into<AccelString>>(label: S) -> Self

Construct a button with given label

pub fn on_push<M, F>(self, f: F) -> TextButton<M> where
    F: Fn(&mut Manager<'_>) -> Option<M> + 'static, 

Set event handler f

On activation (through user input events or Event::Activate) the closure f is called. The result of f is converted to Response::Msg or Response::None and returned to the parent.

impl<M: 'static> TextButton<M>

pub fn new_on<S: Into<AccelString>, F>(label: S, f: F) -> Self where
    F: Fn(&mut Manager<'_>) -> Option<M> + 'static, 

Construct a button with a given label and event handler f

On activation (through user input events or Event::Activate) the closure f is called. The result of f is converted to Response::Msg or Response::None and returned to the parent.

pub fn new_msg<S: Into<AccelString>>(label: S, msg: M) -> Self where
    M: Clone, 

Construct a button with a given label and payload msg

On activation (through user input events or Event::Activate) a clone of msg is returned to the parent widget. Click actions must be implemented through a handler on the parent widget (or other ancestor).

pub fn with_keys(self, keys: &[VirtualKeyCode]) -> Self

Add accelerator keys (chain style)

These keys are added to those inferred from the label via & marks.

pub fn set_color(&mut self, color: Option<Rgb>)

Set button color

pub fn with_color(self, color: Rgb) -> Self

Set button color (chain style)

Trait Implementations

impl<M: Clone + 'static> Clone for TextButton<M>

fn clone(&self) -> TextButton<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: 'static> Debug for TextButton<M>

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

Formats the value using the given formatter.

impl<M: 'static> Handler for TextButton<M>

type Msg = M

Type of message returned by this widget

fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

fn handle(&mut self, mgr: &mut Manager<'_>, event: Event) -> Response<M>

Handle an event and return a user-defined message

fn focus_on_key_nav(&self) -> bool

Generic handler: focus rect on key navigation

impl<M: 'static> HasStr for TextButton<M>

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

impl<M: 'static> Layout for TextButton<M>

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

Get size rules for the given axis

fn set_rect(&mut self, _: &mut Manager<'_>, rect: Rect, align: AlignHints)

Apply a given rect to self

fn draw(
    &self,
    draw_handle: &mut dyn DrawHandle,
    mgr: &ManagerState,
    disabled: bool
)

Draw a widget and its children

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

Get translation of a child

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

Navigation in spatial order

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

Find a widget by coordinate

impl<M: 'static> SendEvent for TextButton<M>

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

Send an event

impl<M: 'static> SetAccel for TextButton<M>

fn set_accel_string(&mut self, string: AccelString) -> TkAction

Set accel string

fn set_accel<T>(&mut self, accel: T) -> TkAction where
    T: Into<AccelString>, 

Set text

impl<M: 'static> WidgetChildren for TextButton<M>

fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

fn num_children(&self) -> usize

Get the number of child widgets

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

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 WidgetConfig>

Mutable variant of get

fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

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

Check whether id is a descendant

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

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

fn find_leaf(&self, id: WidgetId) -> Option<&(dyn WidgetConfig + 'static)>

Find the leaf (lowest descendant) with this id, if any

fn find_leaf_mut(
    &mut self,
    id: WidgetId
) -> Option<&mut (dyn WidgetConfig + 'static)>

Find the leaf (lowest descendant) with this id, if any

fn walk_children<F>(&self, f: F) where
    F: FnMut(&(dyn WidgetConfig + 'static)), 

Walk through all widgets, calling f once on each.

fn walk_children_mut<F>(&mut self, f: F) where
    F: FnMut(&mut (dyn WidgetConfig + 'static)), 

Walk through all widgets, calling f once on each.

impl<M: 'static> WidgetConfig for TextButton<M>

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

Configure widget

fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

fn hover_highlight(&self) -> bool

Does this widget have hover-state highlighting?

fn configure_recurse(&mut self, cmgr: ConfigureManager<'_, '_>)

Configure self and children

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

impl<M: 'static> WidgetCore for TextButton<M>

fn as_any(&self) -> &dyn Any

Get self as type Any

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

Get self as type Any (mutable)

fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

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

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

Get the name of the widget struct

fn as_widget(&self) -> &dyn WidgetConfig

Erase type

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

Erase type

fn id(&self) -> WidgetId

Get the widget’s numeric identifier

fn is_disabled(&self) -> bool

Get whether the widget is disabled

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

Set the disabled state of a widget

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

Set disabled state (chaining)

fn rect(&self) -> Rect

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

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

Construct InputState

impl<M: 'static> Widget for TextButton<M>