[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[paragui-cvs] CVS: paragui/include pgtimerobject.h,1.1.2.3,1.1.2.4
From: |
Alexander Pipelka <address@hidden> |
Subject: |
[paragui-cvs] CVS: paragui/include pgtimerobject.h,1.1.2.3,1.1.2.4 |
Date: |
Thu, 30 May 2002 14:40:47 -0400 |
Update of /cvsroot/paragui/paragui/include
In directory subversions:/tmp/cvs-serv17724/include
Modified Files:
Tag: devel-1-0
pgtimerobject.h
Log Message:
added header and docs to pgtimerobject.h
Index: pgtimerobject.h
===================================================================
RCS file: /cvsroot/paragui/paragui/include/Attic/pgtimerobject.h,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -C2 -r1.1.2.3 -r1.1.2.4
*** pgtimerobject.h 29 May 2002 13:33:01 -0000 1.1.2.3
--- pgtimerobject.h 30 May 2002 18:40:44 -0000 1.1.2.4
***************
*** 1,2 ****
--- 1,30 ----
+ /*
+ ParaGUI - crossplatform widgetset
+ Copyright (C) 2000,2001,2002 Alexander Pipelka
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Library General Public License for more details.
+
+ You should have received a copy of the GNU Library General Public
+ License along with this library; if not, write to the Free
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+ Alexander Pipelka
+ address@hidden
+
+ Last Update: $Author$
+ Update Date: $Date$
+ Source File: $Source$
+ CVS/RCS Revision: $Revision$
+ Status: $State$
+ */
+
#ifndef PG_TIMEROBJECT_H
#define PG_TIMEROBJECT_H
***************
*** 7,20 ****
--- 35,76 ----
typedef Uint32 PG_TimerID;
+ /**
+ @author Alexander Pipelka
+
+ @short A class to handle periodical timers
+
+ This class encapsulates the SDL_AddTimer, SDL_RemoveTimer functions.
+ */
+
class PG_TimerObject {
public:
+ /**
+ Constructor of the PG_TimerObject class.
+ The constructor also calls SDL_InitSubSystem(SDL_Timer) to enable
+ the SDL timer subsystem.
+ */
PG_TimerObject();
virtual ~PG_TimerObject();
+ /**
+ Add a timer to the object.
+
+ @param interval timer intervall in ms
+ @return id of the timer
+
+ You can add any number of timers to an object.
+ After the timer-interval the virtual function eventTimer(PG_TimerID id,
Uint32 interval)
+ will be called
+ */
PG_TimerID AddTimer(Uint32 interval);
+ /**
+ Remove a timer
+
+ @param id id of the timer to remove
+ */
bool RemoveTimer(PG_TimerID id);
***************
*** 23,27 ****
--- 79,91 ----
void StopTimer();
+ /**
+ timer event handler
+
+ @param id id of the elapsed timer
+ @param interval timer interval
+ @return should return the interval of the next timer event
+ */
virtual Uint32 eventTimer(PG_TimerID id, Uint32 interval);
+
virtual Uint32 eventTimer(Uint32 interval);
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [paragui-cvs] CVS: paragui/include pgtimerobject.h,1.1.2.3,1.1.2.4,
Alexander Pipelka <address@hidden> <=