src::_core_ex::CallLater Class Reference

Inheritance diagram for src::_core_ex::CallLater:

Public Member Functions
def	__del__
def	__init__
def	GetInterval
def	GetResult
def	HasRun
def	IsRunning
def	Notify
def	SetArgs
def	Start
def	Stop
Public Attributes
	args
	callable
	hasRun
	kwargs
	millis
	result
	runCount
	running
	timer
Static Public Attributes
	Restart = Start
Properties
	Interval = property(GetInterval)
	Result = property(GetResult)

Detailed Description

A convenience class for `wx.Timer`, that calls the given callable
object once after the given amount of milliseconds, passing any
positional or keyword args.  The return value of the callable is
availbale after it has been run with the `GetResult` method.

If you don't need to get the return value or restart the timer
then there is no need to hold a reference to this object.  It will
hold a reference to itself while the timer is running (the timer
has a reference to self.Notify) but the cycle will be broken when
the timer completes, automatically cleaning up the wx.CallLater
object.

:see: `wx.CallAfter`

Definition at line 170 of file _core_ex.py.

Member Function Documentation

def src::_core_ex::CallLater::__del__ ( self )

Definition at line 197 of file _core_ex.py.

def src::_core_ex::CallLater::__init__	(	self,
		millis,
		callable,
		args,
		kwargs
	)

Definition at line 186 of file _core_ex.py.

def src::_core_ex::CallLater::GetInterval ( self )

Definition at line 226 of file _core_ex.py.

def src::_core_ex::CallLater::GetResult ( self )

Definition at line 251 of file _core_ex.py.

def src::_core_ex::CallLater::HasRun ( self )

Definition at line 248 of file _core_ex.py.

def src::_core_ex::CallLater::IsRunning ( self )

Definition at line 233 of file _core_ex.py.

def src::_core_ex::CallLater::Notify ( self )

The timer has expired so call the callable.

Definition at line 254 of file _core_ex.py.

def src::_core_ex::CallLater::SetArgs	(	self,
		args,
		kwargs
	)

(Re)set the args passed to the callable object.  This is
useful in conjunction with Restart if you want to schedule a
new call to the same callable object but with different
parameters.

Definition at line 237 of file _core_ex.py.