Struct droom_ui::timer::Timer
[−]
[src]
pub struct Timer(_);
A timer which periodically invokes a callback when the time is up.
Ownership
The timer must be manually destroyed, thus for the user safety it returns a guarded object
on the new constructor.
Please refer to the crate level documentation of IUP-Rust (the main doc page) for details on ownership of elements.
Methods
impl Timer[src]
fn new() -> Guard<Timer>
Constructs a timer.
fn time(&self) -> Option<u32>
Gets the set time interval in milliseconds or None if not set.
fn set_time(&mut self, time: u32) -> Self
Sets the time interval in milliseconds.
In Windows the minimum value is 10ms.
fn run(&mut self) -> Self
Starts the timer.
Does nothing if the TIME attribute is not set i.e. set_time.
If you have multiple threads start the timer in the main thread.
fn stop(&mut self) -> Self
Stops the timer.
fn is_running(&self) -> bool
Returns the current timer state.
Trait Implementations
impl Element for Timer[src]
fn raw(&self) -> *mut Ihandle
Gets the raw IUP handle associated with this element.
unsafe fn from_raw_unchecked(ih: *mut Ihandle) -> Self
Constructs an Element from a raw IUP handle. Read more
unsafe fn target_classname() -> &'static str
Gets the [class name][1] the derived object should be targeting. [1]: http://webserver2.tecgraf.puc-rio.br/iup/en/func/iupgetclassname.html Read more
fn from_handle(handle: Handle) -> Result<Self, Handle>
Constructs a specialized Element object from a general Handle if they are compatible.
fn from_name<S: Into<String>>(name: S) -> Option<Handle>
Constructs from a name associated with a element handle (with Element::add_handle_name or LED).
fn from_raw(ih: *mut Ihandle) -> Self
Constructs an Element from a raw IUP handle. Read more
unsafe fn classname(&self) -> &CStr
Gets the [class name][1] of this element. [1]: http://webserver2.tecgraf.puc-rio.br/iup/en/func/iupgetclassname.html Read more
fn destroy(self)
Destroys an interface element and all its children. Read more
fn does_attrib_exist(&self, cname: &CString) -> bool
Checks if a specific attribute exists in the element.
fn attribs(&self) -> Vec<String>
Returns the names of all attributes of an element that are set in its internal hash table only. Read more
fn set_attrib<S1, S2>(&mut self, name: S1, value: S2) -> Self where S1: Into<String>, S2: Into<String>
Sets an interface element attribute. Read more
fn attrib<S: Into<String>>(&self, name: S) -> Option<String>
Gets an interface element attribute. Read more
fn set_attrib_data<S1>(&mut self, name: S1, data: *const c_void) -> Self where S1: Into<String>
Sets a raw interface element attribute. Read more
fn attrib_data<S1>(&mut self, name: S1) -> *mut c_void where S1: Into<String>
Gets a raw interface element attribute.
fn set_attrib_handle<S1, E>(&mut self, name: S1, elem: E) -> Self where S1: Into<String>, E: Element
Associates a element with an attribute. Read more
fn attrib_handle<S1>(&mut self, name: S1) -> Option<Handle> where S1: Into<String>
Gets the handle associated with an attribute.
fn clear_attrib<S: Into<String>>(&mut self, name: S) -> Self
Clears the value associated with an attribute and use the default value.
fn reset_attrib<S: Into<String>>(&mut self, name: S) -> Self
Removes an attribute from element and its children if the attrib is inheritable. Read more
fn handle_name(&self) -> Option<String>
Returns the identifier of an interface element that has an associated handle name using Element::add_handle_name or using LED. Read more
fn add_handle_name<S: Into<String>>(&self, name: S) -> Option<Handle>
Associates a handle name with an interface element. Read more
fn clear_handle_name<S: Into<String>>(name: S) -> Option<Handle>
Clears the handle name association on the specified name. Read more
impl Debug for Timer[src]
impl Copy for Timer[src]
impl Clone for Timer[src]
fn clone(&self) -> Timer
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0
Performs copy-assignment from source. Read more
impl DestroyCb for Timer[src]
fn set_destroy_cb<F>(&mut self, cb: F) -> Self where F: Callback<(Self,)>
fn remove_destroy_cb(&mut self) -> Option<Box<Callback<(Self,)>>>
impl ActionCb for Timer[src]
Called every time the defined time interval is reached.
To stop the callback from being called simply stop de timer with RUN=NO or Timer::stop.
CallbackReturn::Close will be processed.