Struct pushrod::widget::timer_widget::TimerWidget

pub struct TimerWidget { /* fields omitted */ }

Creates a timer that can be used to generate callbacks based on a timeout. When a timeout has been reached, a TimerTriggered event is generated. Set the timer timeout in milliseconds by setting CONFIG_TIMER_TIMEOUT values.

Timer timeouts are triggered on a per-refresh basis, so if the FPS of the screen for the main window is set to 30 FPS, the timer will only receive a tick every 1/30th of a second. If you need higher resolution timers, consider using threads.

Methods

impl TimerWidget

pub fn new() -> Self

Constructor.

Trait Implementations

impl Widget for TimerWidget

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

Retrieves the Configurable object for this Widget. All Widget implementations must provide this. (See the CanvasWidget implementation.)

fn is_invalidated(&mut self) -> bool

Indicates whether or not a Widget needs to be repainted.

fn injects_events(&mut self) -> bool

If this Widget provides custom injected events that are generated outside of the handle_event loop, indicate true. Only override if necessary. (See TimerWidget for reference.)

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

Injects an event into the run loop. This can be a timer event, a refresh event, or whatever the Widget wants to inject. These should be custom events, not system events. This method only gets called if injects_events returns true.

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

Draws the Widget's contents. Only gets called if the Widget is in invalidated state. Provides a modified Context object that has an origin of 0x0 in drawing space for the draw routine. Also provides a mut G2d object against which to draw, and a clip, which is automatically set to provide a clipping area for the Widget. If the Widget draws outside of the clipped bounds, that will not be drawn on the screen.

fn invalidate(&mut self)

Indicates that a Widget object needs to be repainted.

fn clear_invalidate(&mut self)

Clears the invalidation flag. Set this when the draw function completes. Otherwise, this Widget object may be continuously repainted.

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

Master config setter - use convenience methods.

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

Master config getter - use convenience methods.

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

Sets a point value for a configuration key.

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

Sets a size value for a configuration key.

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

Sets a color for a configuration key.

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

Sets a numeric value for a configuration key.

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

Sets a text value for a configuration key.

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

Sets a toggle value for a configuration key.

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

Custom handler to receive an event. Any Widget that implements this does so to handle top-level GUI events, such as a mouse entering or exiting the bounds of this Widget. If the injected flag is set, it indicates that the event supplied was generate by a Widget, and not by the run loop.

fn draw_disabled(&mut self, c: Context, g: &mut GlGraphics, clip: &DrawState)

Internal method that is used to draw a box around the Widget when in disabled state. You can override this method, should you choose to, so that the disabled state appears differently in your application. It is safe to leave this alone.

fn draw_with_offset(
    &mut self,
    c: Context,
    g: &mut GlGraphics,
    clip: &DrawState,
    point_offset: Point
)

Draws an object at an offset on the screen. This is a convenience method that is used by other Widgets that contain multiple widgets. (See CheckboxWidget and ImageButtonWidget for good examples of this use.)