diff options
author | Michael Meeks <michael.meeks@collabora.com> | 2014-09-25 16:20:36 +0100 |
---|---|---|
committer | Michael Meeks <michael.meeks@collabora.com> | 2014-09-25 16:39:12 +0100 |
commit | 48e1675ca204b6ad68f5844e21de1f7485cfd306 (patch) | |
tree | 8911dd7df7ad37a2635330645a70cdcaea5ff259 /include/vcl/timer.hxx | |
parent | fdo#84000 - unit test timers / main-loop bits. (diff) | |
download | core-48e1675ca204b6ad68f5844e21de1f7485cfd306.tar.gz core-48e1675ca204b6ad68f5844e21de1f7485cfd306.zip |
vcl: comment timer classes at least minimally.
Change-Id: Iabc76b3e78afa491a38fa04d648f48f15ac3870e
Diffstat (limited to 'include/vcl/timer.hxx')
-rw-r--r-- | include/vcl/timer.hxx | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/include/vcl/timer.hxx b/include/vcl/timer.hxx index 665978076727..d3ebe1a256e5 100644 --- a/include/vcl/timer.hxx +++ b/include/vcl/timer.hxx @@ -27,6 +27,7 @@ struct ImplTimerData; struct ImplSVData; +/// Base-class for timers - usually a simple, one-shot timeout class VCL_DLLPUBLIC Timer { protected: @@ -51,6 +52,7 @@ public: sal_uLong GetTimeout() const { return mnTimeout; } bool IsActive() const { return mbActive; } + /// Make it possible to associate a callback with this timeout void SetTimeoutHdl( const Link& rLink ) { maTimeoutHdl = rLink; } const Link& GetTimeoutHdl() const { return maTimeoutHdl; } @@ -60,7 +62,8 @@ public: static void ImplTimerCallbackProc(); }; - +/// An auto-timer is a multi-shot timer re-emitting itself at +/// interval until destroyed. class VCL_DLLPUBLIC AutoTimer : public Timer { public: |