Docstring update

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

diff --git a/wxPython/src/_timer.i b/wxPython/src/_timer.i
index a82aa5a626ca0f69accee8e6276b801d8681b1fa..f86f692c765cf581dcf61cd0b79f7e0ad56b62d3 100644 (file)
--- a/wxPython/src/_timer.i
+++ b/wxPython/src/_timer.i
@@ -26,49 +26,67 @@ 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);
+}
 %}
 
 
 
-%name(Timer) class wxPyTimer : public wxEvtHandler
+MustHaveApp(wxPyTimer);
+
+%rename(Timer) wxPyTimer;
+class wxPyTimer : public wxEvtHandler
 {
 public:
-    %pythonAppend wxPyTimer         "self._setCallbackInfo(self, 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 contstructor
     // then you must override Notify() inorder 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);
+
+    // Destructor.  
     virtual ~wxPyTimer();
 
-    void _setCallbackInfo(PyObject* self, PyObject* _class);
+    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 = -1);
-
+    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();
+    virtual void Notify();
 
     // return True if the timer is running
     virtual bool IsRunning() const;
@@ -81,11 +99,16 @@ public:
 
     // return the timer ID
     int GetId() const;
-   
+
+    %pythoncode {
+        def Destroy(self):
+            """NO-OP: Timers must be destroyed by normal refrence counting"""
+            pass
+    }
 };
 
 
-%pythoncode {    
+%pythoncode {
 %# For backwards compatibility with 2.4
 class PyTimer(Timer):
     def __init__(self, notify):
@@ -98,7 +121,7 @@ class PyTimer(Timer):
 
 
 EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 )
-                   
+
 };
 
 
@@ -113,16 +136,21 @@ public:
 
 
 // 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");
+%}
+//---------------------------------------------------------------------------