From: David Surovell <davids@osafoundation.org>
Date: Fri, 10 Mar 2006 00:01:28 +0000 (+0000)
Subject: cleanup magic number usage and comments
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/0e859e32234b3178254146f31653f478de0c5fba

cleanup magic number usage and comments


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@37943 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/wxPython/src/_timer.i b/wxPython/src/_timer.i
index f86f692c76..10aeddc278 100644
--- a/wxPython/src/_timer.i
+++ b/wxPython/src/_timer.i
@@ -39,12 +39,12 @@ IMPLEMENT_ABSTRACT_CLASS(wxPyTimer, wxTimer);
 wxPyTimer::wxPyTimer(wxEvtHandler *owner, int id)
     : wxTimer(owner, id)
 {
-    if (owner == NULL) SetOwner(this);
+    if (owner == NULL)
+        SetOwner(this);
 }
 %}
 
 
-
 MustHaveApp(wxPyTimer);
 
 %rename(Timer) wxPyTimer;
@@ -57,21 +57,20 @@ public:
     %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
+    // 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 = 1);
 
-    // 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
@@ -84,25 +83,25 @@ public:
     // 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
+    // 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 True if the timer is one shot
-    bool IsOneShot() 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 refrence counting"""
+            """NO-OP: Timers must be destroyed by normal reference counting"""
             pass
     }
 };