Struct FastTimer

pub struct FastTimer {
    pub notice: Notice,
    callback: RefCell<Box<dyn Fn() + 'static>>,
    cancel_latest: RefCell<Arc<AtomicBool>>,
    interval_config: Cell<Option<(Duration, Instant)>>,
}

An alternative to [nwg::AnimationTimer] that has less CPU usage.

Note: this is a [nwg::PartialUi] instead of a control because it needs to listen to events.

Examples

extern crate native_windows_derive as nwd;
extern crate native_windows_gui as nwg;

use virtual_desktop_manager::nwg_ext::{FastTimer, ParentCapture};
use std::time::Duration;

#[derive(nwd::NwgPartial, Default)]
struct MyUi {
    /// Captures the parent that this partial UI is instantiated with.
    #[nwg_control]
    capture: ParentCapture,

    #[nwg_partial(parent: capture)]
    #[nwg_events((notice, OnNotice): [Self::on_tick])]
    my_timer: FastTimer,
}
impl MyUi {
    pub fn start_interval(&self) {
        self.my_timer.start_interval(Duration::from_millis(100));
    }
    pub fn on_tick(&self) {
        // Do something every 100 milliseconds...
    }
}

Fields

notice: Notice

callback: RefCell<Box<dyn Fn() + 'static>>

cancel_latest: RefCell<Arc<AtomicBool>>

interval_config: Cell<Option<(Duration, Instant)>>

Some if an interval is configured in which case the duration between ticks is stored as well as when the next tick was scheduled.

Implementations

impl FastTimer

pub fn set_callback(&self, callback: impl Fn() + 'static)

pub fn cancel_last(&self)

This will cancel any queued timeout or interval.

pub fn notify_after(&self, duration: Duration)

pub fn notify_at(&self, time_to_notify_at: Instant)

pub fn start_interval(&self, between_ticks: Duration)

fn on_notice(&self)

Trait Implementations

impl Default for FastTimer

fn default() -> Self

Returns the “default value” for a type.

impl Drop for FastTimer

fn drop(&mut self)

Executes the destructor for this type.

impl PartialUi for FastTimer

fn build_partial<W: Into<ControlHandle>>( data: &mut Self, _parent: Option<W>, ) -> Result<(), NwgError>

Should initialize the GUI components. Similar to NativeUi::build_ui except it doesn’t handle event binding.

fn process_event<'a>( &self, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, )

Should process the events of the partial. This method will probably be called from an event handler bound in the parent GUI structure.

fn handles(&self) -> Vec<&ControlHandle>

Should return the handles of the top level parent controls (such as Windows). Those handle should be used to bind the default events handler.