.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2017 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.IdleEvent:

==========================================================================================================================================
|phoenix_title|  **wx.IdleEvent**
==========================================================================================================================================

This class is used for idle events, which are generated when the system becomes idle.          

Note that, unless you do something specifically, the idle events are not sent if the system remains idle once it has become it, e.g. only a single idle event will be generated until something else resulting in more normal events happens and only then is the next idle event sent again. 

If you need to ensure a continuous stream of idle events, you can either use :meth:`wx.IdleEvent.RequestMore`   method in your handler or call :ref:`wx.WakeUpIdle`  periodically (for example from a timer event handler), but note that both of these approaches (and especially the first one) increase the system load and so should be avoided if possible. 

By default, idle events are sent to all windows, including even the hidden ones because they may be shown if some condition is met from their  ``wxEVT_IDLE``   (or related   ``wxEVT_UPDATE_UI`` ) handler. The children of hidden windows do not receive idle events however as they can't change their state in any way noticeable by the user. Finally, the global  :ref:`wx.App`  object also receives these events, as usual, so it can be used for any global idle time processing. 

If sending idle events to all windows is causing a significant overhead in your application, you can call :meth:`wx.IdleEvent.SetMode`   with the value ``wx.IDLE_PROCESS_SPECIFIED``, and set the ``wx.WS_EX_PROCESS_IDLE`` extra window style for every window which should receive idle events, all the other ones will not receive them in this case. 







.. _IdleEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`wx.IdleEvent` parameter.

Event macros: 

- EVT_IDLE: Process a  ``wxEVT_IDLE``   event.   










|phoenix_title| Delayed Action Mechanism
========================================

:ref:`wx.IdleEvent`  can be used to perform some action "at slightly later time". This can be necessary in several circumstances when, for whatever reason, something can't be done in the current event handler. For example, if a mouse event handler is called with the mouse button pressed, the mouse can be currently captured and some operations with it  ``wxEVT_IDLE``   handler when it is called the next time instead of doing it immediately. This can be achieved in two different ways: when using static event tables, you will need a flag indicating to the (always connected) idle event handler whether the desired action should be performed. The originally called handler would then set it to indicate that it should indeed be done and the idle handler itself would reset it to prevent it from doing the same action again. Using dynamically connected event handlers things are even simpler as the original event handler can simply :meth:`wx.EvtHandler.Connect`   or :meth:`wx.EvtHandler.Bind`   the idle event handler which would only be executed then and could :meth:`wx.EvtHandler.Disconnect`   or :meth:`wx.EvtHandler.Unbind`   itself.   



.. seealso:: :ref:`Events and Event Handling <events and event handling>`, :ref:`wx.UpdateUIEvent`, :meth:`wx.Window.OnInternalIdle`     







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>IdleEvent</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.IdleEvent_inheritance.png" alt="Inheritance diagram of IdleEvent" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Event.html" title="wx.Event" alt="" coords="15,83,93,112"/> <area shape="rect" id="node3" href="wx.IdleEvent.html" title="wx.IdleEvent" alt="" coords="5,160,104,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="13,5,95,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.IdleEvent.__init__`                                                   Constructor.
:meth:`~wx.IdleEvent.GetMode`                                                    Static function returning a value specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events.
:meth:`~wx.IdleEvent.MoreRequested`                                              Returns ``True`` if the OnIdle function processing this event requested more processing time.
:meth:`~wx.IdleEvent.RequestMore`                                                Tells wxWidgets that more processing is required.
:meth:`~wx.IdleEvent.SetMode`                                                    Static function for specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.IdleEvent(Event)

   **Possible constructors**::

       IdleEvent()
       
   
   This class is used for idle events, which are generated when the
   system becomes idle.



   .. method:: __init__(self)

      Constructor.                   





   .. staticmethod:: GetMode()

      Static function returning a value specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events.                  

                

      :rtype: :ref:`wx.IdleMode`







      .. seealso:: :meth:`SetMode` .   








   .. method:: MoreRequested(self)

      Returns ``True`` if the OnIdle function processing this event requested more processing time.                  

                

      :rtype: `bool`







      .. seealso:: :meth:`RequestMore`     








   .. method:: RequestMore(self, needMore=True)

      Tells wxWidgets that more processing is required.                  

      This function can be called by an OnIdle handler for a window or window event handler to indicate that `App.OnIdle` should forward the OnIdle event once more to the application windows. 

      If no window calls this function during OnIdle, then the application will remain in a passive event loop (not calling OnIdle) until a new event is posted to the application by the windowing system. 

                


      :param `needMore`: 
      :type `needMore`: bool






      .. seealso:: :meth:`MoreRequested`     








   .. staticmethod:: SetMode(mode)

      Static function for specifying how wxWidgets will send idle events: to all windows, or only to those which specify that they will process the events.                  




      :param `mode`: Can be one of the :ref:`wx.IdleMode`  values. The default is ``wx.IDLE_PROCESS_ALL``.   
      :type `mode`: wx.IdleMode




                  




