************
wx.CallLater
************

Inheritance diagram for `wx.CallLater`:

|

.. inheritance-diagram:: wx.CallLater

|

Description
===========

A convenience class for `wx.Timer <wx.Timer.html>`_, 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 available after it has been run with the `GetResult <#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 `Notify <#Notify>`_) but the cycle will be broken when the timer completes, automatically 
cleaning up the `wx.CallLater` object.

.. seealso:: `wx.CallAfter <../wxFunctions.html#CallAfter>`_


Known Subclasses
^^^^^^^^^^^^^^^^

`wx.FutureCall <wx.FutureCall.html>`_

Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetInterval <#GetInterval>`_ 
* `GetResult <#GetResult>`_ 
* `HasRun <#HasRun>`_ 
* `IsRunning <#IsRunning>`_ 
* `Notify <#Notify>`_ 
* `Restart <#Restart>`_ 
* `SetArgs <#SetArgs>`_ 
* `Start <#Start>`_ 
* `Stop <#Stop>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Interval <#Interval>`_ 
* `Result <#Result>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(millis, callable, *args, **kwargs)

   Constructor. 

   **Parameters:**

   * `millis` (int)
   * `callable` (PyObject)

   |

   **Returns:**

   `wx.CallLater <wx.CallLater.html>`_

--------

.. method:: GetInterval()

   Returns the timer interval in milliseconds.

   |

   **Returns:**

   `int`

--------


.. method:: GetResult()

   The return value of the callable.

   |

   **Returns:**

   `PyObject`
  

--------


.. method:: HasRun()

   Returns whether the timer has ever been run.

   |

   **Returns:**

   `bool`

--------


.. method:: IsRunning()

   Returns whether the timer is running.

   |

   **Returns:**

   `bool`

--------


.. method:: Notify()

   The timer has expired so call the callable.

--------


.. method:: Restart(millis, *args, **kwargs)

   Restart the timer.

   **Parameters:**

   * `millis` (int)

--------

.. method:: SetArgs(*args, **kwargs)

   (Re)set the args passed to the callable object. 

   This is useful in conjunction with `Restart <#Restart>`_ if you want to schedule a new call to the same callable object but with different parameters.

--------

.. method:: Start(millis=None, *args, **kwargs)

   (Re)start the timer.

   **Parameters:**

   * `millis` (int)


--------

.. method:: Stop()

   Stop and destroy the timer.

--------

Properties
^^^^^^^^^^


.. attribute:: Interval

   See `GetInterval`_ 

.. attribute:: Result

   See `GetResult`_