.. include:: headings.inc



.. _FindReplaceData:

==========================================================================================================================================
|phoenix_title|  **FindReplaceData**
==========================================================================================================================================

:ref:`FindReplaceData`  holds the data for :ref:`FindReplaceDialog`.          

It is used to initialize the dialog with the default values and will keep the last values from the dialog when it is closed. It is also updated each time a :ref:`FindDialogEvent`  is generated so instead of using the :ref:`FindDialogEvent`  methods you can also directly query this object. 

Note that all  ``SetXXX()``   methods may only be called before showing the dialog and calling them has no effect later. 









|

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

Inheritance diagram for class **FindReplaceData**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/FindReplaceData_inheritance.png" alt="Inheritance diagram of FindReplaceData" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" 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="node2" href="FindReplaceData.html" title="FindReplaceData  holds the data for FindReplaceDialog." alt="" coords="125,5,272,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~FindReplaceData.__init__`                                                Constructor initializes the flags to default value (0).
:meth:`~FindReplaceData.GetFindString`                                           Get the string to find.
:meth:`~FindReplaceData.GetFlags`                                                Get the combination of  ``FindReplaceFlags``   values.
:meth:`~FindReplaceData.GetReplaceString`                                        Get the replacement string.
:meth:`~FindReplaceData.SetFindString`                                           Set the string to find (used as initial value by the dialog).
:meth:`~FindReplaceData.SetFlags`                                                Set the flags to use to initialize the controls of the dialog.
:meth:`~FindReplaceData.SetReplaceString`                                        Set the replacement string (used as initial value by the dialog).
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~FindReplaceData.FindString`                                              See :meth:`~FindReplaceData.GetFindString` and :meth:`~FindReplaceData.SetFindString`
:attr:`~FindReplaceData.Flags`                                                   See :meth:`~FindReplaceData.GetFlags` and :meth:`~FindReplaceData.SetFlags`
:attr:`~FindReplaceData.ReplaceString`                                           See :meth:`~FindReplaceData.GetReplaceString` and :meth:`~FindReplaceData.SetReplaceString`
================================================================================ ================================================================================


|


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

.. class:: FindReplaceData(Object)

   FindReplaceData holds the data for FindReplaceDialog.
   
   **Possible constructors**::

       FindReplaceData(flags=0)
       



   .. method:: __init__(self, flags=0)

      Constructor initializes the flags to default value (0).                  


      :param `flags`: 
      :type `flags`: int







   .. method:: GetFindString(self)

      Get the string to find.                  

      :rtype: `string`








   .. method:: GetFlags(self)

      Get the combination of  ``FindReplaceFlags``   values.                   

      :rtype: `int`








   .. method:: GetReplaceString(self)

      Get the replacement string.                  

      :rtype: `string`








   .. method:: SetFindString(self, str)

      Set the string to find (used as initial value by the dialog).                  


      :param `str`: 
      :type `str`: string







   .. method:: SetFlags(self, flags)

      Set the flags to use to initialize the controls of the dialog.                  


      :param `flags`: 
      :type `flags`: int







   .. method:: SetReplaceString(self, str)

      Set the replacement string (used as initial value by the dialog).                  


      :param `str`: 
      :type `str`: string







   .. attribute:: FindString

      See :meth:`~FindReplaceData.GetFindString` and :meth:`~FindReplaceData.SetFindString`


   .. attribute:: Flags

      See :meth:`~FindReplaceData.GetFlags` and :meth:`~FindReplaceData.SetFlags`


   .. attribute:: ReplaceString

      See :meth:`~FindReplaceData.GetReplaceString` and :meth:`~FindReplaceData.SetReplaceString`