.. include:: headings.inc



.. _EventBlocker:

==========================================================================================================================================
|phoenix_title|  **EventBlocker**
==========================================================================================================================================

This class is a special event handler which allows to discard any event (or a set of event types) directed to a specific window.          

Example: 

::

        def DoSomething(self):
            # block all events directed to this window while
            # we do the 1000 FunctionWhichSendsEvents() calls
            blocker = wx.EventBlocker(self)

            for i in xrange(1000):
                FunctionWhichSendsEvents(i)
    
            # wx.EventBlocker destructor called, old event handler is restored
    
            # the event generated by this call will be processed:
            FunctionWhichSendsEvents(0)









         



.. seealso:: :ref:`How Events are Processed <how events are processed>`, :ref:`EvtHandler`    







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **EventBlocker**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/EventBlocker_inheritance.png" alt="Inheritance diagram of EventBlocker" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="EventBlocker.html" title="This class is a special event handler which allows to discard any event (or a set of event types) directed to a specific window." alt="" coords="296,31,413,62"/> <area shape="rect" id="node2" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,31,247,62"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,5,88,35"/> <area shape="rect" id="node6" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,58,99,89"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~EventBlocker.__init__`                                                   Constructs the blocker for the given window and for the given event type.
:meth:`~EventBlocker.Block`                                                      Adds to the list of event types which should be blocked the given `eventType`.
:meth:`~EventBlocker.__enter__`                                                  
:meth:`~EventBlocker.__exit__`                                                   
================================================================================ ================================================================================


|


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

.. class:: EventBlocker(EvtHandler)

   This class is a special event handler which allows to discard any event (or a set of event types) directed to a specific window.
   
   **Possible constructors**::

       EventBlocker(win, type=-1)
       



   .. method:: __init__(self, win, type=-1)

      Constructs the blocker for the given window and for the given event type.                  

      If `type`  is  ``wxEVT_ANY`` , then all events for that window are blocked. You can call  :meth:`Block`   after creation to add other event types to the list of events to block. 

      Note that the `win`  window **must**  remain alive until the :ref:`EventBlocker`  object destruction.                  


      :param `win`: 
      :type `win`: Window
      :param `type`: 
      :type `type`: EventType







   .. method:: Block(self, eventType)

      Adds to the list of event types which should be blocked the given `eventType`.                  


      :param `eventType`: 
      :type `eventType`: EventType







   .. method:: __enter__(self)




   .. method:: __exit__(self, exc_type, exc_val, exc_tb)