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.

pub fn on_tick<F>(&mut self, callback: F) where
    F: FnMut(&mut TimerWidget) + 'static, 

Assigns the callback closure that will be used when a timer tick is triggered.

Trait Implementations

impl Drawable for TimerWidget

fn draw(&mut self, _c: Context, _g: &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 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. Draw with offset always uses 0x0 as the starting drawing coordinates, as this is what will be drawn within the bounds of the Widget. (See CheckboxWidget and ImageButtonWidget for good examples of this use.)

impl InjectableSystemEvents for TimerWidget

fn inject_system_event(&mut self) -> Option<CallbackEvent>

Part of the main loop that queries the Widget for any system-level events that should be injected into the PushrodCallbackEvents trait, and not handled by the top-level run loop. This sends out messages that are bypassed from being used by the Run Loop, so be very careful. Use this for sending things like custom messages (such as a Widget move or Widget resize message, which is irrelevant to the run loop.)

impl InjectableCustomEvents for TimerWidget

fn inject_custom_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.

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_custom_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 set_widget_id(&mut self, widget_id: i32)

fn get_widget_id(&mut self) -> i32

fn handle_event(
    &mut self,
    injected: bool,
    _event: CallbackEvent,
    _widget_store: Option<&Vec<WidgetContainer>>
) -> 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 handles_events(&mut self) -> bool

Indicates to the run loop whether or not the Widget handles system-generated events.

fn get_injectable_custom_events(&mut self) -> &mut dyn InjectableCustomEvents

Retrieves the InjectableCustomEvents trait of this class, which is responsible for injecting custom events when appropriate. Injecting system events is used with the InjectableSystemEvents, and things like mouse clicks and widget clicks are used with the handle_event block. This code is used to inject events that are not triggered by other events in the system.

fn get_injectable_system_events(&mut self) -> &mut dyn InjectableSystemEvents

Retrieves the trait for injecting system events. Only use this if your Widget injects custom system-level events that the top-level application needs to use. Anything other than that should be ignored completely.

fn get_drawable(&mut self) -> &mut dyn Drawable

Retrieves the Drawable functionality of this Widget.

fn is_drawable(&mut self) -> bool

Describes whether or not the Widget returns a Drawable trait. This function is called each time a frame is refreshed, so if there is no Drawable available, this function could serve as a way to indicate a frame tick. Only override this to set it to false if your Widget does not draw anything on the screen.

fn get_callbacks(&mut self) -> &mut DefaultWidgetCallbacks

Retrieves the callbacks that are registered for the Widget. These callbacks are used when a specific event triggers an action - a click, mouse enter/exit, or movement event, for example. The callbacks stored in the DefaultWidgetCallbacks object can be used to perform static actions.

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 injects_system_events(&mut self) -> bool

Indicates to the run loop whether or not a Widget injects system-level events.