Struct nannou::ui::input::Widget

pub struct Widget<'a> { /* fields omitted */ }

Provides only events and input state that are relevant to a specific widget.

This type can be produced by calling the UiCell::input method with the target widget's widget::Id. This is particularly useful

Unlike input::Global, input::Widget methods are tailored to the widget for which they are produced.

Methods

impl<'a> Widget<'a>

pub fn for_widget(
    idx: NodeIndex<u32>,
    rect: Rect,
    global: &'a Global
) -> Widget<'a>

Returns a Widget with events specifically for the given widget.

Filters out only the events that directly pertain to the widget.

All events will also be made relative to the widget's own (0, 0) origin.

pub fn mouse(&self) -> Option<Mouse<'a>>

If the widget is currently capturing the mouse, this returns the state of the mouse.

Returns None if the widget is not capturing the mouse.

pub fn events(&self) -> Events<'a>

Produces an iterator yielding all events that are relevant to a specific widget.

All events provided by this Iterator will be filtered in accordance with input capturing. For example: If the widget does not capture the mouse, it will not receive any mouse-related events. If the widget captures the keyboard it will receive all keyboard events.

All mouse events will have their coordinates relative to the middle of the widget's Rect.

pub fn presses(&self) -> Presses<'a>

Filters all events yielded by Self::events other than event::Presses.

pub fn releases(&self) -> Releases<'a>

Filters all events yielded by Self::events other than event::Releasees.

pub fn clicks(&self) -> Clicks<'a>

Filters all events yielded by Self::events for all event::Clicks.

A click is determined to have occured if a pointing device button was both pressed and released over the widget.

pub fn taps(&self) -> Taps<'a>

Filters all events yielded by Self::events for all event::Taps.

A tap is determined to have occured if a touch interaction both started and ended over the widget.

pub fn drags(&self) -> Drags<'a>

Produces an iterator that yields all event::Drag events yielded by the Events iterator.

Only events that occurred while the widget was capturing the device that did the dragging will be yielded.

pub fn texts(&self) -> Texts<'a>

Produces an iterator that yields all Input::Text events that have occurred as &strs since the last time Ui::set_widgets was called.

Only events that occurred while the widget was capturing the keyboard will be yielded.

pub fn scrolls(&self) -> Scrolls<'a>

Produce an iterator that yields only the Scroll events yielded by the Events iterator.

Trait Implementations

impl<'a> Clone for Widget<'a>

fn clone(&self) -> Widget<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.