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 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // NB: this class is implemented in scrolbar.cpp
  13
  14 #include "wx/timer.h"
  15
  16 // ----------------------------------------------------------------------------
  17 // wxScrollTimer: the timer used when the arrow or scrollbar shaft is kept
  18 // pressed
  19 // ----------------------------------------------------------------------------
  20
  21 class WXDLLEXPORT wxScrollTimer : public wxTimer
  22 {
  23 public:
  24     // default ctor
  25     wxScrollTimer();
  26
  27     // start generating the events
  28     void StartAutoScroll();
  29
  30     // the base class method
  31     virtual void Notify();
  32
  33 protected:
  34     // to implement in derived classes: perform the scroll action and return
  35     // TRUE to continue scrolling or FALSE to stop
  36     virtual bool DoNotify() = 0;
  37
  38     // should we skip the next timer event?
  39     bool m_skipNext;
  40 };
  41