.. wxPython Phoenix documentation

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

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

.. include:: headings.inc



.. _wx.WindowModalDialogEvent:

==========================================================================================================================================
|phoenix_title|  **wx.WindowModalDialogEvent**
==========================================================================================================================================

Event sent by :meth:`wx.Dialog.ShowWindowModal`   when the dialog closes. 
         


         



.. versionadded:: 2.9.0 
     







|

|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>WindowModalDialogEvent</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.WindowModalDialogEvent_inheritance.svg" alt="Inheritance diagram of WindowModalDialogEvent" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.WindowModalDialogEvent.html" title="Event sent by wx.Dialog.ShowWindowModal   when the dialog closes." alt="" coords="5,236,248,265"/> <area shape="rect" id="node2" href="wx.CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="43,159,211,188"/> <area shape="rect" id="node3" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="80,82,174,111"/> <area shape="rect" id="node4" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="77,5,176,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.WindowModalDialogEvent.__init__`                                      Constructor.
:meth:`~wx.WindowModalDialogEvent.Clone`                                         Clone the event.
:meth:`~wx.WindowModalDialogEvent.GetDialog`                                     Return the corresponding dialog.
:meth:`~wx.WindowModalDialogEvent.GetReturnCode`                                 Return the dialog's return code.
================================================================================ ================================================================================


|


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

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


|


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


.. class:: wx.WindowModalDialogEvent(CommandEvent)

   **Possible constructors**::

       WindowModalDialogEvent(commandType: EventType=wxEVT_NULL, id: int=0) ->
                              None
       
   
   Event sent by `Dialog.ShowWindowModal()` when the dialog closes.



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

      Constructor. 
                 


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




      :rtype: `None`     








   .. method:: Clone(self)

      Clone the event. 
                 

      :rtype: :ref:`wx.Event`








   .. method:: GetDialog(self)

      Return the corresponding dialog. 
                 

      :rtype: :ref:`wx.Dialog`








   .. method:: GetReturnCode(self)

      Return the dialog's return code. 
                 

      :rtype: `int`








   .. attribute:: Dialog

      See :meth:`~wx.WindowModalDialogEvent.GetDialog`


   .. attribute:: ReturnCode

      See :meth:`~wx.WindowModalDialogEvent.GetReturnCode`