Struct kas_widgets::TextButton

pub struct TextButton { /* private fields */ }

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 content is centered.

Implementations

impl TextButton

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

Construct a button with given label

pub fn on_push<F>(self, f: F) -> TextButtonwhere
    F: Fn(&mut EventMgr<'_>) + 'static,

Set event handler f

This closure is called when the button is activated.

pub fn new_on<S: Into<AccelString>, F>(label: S, f: F) -> Selfwhere
    F: Fn(&mut EventMgr<'_>) + 'static,

Construct a button with a given label and event handler f

This closure is called when the button is activated.

pub fn new_msg<S: Into<AccelString>, M: Clone + Debug + 'static>(
    label: S,
    msg: M
) -> Self

Construct a button with a given label and payload msg

When the button is activated, a clone of msg is sent to the parent widget. The parent (or an ancestor) should handle this using Widget::handle_message.

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 AutoLayout for TextButton

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

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

Draw a widget and its children

impl Clone for TextButton

fn clone(&self) -> TextButton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextButton

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

Formats the value using the given formatter.

impl HasStr for TextButton

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

impl Layout for TextButton

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

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

Draw a widget and its children

impl SetAccel for TextButton

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

Set accel string

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

Set text

impl Widget for TextButton

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

Configure widget

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

Handle an event sent to this widget

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

Pre-configuration

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

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

Navigation in spatial order

fn translation(&self) -> Offset

Get translation of children relative 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<'_>,
    index: usize,
    event: Event
) -> Response

Handle an event sent to child index but left unhandled

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

Handler for messages from children/descendants

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

Handler for scrolling

impl WidgetChildren for TextButton

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 WidgetCore for TextButton

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