Struct kas::widget::TextButton

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

A push-button with a text label

Methods

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

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

Construct a button with a given label and msg

The message msg is returned to the parent widget on activation. Any type supporting Clone is valid, though it is recommended to use a simple Copy type (e.g. an enum). Click actions must be implemented on the parent (or other ancestor).

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

Set accelerator keys (chain style)

pub fn set_msg(&mut self, msg: M)

Replace the message value

pub fn set_keys(&mut self, keys: &[VirtualKeyCode])

Set accelerator keys

Trait Implementations

impl<M: Clone + Debug + '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: Debug + Clone + 'static> Debug for TextButton<M>

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

Formats the value using the given formatter.

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

fn default() -> TextButton<M>

Returns the "default value" for a type.

impl<M: Clone + Debug + '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, _: &mut Manager, event: Event) -> Response<M>

Handle an event and return a user-defined message

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

fn get_text(&self) -> &str

Get the widget's text.

fn set_cow_string(&mut self, text: CowString) -> TkAction

Set the widget's text (CowString)

fn set_text<T: Into<CowString>>(&mut self, text: T) -> TkAction where
    Self: Sized, 

Set the widget's text.

impl<M: Clone + Debug + '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, 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) -> Coord

Get translation of a child

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

Iterate through children in spatial order

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

Find a widget by coordinate

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

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

Send an event

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

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

fn len(&self) -> usize

Get the number of child widgets

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.

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

Mutable variant of get

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

Check whether id is a descendant

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

Find a child widget by identifier

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

Find a child widget by identifier

fn walk(&self, f: &mut dyn FnMut(&dyn WidgetConfig))

Walk through all widgets, calling f once on each.

fn walk_mut(&mut self, f: &mut dyn FnMut(&mut dyn WidgetConfig))

Walk through all widgets, calling f once on each.

impl<M: Clone + Debug + '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 configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)

Configure self and children

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

impl<M: Clone + Debug + '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

Get the disabled state of a widget

fn rect(&self) -> Rect

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

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

Construct InputState