include/wx/univ/scrtimer.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/univ/scrtimer.h
   3 // Purpose:     wxScrollTimer: small helper class for wxScrollArrow/Thumb
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     18.02.01
   7 // Copyright:   (c) 2001 SciTech Software, Inc. (www.scitechsoft.com)
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_UNIV_SCRTIMER_H
  12 #define _WX_UNIV_SCRTIMER_H
  13
  14 // NB: this class is implemented in scrolbar.cpp
  15
  16 #include "wx/defs.h"
  17
  18 #if wxUSE_TIMER
  19
  20 #include "wx/timer.h"
  21
  22 // ----------------------------------------------------------------------------
  23 // wxScrollTimer: the timer used when the arrow or scrollbar shaft is kept
  24 // pressed
  25 // ----------------------------------------------------------------------------
  26
  27 class WXDLLIMPEXP_CORE wxScrollTimer : public wxTimer
  28 {
  29 public:
  30     // default ctor
  31     wxScrollTimer();
  32
  33     // start generating the events
  34     void StartAutoScroll();
  35
  36     // the base class method
  37     virtual void Notify();
  38
  39 protected:
  40     // to implement in derived classes: perform the scroll action and return
  41     // true to continue scrolling or false to stop
  42     virtual bool DoNotify() = 0;
  43
  44     // should we skip the next timer event?
  45     bool m_skipNext;
  46 };
  47
  48 #endif // wxUSE_TIMER
  49
  50 #endif // _WX_UNIV_SCRTIMER_H