Struct Button 

pub struct Button<W: Widget> {
    pub inner: W,
    /* private fields */
}

A push-button with a generic label

Default alignment of content is centered.

Messages

kas::messages::Activate may be used to trigger the button.

Fields

inner: W

Implementations

impl<W: Widget> Button<W>

pub fn new(inner: W) -> Self

Construct a button with given inner widget

pub fn with(self, f: impl Fn(&mut EventCx<'_>, &W::Data) + 'static) -> Self

Call the handler f on press / activation

pub fn with_msg<M>(self, msg: M) -> Self

where M: Clone + Debug + 'static,

Send the message msg on press / activation

pub fn new_msg<M: Clone + Debug + 'static>(inner: W, msg: M) -> Self

Construct a button with a given inner 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 Events::handle_messages.

pub fn with_access_key(self, key: Key) -> Self

Add access key (chain style)

pub fn with_background(self, bg: Background) -> Self

Set the frame background color (inline)

The default background is Background::Default.

impl Button<AccessLabel>

pub fn label(label: impl Into<AccessString>) -> Self

Construct a button with the given label

This is a convenience method. It may be possible to merge this functionality into Button::new once Rust has support for overlapping trait implementations (not specialisation).

pub fn label_msg<M>(label: impl Into<AccessString>, msg: M) -> Self

where M: Clone + Debug + 'static,

Construct a button with the given label and payload msg

This is a convenience method. It may be possible to merge this functionality into Button::new_msg once Rust has support for overlapping trait implementations (not specialisation).

Trait Implementations

impl<W: Widget> Events for Button<W>

const REDRAW_ON_MOUSE_OVER: bool = true

Does this widget have a different appearance on mouse over?

fn handle_event( &mut self, cx: &mut EventCx<'_>, data: &W::Data, event: Event<'_>, ) -> IsUsed

Handle an Event

fn handle_messages(&mut self, cx: &mut EventCx<'_>, data: &W::Data)

Handler for messages from children/descendants

fn mouse_over_icon(&self) -> Option<CursorIcon>

The mouse cursor icon to use on mouse over

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

Make an identifier for a child

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Configure children

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update self using input data

fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update children

fn handle_mouse_over(&mut self, cx: &mut EventCx<'_>, state: bool)

Mouse focus handler

fn handle_scroll( &mut self, cx: &mut EventCx<'_>, data: &Self::Data, scroll: Scroll, )

Handler for scrolling

impl<W: Widget> Layout for Button<W>

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

Draw a widget and its children

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

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect, hints: AlignHints)

Set size and position

fn rect(&self) -> Rect

Get the widget’s region

fn try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

impl<W: Widget> MacroDefinedLayout for Button<W>

fn rect(&self) -> Rect

Get the widget’s region

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

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect, hints: AlignHints)

Set size and position

fn try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

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

Draw a widget and its children

impl<W: Widget> Tile for Button<W>

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

fn probe(&self, _: Coord) -> Id

Probe a coordinate for a widget’s Id

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

fn get_child(&self, index: usize) -> Option<&dyn Tile>

Access a child as a dyn Tile, if available

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

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

Navigation in spatial order

fn id(&self) -> Id

Get the widget’s identifier

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

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

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

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

Get translation of child index relative to this widget

impl<W: Widget> Widget for Button<W>

type Data = <W as Widget>::Data

Input data type

fn as_node<'__a>(&'__a mut self, data: &'__a Self::Data) -> Node<'__a>

Erase type

fn child_node<'__n>( &'__n mut self, data: &'__n Self::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available