Initial revision
[blender.git] / intern / ghost / GHOST_ITimerTask.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        May 31, 2001
38  */
39
40 #ifndef _GHOST_ITIMER_TASK_H_
41 #define _GHOST_ITIMER_TASK_H_
42
43
44 #include "GHOST_Types.h"
45
46
47 /**
48  * Interface for a timer task.
49  * @author      Maarten Gribnau
50  * @date        May 31, 2001
51  */
52 class GHOST_ITimerTask
53 {
54 public:
55         /**
56          * Destructor.
57          */
58         virtual ~GHOST_ITimerTask()
59         {
60         }
61
62         /**
63          * Returns the timer callback.
64          * @return The timer callback.
65          */
66         inline virtual GHOST_TimerProcPtr getTimerProc() const = 0;
67
68         /**
69          * Changes the timer callback.
70          * @param timerProc The timer callback.
71          */
72         inline virtual void setTimerProc(const GHOST_TimerProcPtr timerProc) = 0;
73
74         /**
75          * Returns the timer user data.
76          * @return The timer user data.
77          */
78         inline virtual GHOST_TUserDataPtr getUserData() const = 0;
79         
80         /**
81          * Changes the time user data.
82          * @param data The timer user data.
83          */
84         virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
85 };
86
87
88 #endif // _GHOST_ITIMER_TASK_H_