.. include:: headings.inc

.. currentmodule:: lib.delayedresult

.. highlight:: python



.. _lib.delayedresult.SenderWxEvent:

==========================================================================================================================================
|phoenix_title|  **SenderWxEvent**
==========================================================================================================================================

This sender sends the delayed result produced in the worker thread
to an event handler in the main thread, via a wx event of class 
*eventClass*. The result is an attribute of the event (default: 
"delayedResult". 



|

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

Inheritance diagram for class **SenderWxEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.delayedresult.SenderWxEvent_inheritance.png" alt="Inheritance diagram of SenderWxEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.delayedresult.Sender.html" title="Base class for various kinds of senders. A sender sends a result" alt="" coords="5,5,181,35"/> <area shape="rect" id="node2" href="lib.delayedresult.SenderWxEvent.html" title="This sender sends the delayed result produced in the worker thread" alt="" coords="229,5,469,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`lib.delayedresult.Sender`

|


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

================================================================================ ================================================================================
:meth:`~lib.delayedresult.SenderWxEvent.__init__`                                The handler must derive from wx.EvtHandler. The event class
================================================================================ ================================================================================


|


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

.. class:: SenderWxEvent( Sender )

   This sender sends the delayed result produced in the worker thread
   to an event handler in the main thread, via a wx event of class 
   *eventClass*. The result is an attribute of the event (default: 
   "delayedResult". 

   .. method:: __init__(self, handler, eventClass, resultAttr="delayedResult", jobID=None, \*\*kwargs)

      The handler must derive from wx.EvtHandler. The event class 
      is typically the first item in the pair returned by 
      wx.lib.newevent.NewEvent(). You can use the *resultAttr* 
      to change the attribute name of the generated event's 
      delayed result.