Struct cushy::Tick

pub struct Tick { /* private fields */ }

A fixed-rate callback that provides access to tracked input on its associated widget.

Implementations

impl Tick

pub fn rendered(&self, context: &WidgetContext<'_>)

Signals that this widget has been redrawn.

pub fn key_input(&self, input: &KeyEvent) -> EventHandling

Processes input.

If the event matches a key that has been marked as handled, HANDLED will be returned. Otherwise, IGNORED will be returned,

pub fn set_cursor_position(&self, pos: Option<Point<Px>>)

Sets the cursor position.

pub fn mouse_button(&self, button: MouseButton, button_state: ElementState)

Processes a mouse button event.

pub fn new<F>(tick_every: Duration, tick: F) -> Self

where F: FnMut(Duration, &InputState) + Send + 'static,

Returns a new tick that invokes tick, aiming to repeat at the given duration.

pub fn times_per_second<F>(times_per_second: u32, tick: F) -> Self

where F: FnMut(Duration, &InputState) + Send + 'static,

Returns a new tick that invokes tick at a target number of times per second.

pub fn redraws_per_second(times_per_second: u32) -> Self

Returns a new tick that redraws its associated widget at a target rate of x times_per_second.

pub fn handled_keys(self, keys: impl IntoIterator<Item = Key>) -> Self

Adds the collection of [Key]s to the list that are handled, and returns self.

The list of keys provided will be prevented from propagating.

Trait Implementations

impl Clone for Tick

fn clone(&self) -> Tick

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tick

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.