.. include:: headings.inc



.. _FindDialogEvent:

==========================================================================================================================================
|phoenix_title|  **FindDialogEvent**
==========================================================================================================================================

:ref:`FindReplaceDialog`  events.          





.. _FindDialogEvent-events:

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

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

- EVT_FIND: Find button was pressed in the dialog.  
- EVT_FIND_NEXT: Find next button was pressed in the dialog.  
- EVT_FIND_REPLACE: Replace button was pressed in the dialog.  
- EVT_FIND_REPLACE_ALL: Replace all button was pressed in the dialog.  
- EVT_FIND_CLOSE: The dialog is being destroyed, any pointers to it cannot be used any longer.  










|

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

Inheritance diagram for class **FindDialogEvent**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/FindDialogEvent_inheritance.png" alt="Inheritance diagram of FindDialogEvent" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" 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="node4" 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="node2" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,77,35"/> <area shape="rect" id="node6" href="FindDialogEvent.html" title="FindReplaceDialog  events." alt="" coords="431,5,569,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~FindDialogEvent.__init__`                                                Constructor used by wxWidgets only.
:meth:`~FindDialogEvent.GetDialog`                                               Return the pointer to the dialog which generated this event.
:meth:`~FindDialogEvent.GetFindString`                                           Return the string to find (never empty).
:meth:`~FindDialogEvent.GetFlags`                                                Get the currently selected flags: this is the combination of the :ref:`FindReplaceFlags`   enumeration values.
:meth:`~FindDialogEvent.GetReplaceString`                                        Return the string to replace the search string with (only for replace and replace all events).
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~FindDialogEvent.Dialog`                                                  See :meth:`~FindDialogEvent.GetDialog`
:attr:`~FindDialogEvent.FindString`                                              See :meth:`~FindDialogEvent.GetFindString`
:attr:`~FindDialogEvent.Flags`                                                   See :meth:`~FindDialogEvent.GetFlags`
:attr:`~FindDialogEvent.ReplaceString`                                           See :meth:`~FindDialogEvent.GetReplaceString`
================================================================================ ================================================================================


|


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

.. class:: FindDialogEvent(CommandEvent)

   FindReplaceDialog events.
   
   **Possible constructors**::

       FindDialogEvent(commandType=wxEVT_NULL, id=0)
       



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

      Constructor used by wxWidgets only.                  


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







   .. method:: GetDialog(self)

      Return the pointer to the dialog which generated this event.                  

      :rtype: :ref:`FindReplaceDialog`








   .. method:: GetFindString(self)

      Return the string to find (never empty).                  

      :rtype: `string`








   .. method:: GetFlags(self)

      Get the currently selected flags: this is the combination of the :ref:`FindReplaceFlags`   enumeration values.                  

      :rtype: `int`








   .. method:: GetReplaceString(self)

      Return the string to replace the search string with (only for replace and replace all events).                  

      :rtype: `string`








   .. attribute:: Dialog

      See :meth:`~FindDialogEvent.GetDialog`


   .. attribute:: FindString

      See :meth:`~FindDialogEvent.GetFindString`


   .. attribute:: Flags

      See :meth:`~FindDialogEvent.GetFlags`


   .. attribute:: ReplaceString

      See :meth:`~FindDialogEvent.GetReplaceString`