Blender  V3.3
Public Member Functions | List of all members
GHOST_ITimerTask Class Referenceabstract

#include <GHOST_ITimerTask.h>

Inheritance diagram for GHOST_ITimerTask:
GHOST_TimerTask

Public Member Functions

virtual ~GHOST_ITimerTask ()
 
virtual GHOST_TimerProcPtr getTimerProc () const =0
 
virtual void setTimerProc (const GHOST_TimerProcPtr timerProc)=0
 
virtual GHOST_TUserDataPtr getUserData () const =0
 
virtual void setUserData (const GHOST_TUserDataPtr userData)=0
 

Detailed Description

Interface for a timer task. Timer tasks are created by the system and can be installed by the system. After installation, the timer callback-procedure or "timerProc" will be called periodically. You should not need to inherit this class. It is passed to the application in the timer-callback.

Note that GHOST processes timers in the UI thread. You should ask GHOST process messages in order for the timer-callbacks to be called.

See also
GHOST_ISystem::installTimer
GHOST_TimerProcPtr

Definition at line 25 of file GHOST_ITimerTask.h.

Constructor & Destructor Documentation

◆ ~GHOST_ITimerTask()

virtual GHOST_ITimerTask::~GHOST_ITimerTask ( )
inlinevirtual

Destructor.

Definition at line 30 of file GHOST_ITimerTask.h.

Member Function Documentation

◆ getTimerProc()

virtual GHOST_TimerProcPtr GHOST_ITimerTask::getTimerProc ( ) const
pure virtual

Returns the timer callback.

Returns
The timer callback.

Implemented in GHOST_TimerTask.

Referenced by GHOST_GetTimerProc(), and keyboard_handle_key_repeat_reset().

◆ getUserData()

virtual GHOST_TUserDataPtr GHOST_ITimerTask::getUserData ( ) const
pure virtual

Returns the timer user data.

Returns
The timer user data.

Implemented in GHOST_TimerTask.

Referenced by GHOST_GetTimerTaskUserData().

◆ setTimerProc()

virtual void GHOST_ITimerTask::setTimerProc ( const GHOST_TimerProcPtr  timerProc)
pure virtual

Changes the timer callback.

Parameters
timerProcThe timer callback.

Implemented in GHOST_TimerTask.

Referenced by GHOST_SetTimerProc().

◆ setUserData()

virtual void GHOST_ITimerTask::setUserData ( const GHOST_TUserDataPtr  userData)
pure virtual

Changes the time user data.

Parameters
userDataThe timer user data.

Implemented in GHOST_TimerTask.

Referenced by GHOST_SetTimerTaskUserData().


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