Change event names to clarify that they are only fired by button clicks, and note...

[wxWidgets.git] / wxPython / src / _timer.i

diff --git a/wxPython/src/_timer.i b/wxPython/src/_timer.i
index e09e7509d037d6db899a2e2a5554c4394ce88084..3f227d5d376abf89f695c2735fd986fb6c2d0a20 100644 (file)
--- a/wxPython/src/_timer.i
+++ b/wxPython/src/_timer.i
@@ -32,47 +32,51 @@ enum {
 
 
 %{
-//IMP_PYCALLBACK__(wxPyTimer, wxTimer, Notify);
+IMP_PYCALLBACK__(wxPyTimer, wxTimer, Notify);
 
 IMPLEMENT_ABSTRACT_CLASS(wxPyTimer, wxTimer);
-    
-void wxPyTimer::Notify() {
-    bool found;
-    bool blocked = wxPyBeginBlockThreads();
-    if ((found = wxPyCBH_findCallback(m_myInst, "Notify")))
-        wxPyCBH_callCallback(m_myInst, Py_BuildValue("()"));
-    wxPyEndBlockThreads(blocked);
-    if (! found)
-        wxTimer::Notify();
-}   
-void wxPyTimer::base_Notify() {
-    wxTimer::Notify();
+
+wxPyTimer::wxPyTimer(wxEvtHandler *owner, int id)
+    : wxTimer(owner, id)
+{
+    if (owner == NULL)
+        SetOwner(this);
 }
 
-%}
+wxPyTimer::~wxPyTimer()
+{
+//    printf("-=* ~wxPyTimer\n");
+}
 
+%}
 
 
 MustHaveApp(wxPyTimer);
 
-%name(Timer) class wxPyTimer : public wxEvtHandler
+%rename(Timer) wxPyTimer;
+class wxPyTimer : public wxEvtHandler
 {
 public:
-    %pythonAppend wxPyTimer         "self._setCallbackInfo(self, Timer, 0); self._setOORInfo(self)"
-
-
-    // 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._setOORInfo(self,0); self.this.own(True); " setCallbackInfo(Timer); 
+
+    // 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);
+    wxPyTimer(wxEvtHandler *owner = NULL, int id = wxID_ANY);
+
+    // Destructor.  
     virtual ~wxPyTimer();
 
-    void _setCallbackInfo(PyObject* self, PyObject* _class, int incref=1);
+    void _setCallbackInfo(PyObject* self, PyObject* _class, int incref = 0);
 
-    // Set the owner instance that will receive the EVT_TIMER events using the
-    // given id.
-    void SetOwner(wxEvtHandler *owner, int id = -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
@@ -80,27 +84,36 @@ public:
     //
     // 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;
 
-    // return the timer ID
-    int GetId() 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`");
 };
 
 
@@ -127,6 +140,8 @@ class wxTimerEvent : public wxEvent
 public:
     wxTimerEvent(int timerid = 0, int interval = 0);
     int GetInterval() const;
+
+    %property(Interval, GetInterval, doc="See `GetInterval`");
 };
 
 
@@ -138,10 +153,10 @@ 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);
 };