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,

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.

pub fn new() -> Self

pub fn tick(&mut self)

pub fn set_enabled(&mut self, enabled: bool)

pub fn set_timeout(&mut self, timeout: u128)

Trait Implementations

impl Widget for TimerWidget

Implementation of the TimerWidget object with the Widget traits implemented.

Example usage:

   let mut timer_widget = TimerWidget::new();

   // (OR)

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

Checks to see whether or not the widget needs to be redrawn/refreshed.

fn get_origin(&mut self) -> Point

Retrieves the Point of origin for this object. Defaults to origin (0, 0) if not set.

fn get_size(&mut self) -> Size

Retrieves the Size bounds for this widget. Defaults to size (0, 0) if not set.

fn mouse_entered(&mut self, _widget_id: i32)

Called when a mouse enters the bounds of the widget. Includes the widget ID.

fn mouse_exited(&mut self, _widget_id: i32)

Called when a mouse exits the bounds of the widget. Includes the widget ID.

fn mouse_scrolled(&mut self, _widget_id: i32, _point: Point)

Called when a scroll event is called within the bounds of the widget. Includes the widget ID.

fn draw(&mut self, _context: Context, _graphics: &mut GlGraphics)

Draws the contents of the widget in this order:

• Base widget first
• Box graphic for the specified width

fn invalidate(&mut self)

Indicates that a widget needs to be redrawn/refreshed.

fn clear_invalidate(&mut self)

Clears the invalidation flag.

fn set_origin(&mut self, x: i32, y: i32)

Sets the Point of origin for this widget, given the X and Y origin points. Invalidates the widget afterward.

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

Sets the Size for this widget, given a width and height. Invalidates the widget afterward.

fn set_color(&mut self, color: Color)

Sets the color for this widget. Invalidates the widget afterward.

fn get_color(&mut self) -> Color

Retrieves the color of this widget. Defaults to white color [1.0; 4] if not set.