wxPyTimer::wxPyTimer(wxEvtHandler *owner, int id)
: wxTimer(owner, id)
{
- if (owner == NULL) SetOwner(this);
+ if (owner == NULL)
+ SetOwner(this);
}
%}
-
MustHaveApp(wxPyTimer);
%rename(Timer) wxPyTimer;
%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
// 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
}
+
+ %property(Id, GetId, doc="See `GetId`");
+ %property(Interval, GetInterval, doc="See `GetInterval`");
+ %property(Owner, GetOwner, SetOwner, doc="See `GetOwner` and `SetOwner`");
};
public:
wxTimerEvent(int timerid = 0, int interval = 0);
int GetInterval() const;
+
+ %property(Interval, GetInterval, doc="See `GetInterval`");
};