Timer class that invokes a callback on a specified interval. More...

#include <timer.h>

Public Member Functions
virtual std::function< void()> &	func_expired ()=0
	Callback invoked every time the timer interval occurs. More...

virtual bool	repeating () const =0
	Returns true if the timer repeats until it is stopped. More...

virtual void	start (unsigned int timeout, bool repeat=true)=0
	Starts the timer. Timeout in milliseconds. More...

virtual void	stop ()=0
	Stop the timer. More...

virtual unsigned int	timeout () const =0
	Returns the current timeout. In milliseconds. More...

Static Public Member Functions
static std::shared_ptr< Timer >	create ()
	Constructs a timer object. More...

Detailed Description

Timer class that invokes a callback on a specified interval.

Member Function Documentation

static std::shared_ptr<Timer> uicore::Timer::create ( )

static

Constructs a timer object.

virtual std::function<void()>& uicore::Timer::func_expired ( )

pure virtual

Callback invoked every time the timer interval occurs.

virtual bool uicore::Timer::repeating ( ) const

pure virtual

Returns true if the timer repeats until it is stopped.

virtual void uicore::Timer::start	(	unsigned int	timeout,
		bool	repeat = `true`
	)

pure virtual

Starts the timer. Timeout in milliseconds.

virtual void uicore::Timer::stop ( )

pure virtual

Stop the timer.

virtual unsigned int uicore::Timer::timeout ( ) const

pure virtual

Returns the current timeout. In milliseconds.

The documentation for this class was generated from the following file: