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 IMPLEMENT_ABSTRACT_CLASS(wxPyTimer, wxTimer);
  38
  39 wxPyTimer::wxPyTimer(wxEvtHandler *owner, int id)
  40     : wxTimer(owner, id)
  41 {
  42     if (owner == NULL)
  43         SetOwner(this);
  44 }
  45 %}
  46
  47
  48 MustHaveApp(wxPyTimer);
  49
  50 %rename(Timer) wxPyTimer;
  51 class wxPyTimer : public wxEvtHandler
  52 {
  53 public:
  54     // Don't let the OOR or callback info hold references to the object so
  55     // there won't be a reference cycle and it can clean itself up via normal
  56     // Python refcounting
  57     %pythonAppend wxPyTimer
  58         "self._setOORInfo(self, 0);" setCallbackInfo(Timer);
  59
  60     // if you don't call SetOwner() or provide an owner in the ctor
  61     // then you must override Notify() in order 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 = wxID_ANY);
  65
  66     // Destructor.
  67     virtual ~wxPyTimer();
  68
  69     void _setCallbackInfo(PyObject* self, PyObject* _class, int incref = 0);
  70
  71     // Set the owner instance that will receive the EVT_TIMER events
  72     // using the given id.
  73     void SetOwner(wxEvtHandler *owner, int id = wxID_ANY);
  74     wxEvtHandler* GetOwner();
  75
  76     // start the timer: if milliseconds == -1, use the same value as for the
  77     // last Start()
  78     //
  79     // it is now valid to call Start() multiple times: this just restarts the
  80     // timer if it is already running
  81     virtual bool Start(int milliseconds = -1, bool oneShot = false);
  82
  83     // stop the timer
  84     virtual void Stop();
  85
  86     // override this in your wxTimer-derived class if you need to process timer
  87     // messages in it; otherwise, use non-default ctor or call SetOwner()
  88     virtual void Notify();
  89
  90     // return True if the timer is running
  91     virtual bool IsRunning() const;
  92
  93     // get the (last) timer interval in milliseconds
  94     int GetInterval() const;
  95
  96     // return the timer ID
  97     int GetId() const;
  98
  99     // return True if the timer is one shot
 100     bool IsOneShot() const;
 101
 102     %pythoncode {
 103         def Destroy(self):
 104             """NO-OP: Timers must be destroyed by normal reference counting"""
 105             pass
 106     }
 107
 108     %property(Id, GetId, doc="See `GetId`");
 109     %property(Interval, GetInterval, doc="See `GetInterval`");
 110     %property(Owner, GetOwner, SetOwner, doc="See `GetOwner` and `SetOwner`");
 111 };
 112
 113
 114 %pythoncode {
 115 %# For backwards compatibility with 2.4
 116 class PyTimer(Timer):
 117     def __init__(self, notify):
 118         Timer.__init__(self)
 119         self.notify = notify
 120
 121     def Notify(self):
 122         if self.notify:
 123             self.notify()
 124
 125
 126 EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 )
 127
 128 };
 129
 130
 131
 132 class wxTimerEvent : public wxEvent
 133 {
 134 public:
 135     wxTimerEvent(int timerid = 0, int interval = 0);
 136     int GetInterval() const;
 137
 138     %property(Interval, GetInterval, doc="See `GetInterval`");
 139 };
 140
 141
 142
 143 // wxTimerRunner: starts the timer in its ctor, stops in the dtor
 144 MustHaveApp(wxTimerRunner);
 145 class wxTimerRunner
 146 {
 147 public:
 148     %nokwargs wxTimerRunner;
 149     wxTimerRunner(wxTimer& timer);
 150     wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false);
 151     ~wxTimerRunner();
 152
 153     void Start(int milli, bool oneShot = false);
 154 };
 155
 156
 157 //---------------------------------------------------------------------------
 158 %init %{
 159     wxPyPtrTypeMap_Add("wxTimer", "wxPyTimer");
 160 %}
 161 //---------------------------------------------------------------------------