diff options
author | Max Horn | 2004-03-15 01:18:47 +0000 |
---|---|---|
committer | Max Horn | 2004-03-15 01:18:47 +0000 |
commit | e8f7214acbfa67874b230edba9cdbc38288c6a7e (patch) | |
tree | 2320a25d223ada20cff51a00bfb54a8c2961d5cd /common/system.h | |
parent | 08332ab559f45366e3c965990d7ecf7f6ebc8db7 (diff) | |
download | scummvm-rg350-e8f7214acbfa67874b230edba9cdbc38288c6a7e.tar.gz scummvm-rg350-e8f7214acbfa67874b230edba9cdbc38288c6a7e.tar.bz2 scummvm-rg350-e8f7214acbfa67874b230edba9cdbc38288c6a7e.zip |
Renamed OSystem::set_timer() to setTimerCallback(); more OSystem Doxygen changes
svn-id: r13289
Diffstat (limited to 'common/system.h')
-rw-r--r-- | common/system.h | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/common/system.h b/common/system.h index 3db60fcf9d..3afe519617 100644 --- a/common/system.h +++ b/common/system.h @@ -339,10 +339,11 @@ public: * can be passed to poll_event. */ struct Event { + /** The type of the event. */ EventCode event_code; /** - * Keyboard data; only valid for keyboard events (i.e. EVENT_KEYDOWN - * and EVENT_KEYUP). For all other event types, content is undefined. + * Keyboard data; only valid for keyboard events (EVENT_KEYDOWN and + * EVENT_KEYUP). For all other event types, content is undefined. */ struct { /** @@ -367,6 +368,12 @@ public: */ byte flags; } kbd; + /** + * The mouse coordinates, in virtual screen coordinates. Only valid + * for mouse events. + * Virtual screen coordinatest means: the coordinate system of the + * screen area as defined by the most recent call to initSize(). + */ Common::Point mouse; }; @@ -384,10 +391,19 @@ public: virtual void delay_msecs(uint msecs) = 0; /** - * Set the timer callback. + * Set the timer callback, a function which is periodically invoked by the + * backend. This can for example be done via a background thread. + * There is at most one active timer; if this method is called while there + * is already an active timer, then the new timer callback should replace + * the previous one. In particular, passing a callback pointer value of 0 + * is legal and can be used to clear the current timer callback. * @see Common::Timer + * + * @param callback pointer to the callback. May be 0 to reset the timer + * @param interval the intervall (in milliseconds) between invocations + * of the callback */ - virtual void set_timer(TimerProc callback, int interval) = 0; + virtual void setTimerCallback(TimerProc callback, int interval) = 0; //@} |