Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cleanup magic number usage and comments

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@37943 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
David Surovell
2006-03-10 00:01:28 +00:00
parent c45c32033d
commit 0e859e3223
1 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
wxPython/src/_timer.i
View File

@@ -39,12 +39,12 @@ IMPLEMENT_ABSTRACT_CLASS(wxPyTimer, wxTimer);
wxPyTimer::wxPyTimer(wxEvtHandler *owner, int id) wxPyTimer::wxPyTimer(wxEvtHandler *owner, int id)
: wxTimer(owner, id) : wxTimer(owner, id)
{ {
if (owner == NULL) SetOwner(this); if (owner == NULL)
SetOwner(this);
} }
%} %}
MustHaveApp(wxPyTimer); MustHaveApp(wxPyTimer);
%rename(Timer) wxPyTimer; %rename(Timer) wxPyTimer;
@@ -57,21 +57,20 @@ public:
%pythonAppend wxPyTimer %pythonAppend wxPyTimer
"self._setCallbackInfo(self, Timer, 0); self._setOORInfo(self, 0)" "self._setCallbackInfo(self, Timer, 0); self._setOORInfo(self, 0)"
// if you don't call SetOwner() or provide an owner in the ctor
// if you don't call SetOwner() or provide an owner in the contstructor // then you must override Notify() in order to receive the timer
// then you must override Notify() inorder to receive the timer
// notification. If the owner is set then it will get the timer // notification. If the owner is set then it will get the timer
// notifications which can be handled with EVT_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. // Destructor.
virtual ~wxPyTimer(); 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 // Set the owner instance that will receive the EVT_TIMER events
// given id. // using the given id.
void SetOwner(wxEvtHandler *owner, int id = -1); void SetOwner(wxEvtHandler *owner, int id = wxID_ANY);
wxEvtHandler* GetOwner(); wxEvtHandler* GetOwner();
// start the timer: if milliseconds == -1, use the same value as for the // start the timer: if milliseconds == -1, use the same value as for the
@@ -84,25 +83,25 @@ public:
// stop the timer // stop the timer
virtual void Stop(); virtual void Stop();
// override this in your wxTimer-derived class if you want to process timer // override this in your wxTimer-derived class if you need to process timer
// messages in it, use non default ctor or SetOwner() otherwise // messages in it; otherwise, use non-default ctor or call SetOwner()
virtual void Notify(); virtual void Notify();
// return True if the timer is running // return True if the timer is running
virtual bool IsRunning() const; virtual bool IsRunning() const;
// get the (last) timer interval in the milliseconds // get the (last) timer interval in milliseconds
int GetInterval() const; int GetInterval() const;
// return True if the timer is one shot
bool IsOneShot() const;
// return the timer ID // return the timer ID
int GetId() const; int GetId() const;
// return True if the timer is one shot
bool IsOneShot() const;
%pythoncode { %pythoncode {
def Destroy(self): def Destroy(self):
"""NO-OP: Timers must be destroyed by normal refrence counting""" """NO-OP: Timers must be destroyed by normal reference counting"""
pass pass
} }
}; };