X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7722248d7510121367c9d4db7af1156197c26e82..5f2502393e042e6e2c871ff94b7ccaf7a78b264d:/wxPython/src/_timer.i diff --git a/wxPython/src/_timer.i b/wxPython/src/_timer.i index 6d669bc44f..a883c73b66 100644 --- a/wxPython/src/_timer.i +++ b/wxPython/src/_timer.i @@ -26,62 +26,92 @@ enum { // Timer event type %constant wxEventType wxEVT_TIMER; - + //--------------------------------------------------------------------------- %{ IMP_PYCALLBACK__(wxPyTimer, wxTimer, Notify); + +IMPLEMENT_ABSTRACT_CLASS(wxPyTimer, wxTimer); + +wxPyTimer::wxPyTimer(wxEvtHandler *owner, int id) + : wxTimer(owner, id) +{ + if (owner == NULL) + SetOwner(this); +} %} +MustHaveApp(wxPyTimer); -%name(Timer) class wxPyTimer : public wxEvtHandler +%rename(Timer) wxPyTimer; +class wxPyTimer : public wxEvtHandler { public: - %addtofunc wxPyTimer "self._setCallbackInfo(self, Timer)" - - // if you don't call SetOwner() or provide an owner in the contstructor - // then you must override Notify() inorder to receive the timer + // Don't let the OOR or callback info hold references to the object so + // there won't be a reference cycle and it can clean itself up via normal + // Python refcounting + %pythonAppend wxPyTimer + "self._setCallbackInfo(self, Timer, 0); self._setOORInfo(self, 0)" + + // if you don't call SetOwner() or provide an owner in the ctor + // then you must override Notify() in order to receive the timer // notification. If the owner is set then it will get the timer // notifications which can be handled with EVT_TIMER. - wxPyTimer(wxEvtHandler *owner=NULL, int id = -1); - virtual ~wxPyTimer(); + wxPyTimer(wxEvtHandler *owner = NULL, int id = wxID_ANY); - void _setCallbackInfo(PyObject* self, PyObject* _class); + // Destructor. + virtual ~wxPyTimer(); - // Set the owner instance that will receive the EVT_TIMER events using the - // given id. - void SetOwner(wxEvtHandler *owner, int id = -1); + void _setCallbackInfo(PyObject* self, PyObject* _class, int incref = 1); + // Set the owner instance that will receive the EVT_TIMER events + // using the given id. + void SetOwner(wxEvtHandler *owner, int id = wxID_ANY); + wxEvtHandler* GetOwner(); // start the timer: if milliseconds == -1, use the same value as for the // last Start() // // it is now valid to call Start() multiple times: this just restarts the // timer if it is already running - virtual bool Start(int milliseconds = -1, bool oneShot = False); + virtual bool Start(int milliseconds = -1, bool oneShot = false); // stop the timer virtual void Stop(); - // override this in your wxTimer-derived class if you want to process timer - // messages in it, use non default ctor or SetOwner() otherwise - //virtual void Notify(); + // override this in your wxTimer-derived class if you need to process timer + // messages in it; otherwise, use non-default ctor or call SetOwner() + virtual void Notify(); // return True if the timer is running virtual bool IsRunning() const; - // get the (last) timer interval in the milliseconds + // get the (last) timer interval in milliseconds int GetInterval() const; + // return the timer ID + int GetId() const; + // return True if the timer is one shot bool IsOneShot() const; + + %pythoncode { + def Destroy(self): + """NO-OP: Timers must be destroyed by normal reference counting""" + pass + } + + %property(Id, GetId, doc="See `GetId`"); + %property(Interval, GetInterval, doc="See `GetInterval`"); + %property(Owner, GetOwner, SetOwner, doc="See `GetOwner` and `SetOwner`"); }; -%pythoncode { +%pythoncode { %# For backwards compatibility with 2.4 class PyTimer(Timer): def __init__(self, notify): @@ -94,7 +124,7 @@ class PyTimer(Timer): EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 ) - + }; @@ -104,21 +134,28 @@ class wxTimerEvent : public wxEvent public: wxTimerEvent(int timerid = 0, int interval = 0); int GetInterval() const; + + %property(Interval, GetInterval, doc="See `GetInterval`"); }; // wxTimerRunner: starts the timer in its ctor, stops in the dtor +MustHaveApp(wxTimerRunner); class wxTimerRunner { public: %nokwargs wxTimerRunner; wxTimerRunner(wxTimer& timer); - wxTimerRunner(wxTimer& timer, int milli, bool oneShot = False); + wxTimerRunner(wxTimer& timer, int milli, bool oneShot = false); ~wxTimerRunner(); - void Start(int milli, bool oneShot = False); + void Start(int milli, bool oneShot = false); }; //--------------------------------------------------------------------------- +%init %{ + wxPyPtrTypeMap_Add("wxTimer", "wxPyTimer"); +%} +//---------------------------------------------------------------------------