Struct pixel_widgets::widget::Node

pub struct Node<'a, Message> { /* fields omitted */ }

Generic ui widget.

Implementations

impl<'a, Message> Node<'a, Message>

pub fn new<T: 'a + Widget<'a, Message>>(widget: T) -> Self

Construct a new Node from an Widget.

pub fn class(self, class: &'a str) -> Self

Sets the style class

pub fn on_event(
    self,
    event: NodeEvent,
    f: impl 'a + Fn(&mut Context<Message>)
) -> Self

Sets a handler for when a node event occurs

pub fn size(&self) -> (Size, Size)

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

pub fn hit(&self, layout: Rectangle, clip: Rectangle, 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.

Arguments:

• layout: the layout assigned to the widget
• clip: a clipping rect for mouse events. Mouse events outside of this rect should be considered invalid, such as with Scroll, where the widget would not be visible outside of the currently visible rect.
• x: x mouse coordinate being queried
• y: y mouse coordinate being queried

pub fn focused(&self) -> 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.

pub fn event(
    &mut self,
    layout: Rectangle,
    clip: Rectangle,
    event: Event,
    context: &mut Context<Message>
)

Handle an event.

Arguments:

• layout: the layout assigned to the widget
• clip: a clipping rect for mouse events. Mouse events outside of this rect should be considered invalid, such as with Scroll, where the widget would not be visible outside of the currently visible rect.
• event: the event that needs to be handled
• context: context for submitting messages and requesting redraws of the ui.

pub fn draw(&mut self, layout: Rectangle, clip: Rectangle) -> Vec<Primitive<'a>>

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

Arguments:

• layout: the layout assigned to the widget
• clip: a clipping rect for use with Primitive::PushClip.

Trait Implementations

impl<'a, Message: 'a> IntoNode<'a, Message> for Node<'a, Message>

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

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 Node.

fn on_event(
    self,
    event: NodeEvent,
    f: impl 'a + Fn(&mut Context<Message>)
) -> Node<'a, Message>

Convenience function that converts to a node and then sets a handler for when a node event occurs.