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 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2001 SciTech Software, Inc. (www.scitechsoft.com)
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIV_SCRTIMER_H
  13 #define _WX_UNIV_SCRTIMER_H
  14
  15 // NB: this class is implemented in scrolbar.cpp
  16
  17 #include "wx/timer.h"
  18
  19 // ----------------------------------------------------------------------------
  20 // wxScrollTimer: the timer used when the arrow or scrollbar shaft is kept
  21 // pressed
  22 // ----------------------------------------------------------------------------
  23
  24 class WXDLLEXPORT wxScrollTimer : public wxTimer
  25 {
  26 public:
  27     // default ctor
  28     wxScrollTimer();
  29
  30     // start generating the events
  31     void StartAutoScroll();
  32
  33     // the base class method
  34     virtual void Notify();
  35
  36 protected:
  37     // to implement in derived classes: perform the scroll action and return
  38     // true to continue scrolling or false to stop
  39     virtual bool DoNotify() = 0;
  40
  41     // should we skip the next timer event?
  42     bool m_skipNext;
  43 };
  44
  45 #endif // _WX_UNIV_SCRTIMER_H