Struct kas::widgets::Button

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

A push-button with a generic label

Default alignment of content is centered.

Fields

inner: W

Implementations

impl<W> Button<W>

where W: Widget,

pub fn new(inner: W) -> Button<W>

Construct a button with given inner widget

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

Call the handler f on press / activation

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

where M: Clone + Debug + 'static,

Send the message msg on press / activation

pub fn new_msg<M>(inner: W, msg: M) -> Button<W>

where M: Clone + Debug + 'static,

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) -> Button<W>

Add access key (chain style)

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

Set button color

pub fn with_color(self, color: Rgb) -> Button<W>

Set button color (chain style)

impl Button<AccessLabel>

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

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 ) -> Button<AccessLabel>

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> AutoLayout for Button<W>

where W: Widget,

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)

Set size and position

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

Translate a coordinate to an Id

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

Draw a widget and its children

impl<W> Events for Button<W>

where W: Widget,

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

Configure self

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

Handle an Event

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

Handler for messages from children/descendants

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn handle_hover(&mut self, cx: &mut EventCx<'_>, _: bool) -> IsUsed

Mouse focus handler

fn steal_event( &mut self, _: &mut EventCx<'_>, _: &<Button<W> as Widget>::Data, _: &Id, _: &Event ) -> IsUsed

Potentially steal an event before it reaches a child

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

Make an identifier for a child

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_scroll( &mut self, cx: &mut EventCx<'_>, data: &Self::Data, scroll: Scroll )

Handler for scrolling

impl<W> HasBool for Button<W>

where W: Widget + HasBool,

fn get_bool(&self) -> bool

Get the widget’s state

fn set_bool(&mut self, state: bool) -> Action

Set the widget’s state

impl<W> HasStr for Button<W>

where W: Widget + HasStr,

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

impl<W> HasString for Button<W>

where W: Widget + HasString,

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

Set text from a &str

fn set_string(&mut self, text: String) -> Action

Set text from a string

impl<W> Layout for Button<W>

where W: Widget,

fn as_layout(&self) -> &dyn Layout

Get as a dyn Layout

fn id_ref(&self) -> &Id

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 num_children(&self) -> usize

Get the number of child widgets

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

Access a child as a dyn Layout

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)

Set size and position

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

Navigation in spatial order

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

Translate a coordinate to an Id

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

Draw a widget and its children

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

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

fn translation(&self) -> Offset

Get translation of children relative to this widget

impl<W> Widget for Button<W>

where W: Widget,

type Data = <W as Widget>::Data

Input data type

fn as_node<'a>(&'a mut self, data: &'a <Button<W> as Widget>::Data) -> Node<'a>

Erase type

fn for_child_node( &mut self, data: &<Button<W> as Widget>::Data, index: usize, closure: Box<dyn FnOnce(Node<'_>) + '_> )

Call closure on child with given index, if index < self.num_children().