[−][src]Struct pushrod::widgets::timer_widget::TimerWidget
This is the storage object for the TimerWidget
. It stores the config, properties, callback registry,
an enabled flag, timeout, a last-time-triggered value, and a timeout callback store.
Methods
impl TimerWidget
[src]
Creates a new TimerWidget
. This Widget
will call a function defined in on_timeout
when
a specific number of milliseconds has elapsed.
pub fn new(timeout: u64, enabled: bool) -> Self
[src]
Creates a new TimerWidget
object to call the on_timeout
timeout callback every timeout
milliseconds. Setting enabled
to true
will automatically enable the timer, where as
false
will add the timer, but it will not be enabled.
pub fn enable(&mut self)
[src]
Re-enables the timer. This will also reset the elapsed timer.
pub fn disable(&mut self)
[src]
Disables the timer. Once disabled, the on_timeout
callback will never be called.
pub fn is_enabled(&self) -> bool
[src]
Returns the enabled
state.
pub fn on_timeout<F>(&mut self, callback: F) where
F: FnMut(&mut TimerWidget, &[WidgetContainer], &[LayoutContainer]) + 'static,
[src]
F: FnMut(&mut TimerWidget, &[WidgetContainer], &[LayoutContainer]) + 'static,
Assigns the callback closure that will be used when a timer tick is triggered.
Trait Implementations
impl Widget for TimerWidget
[src]
This is the Widget
implementation of the TimerWidget
.
fn tick(&mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer])
[src]
The TimerWidget
responds to the tick
callback, which is used to determine the timer
display ticks. This function is only called when the timer tick occurs, so if there is a
function inside the drawing loop that drops frames, this timer may not get called reliably.
fn as_any(&mut self) -> &mut dyn Any
[src]
This function is a macro-created getter function that returns the Widget
as an Any
type. This allows the Widget
trait to be downcast into a struct
that implements
the Widget
trait.
fn get_config(&mut self) -> &mut WidgetConfig
[src]
This function is a macro-created getter function that returns the Widget
's configuration
object as a borrowed mutable reference. This code is auto-generated using the
default_widget_properties!()
macro.
fn get_system_properties(&mut self) -> &mut HashMap<i32, String>
[src]
This function is a macro-created getter function that returns the Widget
's system
properties as a borrowed mutable reference. This code is auto-generated using the
default_widget_properties!()
macro.
fn get_callbacks(&mut self) -> &mut CallbackRegistry
[src]
This function is a macro-created getter function that returns the Widget
's
CallbackRegistry
object as a borrowed mutable reference. This code is auto-generated
using the default_widget_properties!()
macro.
fn draw(
&mut self,
_c: &mut Canvas<Window>,
_t: &mut TextureCache
) -> Option<&Texture>
[src]
&mut self,
_c: &mut Canvas<Window>,
_t: &mut TextureCache
) -> Option<&Texture>
fn mouse_entered(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
fn mouse_exited(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
fn mouse_moved(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
fn mouse_scrolled(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
fn button_clicked(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
fn other_event(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_event: Event
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_event: Event
)
fn tick_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
fn mouse_entered_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
fn mouse_exited_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
fn mouse_moved_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
fn mouse_scrolled_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
fn button_clicked_callback(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
fn on_config_changed(&mut self, _k: u8, _v: Config)
[src]
fn set_point(&mut self, config: u8, x: i32, y: i32)
[src]
fn set_color(&mut self, config: u8, color: Color)
[src]
fn set_numeric(&mut self, config: u8, value: i32)
[src]
fn set_text(&mut self, config: u8, text: String)
[src]
fn set_toggle(&mut self, config: u8, flag: bool)
[src]
fn set_compass(&mut self, config: u8, value: CompassPosition)
[src]
fn get_point(&mut self, k: u8) -> Points
[src]
fn get_size(&mut self, k: u8) -> Size
[src]
fn get_color(&mut self, k: u8) -> Color
[src]
fn get_numeric(&mut self, k: u8) -> i32
[src]
fn get_text(&mut self, k: u8) -> String
[src]
fn get_toggle(&mut self, k: u8) -> bool
[src]
fn get_compass(&mut self, k: u8) -> CompassPosition
[src]
fn set_origin(&mut self, _origin: Points)
[src]
fn set_size(&mut self, _size: Vec<u32>)
[src]
fn get_drawing_area(&mut self) -> Rect
[src]
fn is_invalidated(&mut self) -> bool
[src]
fn set_invalidated(&mut self, flag: bool)
[src]
Auto Trait Implementations
impl !RefUnwindSafe for TimerWidget
impl !Send for TimerWidget
impl !Sync for TimerWidget
impl Unpin for TimerWidget
impl !UnwindSafe for TimerWidget
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,