wxPython/src/_timer.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _timer.i
   3 // Purpose:     SWIG interface definitions wxTimer
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     18-June-1999
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 %newgroup
  18
  19 enum {
  20     // generate notifications periodically until the timer is stopped (default)
  21     wxTIMER_CONTINUOUS,
  22
  23     // only send the notification once and then stop the timer
  24     wxTIMER_ONE_SHOT,
  25 };
  26
  27 // Timer event type
  28 %constant wxEventType wxEVT_TIMER;
  29
  30
  31 //---------------------------------------------------------------------------
  32
  33
  34 %{
  35 //IMP_PYCALLBACK__(wxPyTimer, wxTimer, Notify);
  36
  37 void wxPyTimer::Notify() {
  38     bool found;
  39     wxPyBeginBlockThreads();
  40     if ((found = wxPyCBH_findCallback(m_myInst, "Notify")))
  41         wxPyCBH_callCallback(m_myInst, Py_BuildValue("()"));
  42     wxPyEndBlockThreads();
  43     if (! found)
  44         wxTimer::Notify();
  45 }
  46 void wxPyTimer::base_Notify() {
  47     wxTimer::Notify();
  48 }
  49
  50 %}
  51
  52
  53
  54 %name(Timer) class wxPyTimer : public wxEvtHandler
  55 {
  56 public:
  57     %pythonAppend wxPyTimer         "self._setCallbackInfo(self, Timer, 0)"
  58
  59
  60     // if you don't call SetOwner() or provide an owner in the contstructor
  61     // then you must override Notify() inorder to receive the timer
  62     // notification.  If the owner is set then it will get the timer
  63     // notifications which can be handled with EVT_TIMER.
  64     wxPyTimer(wxEvtHandler *owner=NULL, int id = -1);
  65     virtual ~wxPyTimer();
  66
  67     void _setCallbackInfo(PyObject* self, PyObject* _class, int incref=1);
  68
  69     // Set the owner instance that will receive the EVT_TIMER events using the
  70     // given id.
  71     void SetOwner(wxEvtHandler *owner, int id = -1);
  72
  73
  74     // start the timer: if milliseconds == -1, use the same value as for the
  75     // last Start()
  76     //
  77     // it is now valid to call Start() multiple times: this just restarts the
  78     // timer if it is already running
  79     virtual bool Start(int milliseconds = -1, bool oneShot = False);
  80
  81     // stop the timer
  82     virtual void Stop();
  83
  84     // override this in your wxTimer-derived class if you want to process timer
  85     // messages in it, use non default ctor or SetOwner() otherwise
  86     //virtual void Notify();
  87
  88     // return True if the timer is running
  89     virtual bool IsRunning() const;
  90
  91     // get the (last) timer interval in the milliseconds
  92     int GetInterval() const;
  93
  94     // return True if the timer is one shot
  95     bool IsOneShot() const;
  96
  97     // return the timer ID
  98     int GetId() const;
  99
 100 };
 101
 102
 103 %pythoncode {
 104 %# For backwards compatibility with 2.4
 105 class PyTimer(Timer):
 106     def __init__(self, notify):
 107         Timer.__init__(self)
 108         self.notify = notify
 109
 110     def Notify(self):
 111         if self.notify:
 112             self.notify()
 113
 114
 115 EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 )
 116
 117 };
 118
 119
 120
 121 class wxTimerEvent : public wxEvent
 122 {
 123 public:
 124     wxTimerEvent(int timerid = 0, int interval = 0);
 125     int GetInterval() const;
 126 };
 127
 128
 129
 130 // wxTimerRunner: starts the timer in its ctor, stops in the dtor
 131 class wxTimerRunner
 132 {
 133 public:
 134     %nokwargs wxTimerRunner;
 135     wxTimerRunner(wxTimer& timer);
 136     wxTimerRunner(wxTimer& timer, int milli, bool oneShot = False);
 137     ~wxTimerRunner();
 138
 139     void Start(int milli, bool oneShot = False);
 140 };
 141
 142
 143 //---------------------------------------------------------------------------