Struct pushrod::widget::timer_widget::TimerWidget

pub struct TimerWidget { /* fields omitted */ }

This is the TimerWidget. It contains no base widget, it only contains a start and end time,

Example usage: IN PROGRESS

Methods

impl TimerWidget

Implementation of the constructor for the TimerWidget. Timer widgets are not accessible on the screen, so they have an origin of 0x0 and width of 0x0.

The timer provides a simple way to call a callback function after a certain amount of time has passed. Upon instantiation, the timer is enabled.

Here are a few limitations of the timer as it currently stands:

• Timer cannot be paused; it is enabled or disabled, and the timer resets when enabled.
• Timer is called when the screen refreshes, so slower FPS settings will affect the timer.

pub fn new() -> Self

Constructor, creates a new TimerWidget struct with an empty timeout function.

Trait Implementations

impl Widget for TimerWidget

Implementation of the TimerWidget object with the Widget traits implemented.

fn config(&mut self) -> &mut Configurable

Retrieves the configuration HashMap that stores the configuration list of settings for this widget.

fn is_invalidated(&mut self) -> bool

Timer is always invalidated, this way, the tick function is always called on each screen refresh.

fn injects_events(&mut self) -> bool

This function injects events, as a timeout event only occurs once.

fn inject_event(&mut self, widget_id: i32) -> Option<CallbackEvent>

Returns an injected event where appropriate.

fn draw(&mut self, _context: Context, _graphics: &mut G2d, _clip: &DrawState)

Does not draw anything - only calls the timer tick() function to increment the timer.

fn invalidate(&mut self)

Indicates that a widget needs to be redrawn/refreshed.

fn clear_invalidate(&mut self)

Clears the invalidation flag.

fn set_config(&mut self, config: u8, config_value: Config)

fn get_config(&mut self, config: u8) -> Option<&Config>

fn set_point(&mut self, config: u8, x: i32, y: i32)

fn set_size(&mut self, config: u8, w: i32, h: i32)

fn set_color(&mut self, config: u8, color: Color)

fn set_numeric(&mut self, config: u8, value: u64)

fn set_text(&mut self, config: u8, text: String)

fn set_toggle(&mut self, config: u8, flag: bool)

fn handle_event(&mut self, _event: CallbackEvent) -> Option<CallbackEvent>

Handles an event that was sent by the event loop. It is up to the Widget to handle the event, or to ignore it. If this function is not overridden, the event will be ignored, and no event will be returned as a result. This function returns an Option<CallbackEvent>, which can be injected into the run loop. This can be things for Widget interaction that may generate an event that the application needs to respond to, like a button click, or a drag start/end event.