.. include:: headings.inc



.. _WindowModalDialogEvent:

==========================================================================================================================================
|phoenix_title|  **WindowModalDialogEvent**
==========================================================================================================================================





|

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

Inheritance diagram for class **WindowModalDialogEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/WindowModalDialogEvent_inheritance.png" alt="Inheritance diagram of WindowModalDialogEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="WindowModalDialogEvent.html" title="WindowModalDialogEvent" alt="" coords="429,5,640,35"/> <area shape="rect" id="node2" href="CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="245,5,381,35"/> <area shape="rect" id="node4" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="125,5,197,35"/> <area shape="rect" id="node5" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~WindowModalDialogEvent.__init__`                                         
:meth:`~WindowModalDialogEvent.Clone`                                            Returns a copy of the event.
:meth:`~WindowModalDialogEvent.GetDialog`                                        
:meth:`~WindowModalDialogEvent.GetReturnCode`                                    
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~WindowModalDialogEvent.Dialog`                                           See :meth:`~WindowModalDialogEvent.GetDialog`
:attr:`~WindowModalDialogEvent.ReturnCode`                                       See :meth:`~WindowModalDialogEvent.GetReturnCode`
================================================================================ ================================================================================


|


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

.. class:: WindowModalDialogEvent(CommandEvent)

   
   
   **Possible constructors**::

       WindowModalDialogEvent(commandType=wxEVT_NULL, id=0)
       



   .. method:: __init__(self, commandType=wxEVT_NULL, id=0)




      :param `commandType`: 
      :type `commandType`: EventType
      :param `id`: 
      :type `id`: int







   .. method:: Clone(self)

      Returns a copy of the event.                  

      Any event that is posted to the wxWidgets event system for later action (via :meth:`EvtHandler.AddPendingEvent` , :meth:`EvtHandler.QueueEvent`   or :func:`PostEvent`) must implement this method. 

      All wxWidgets events fully implement this method, but any derived events implemented by the user should also implement this method just in case they (or some event derived from them) are ever posted. 

      All wxWidgets events implement a copy constructor, so the easiest way of implementing the Clone function is to implement a copy constructor for a new event (call it MyEvent) and then define the Clone function like this: 

      ::

                  def Clone(self):

                      return MyEvent()

                 

      :rtype: :ref:`Event`








   .. method:: GetDialog(self)



      :rtype: :ref:`Dialog`








   .. method:: GetReturnCode(self)



      :rtype: `int`








   .. attribute:: Dialog

      See :meth:`~WindowModalDialogEvent.GetDialog`


   .. attribute:: ReturnCode

      See :meth:`~WindowModalDialogEvent.GetReturnCode`