Docstring update

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

diff --git a/wxPython/src/_timer.i b/wxPython/src/_timer.i
index e09e7509d037d6db899a2e2a5554c4394ce88084..f86f692c765cf581dcf61cd0b79f7e0ad56b62d3 100644 (file)
--- a/wxPython/src/_timer.i
+++ b/wxPython/src/_timer.i
@@ -32,33 +32,30 @@ 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);
+}
 %}
 
 
 
 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)"
+    // 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 contstructor
@@ -66,6 +63,8 @@ public:
     // 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);
+
+    // Destructor.  
     virtual ~wxPyTimer();
 
     void _setCallbackInfo(PyObject* self, PyObject* _class, int incref=1);
@@ -80,14 +79,14 @@ 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();
+    virtual void Notify();
 
     // return True if the timer is running
     virtual bool IsRunning() const;
@@ -101,6 +100,11 @@ public:
     // return the timer ID
     int GetId() const;
 
+    %pythoncode {
+        def Destroy(self):
+            """NO-OP: Timers must be destroyed by normal refrence counting"""
+            pass
+    }
 };
 
 
@@ -138,10 +142,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);
 };