Struct pixel_widgets::widget::button::Button

pub struct Button<'a, T> { /* fields omitted */ }

A clickable button

Implementations

impl<'a, T: 'a> Button<'a, T>

pub fn new<C: IntoNode<'a, T> + 'a>(content: C) -> Self

Construct a new button

pub fn on_clicked(self, message: T) -> Self

Sets the message to be posted when this button is clicked.

pub fn text(self, text: impl Into<String> + 'a) -> Self

Sets the content of the button to be a paragraph of text.

pub fn extend<I: IntoIterator<Item = N>, N: IntoNode<'a, T>>(
    self,
    iter: I
) -> Self

Sets the content of the button from an iterator. Note that only the first element will be taken.

Trait Implementations

impl<'a, T: 'a> Default for Button<'a, T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T: 'a + Send> IntoNode<'a, T> for Button<'a, T>

fn into_node(self) -> Node<'a, T>

Perform the conversion.

fn class(self, class: &'a str) -> Node<'a, Message>

Convenience function that converts to a node and then adds a style class to the resulting Node.

fn key<K: Hash>(self, key: K) -> Node<'a, Message>

Convenience function that converts to a node and then sets a custom id to the resulting Node.

impl<'a, T: 'a + Send> Widget<'a, T> for Button<'a, T>

type State = State

The type of state this widget keeps track of.

fn mount(&self) -> State

Create a new state

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

The name of this widget, used to identify widgets of this type in stylesheets.

fn state(&self, state: &State) -> StateVec

The state of this widget, used for computing the style. If None is returned, Node will automatically compute a state, such as “hover” and “pressed”.

fn len(&self) -> usize

Should return the amount of children this widget has. Must be consistent with visit_children().

fn visit_children(
    &mut self,
    visitor: &mut dyn FnMut(&mut dyn GenericNode<'a, T>)
)

Applies a visitor to all childs of the widget. If an widget fails to visit it’s children, the children won’t be able to resolve their stylesheet, resulting in a panic when calling size, hit, event or draw.

fn size(&self, _: &State, style: &Stylesheet) -> (Size, Size)

Returns the (width, height) of this widget. The extents are defined as a Size, which will later be resolved to actual dimensions.

fn event(
    &mut self,
    state: &mut State,
    layout: Rectangle,
    clip: Rectangle,
    _: &Stylesheet,
    event: Event,
    context: &mut Context<T>
)

Handle an event. If an event changes the graphical appearance of an Widget, redraw should be called to let the Ui know that the ui should be redrawn.

fn draw(
    &mut self,
    _: &mut State,
    layout: Rectangle,
    clip: Rectangle,
    style: &Stylesheet
) -> Vec<Primitive<'a>>

Draw the widget. Returns a list of Primitives that should be drawn.

fn key(&self) -> u64

The key of this widget, used for resolving state.

fn is_empty(&self) -> bool

Returns whether this children has no children. Must be consistent with visit_children().

fn hit(
    &self,
    _state: &Self::State,
    layout: Rectangle,
    clip: Rectangle,
    _style: &Stylesheet,
    x: f32,
    y: f32
) -> bool

Perform a hit detect on the widget. Most widgets are fine with the default implementation, but some widgets (like Window need to report a miss (false) even when the queried position is within their layout.

fn focused(&self, _state: &Self::State) -> bool

Test the widget for focus exclusivity. If the widget or one of it’s descendants is in an exclusive focus state, this function should return true. In all other cases, it should return false. When a widget is in an exclusive focus state it is the only widget that is allowed to receive events in event. Widgets that intended to use this behaviour are modal dialogs, dropdown boxes, context menu’s, etc.