CFx SDK Documentation  2020SP3
Public Member Functions | Static Public Member Functions | List of all members
CFxUITimer Class Reference

#include <FxUITimer.h>

Inheritance diagram for CFxUITimer:
CFxUIObject

Public Member Functions

 CFxUITimer ()
 
 ~CFxUITimer ()
 
void start (int msec)
 
void stop ()
 
bool isActive () const
 
CFxUISignal< void(void)> & timeout ()
 
- Public Member Functions inherited from CFxUIObject
 CFxUIObject ()
 
virtual ~CFxUIObject ()
 
FxNativeHandle getHandle () const
 
void setHandle (FxNativeHandle handle)
 
void setParent (CFxUIObject *parent)
 
CFxUIObjectparent ()
 
const CFxUIObjectparent () const
 
void setObjectName (const CFxUIString &objectName)
 
CFxUIString objectName () const
 
bool setProperty (const char *name, const CFxUIVariant &value)
 
CFxUIVariant property (const char *name)
 
CFxUIList< CFxUIObject * > children () const
 
template<typename T >
CFxUIList< T > findChildren (const CFxUIString &name=CFxUIString())
 
void blockSignals (bool block)
 
bool signalsBlocked () const
 

Static Public Member Functions

static void singleShot (int msec, std::function< void() > function)
 

Additional Inherited Members

- Protected Member Functions inherited from CFxUIObject
CFxUIObjectsender ()
 
- Protected Attributes inherited from CFxUIObject
CFxUIObjectImpl * m_pImpl
 
CFxUIObjectData * m_pData
 

Detailed Description

Class CFxUITimer provides repetitive and single-shot timers.

Definition at line 30 of file FxUITimer.h.

Constructor & Destructor Documentation

◆ CFxUITimer()

CFxUITimer::CFxUITimer ( )

Constructor

◆ ~CFxUITimer()

CFxUITimer::~CFxUITimer ( )

Destructor

Member Function Documentation

◆ isActive()

bool CFxUITimer::isActive ( ) const

Returns if timer is running.

Parameters
<em>bool</em>It returns true if the timer is running (pending); otherwise returns false.

◆ singleShot()

static void CFxUITimer::singleShot ( int  msec,
std::function< void() >  function 
)
static

Static function calls a slot after a given time interval.

Parameters
msec
function

◆ start()

void CFxUITimer::start ( int  msec)

Starts or restarts the timer with a timeout of duration msec milliseconds.

If the timer is already running, it will be stopped and restarted.

Parameters
msecInput

◆ stop()

void CFxUITimer::stop ( )

Stops the timer.

◆ timeout()

CFxUISignal<void( void )>& CFxUITimer::timeout ( )

Signal is emitted when the timer times out.


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