Merge branch 'blender2.7'
[blender.git] / intern / ghost / GHOST_ITimerTask.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup GHOST
22  * Declaration of GHOST_ITimerTask interface class.
23  */
24
25 #ifndef __GHOST_ITIMERTASK_H__
26 #define __GHOST_ITIMERTASK_H__
27
28 #include "GHOST_Types.h"
29
30
31 /**
32  * Interface for a timer task.
33  * Timer tasks are created by the system and can be installed by the system.
34  * After installation, the timer callback-procedure or "timerProc" will be called
35  * periodically. You should not need to inherit this class. It is passed to the
36  * application in the timer-callback.<br>
37  * <br>
38  * Note that GHOST processes timers in the UI thread. You should ask GHOST
39  * process messages in order for the timer-callbacks to be called.
40  * \see GHOST_ISystem#installTimer
41  * \see GHOST_TimerProcPtr
42  */
43 class GHOST_ITimerTask
44 {
45 public:
46         /**
47          * Destructor.
48          */
49         virtual ~GHOST_ITimerTask()
50         {
51         }
52
53         /**
54          * Returns the timer callback.
55          * \return The timer callback.
56          */
57         virtual GHOST_TimerProcPtr getTimerProc() const = 0;
58
59         /**
60          * Changes the timer callback.
61          * \param timerProc The timer callback.
62          */
63         virtual void setTimerProc(const GHOST_TimerProcPtr timerProc) = 0;
64
65         /**
66          * Returns the timer user data.
67          * \return The timer user data.
68          */
69         virtual GHOST_TUserDataPtr getUserData() const = 0;
70
71         /**
72          * Changes the time user data.
73          * \param userData: The timer user data.
74          */
75         virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
76
77
78 #ifdef WITH_CXX_GUARDEDALLOC
79         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_ITimerTask")
80 #endif
81 };
82
83 #endif // __GHOST_ITIMERTASK_H__