Struct Timer

pub struct Timer {
    pub handle: ControlHandle,
    /* private fields */
}

👎Deprecated since 1.0.11: Use AnimationTimer instead. The winapi timer does not have a constant tick and will call your single threaded from another thread.

WARNING: Use AnimationTimer instead. The winapi timer does not have a constant tick and will call your single threaded from another thread.

A timer is an invisible UI component that trigger the OnTimerTick event at the specified interval. Timers are mosty used to handle animations OR to create a timeout. To sync multithreaded action see the Notice object.

A timer still requires a top level window parent. If the top level window parent is destroyed, the timer becomes invalid.

Note that timer SHOULD NOT be used when a consistent interval is needed. The timer event might be triggered much faster than the interval value. For example, when a user resize a window, Timer OnTimerTick gets triggered each time the window size changes. This is a Windows “feature”, there’s probably nothing I can do to fix that.

Requires the timer feature.

Builder parameters:

• parent: Required. The timer parent container. Should be a top level window
• interval: The timer tick interval in millisecond
• stopped: If the timer should start right away. By default timers starts “stopped(true)”. Be sure to include stopped(false) in your builder if you want the timer to start instantly.

Control events:

• OnTimerTick: When the timer ticks

use native_windows_gui as nwg;

fn build_timer(parent: &nwg::Window)  {
    let mut timer = Default::default();
    nwg::Timer::builder()
        .parent(parent)
        .interval(100)
        .stopped(false)
        .build(&mut timer);
}

Fields

handle: ControlHandle

👎Deprecated since 1.0.11: Use AnimationTimer instead. The winapi timer does not have a constant tick and will call your single threaded from another thread.

Implementations

impl Timer

pub fn builder() -> TimerBuilder

pub fn valid(&self) -> bool

Checks if the timer is still usable. A timer becomes unusable when the parent window is destroyed. This will also return false if the timer is not initialized.

pub fn interval(&self) -> u32

Returns the interval of the timer, in milliseconds.

pub fn set_interval(&self, i: u32)

Sets the interval of the timer, in milliseconds.

pub fn stop(&self)

Stops the timer.

pub fn start(&self)

Starts the timer. If the timer is already running, this restarts it.

Trait Implementations

impl Default for Timer

fn default() -> Timer

Returns the “default value” for a type.

impl Drop for Timer

fn drop(&mut self)

Executes the destructor for this type.

impl From<&Timer> for ControlHandle

fn from(control: &Timer) -> Self

Converts to this type from the input type.

impl From<&mut Timer> for ControlHandle

fn from(control: &mut Timer) -> Self

Converts to this type from the input type.

impl PartialEq<ControlHandle> for Timer

fn eq(&self, other: &ControlHandle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Timer> for ControlHandle

fn eq(&self, other: &Timer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Timer

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.