******************
wx.FindReplaceData
******************

Inheritance diagram for `wx.FindReplaceData`:

|

.. inheritance-diagram:: wx.FindReplaceData

|

Description
===========

`wx.FindReplaceData` holds the data for `wx.FindReplaceDialog <wx.FindReplaceDialog.html>`_. 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  `wx.FindDialogEvent <../Events/wx.FindDialogEvent.html>`_ is generated so instead of using the `wx.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.


Derived From
^^^^^^^^^^^^^

* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetFindString <#GetFindString>`_ 
* `GetFlags <#GetFlags>`_ 
* `GetReplaceString <#GetReplaceString>`_ 
* `SetFindString <#SetFindString>`_ 
* `SetFlags <#SetFlags>`_ 
* `SetReplaceString <#SetReplaceString>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `FindString <#FindString>`_ 
* `Flags <#Flags>`_ 
* `ReplaceString <#ReplaceString>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(flags=0)

   Constuctor initializes the flags to default value (0).
   
   **Parameters:**

   * `flags` (int)

   |

   **Returns:**

   `wx.FindReplaceData <wx.FindReplaceData.html>`_
 

--------

.. method:: GetFindString()

   Get the string to find.

   |

   **Returns:**

   `string` 

--------

.. method:: GetFlags()

   Get the combination of `wx.FindReplaceFlags` values, which can be:

   ============================  =======================================
   Flag                          Description
   ============================  =======================================
   ``wx.FR_DOWN``                downward search/replace selected (otherwise - upwards)
   ``wx.FR_WHOLEWORD``           whole word search/replace selected
   ``wx.FR_MATCHCASE``           case sensitive search/replace selected (otherwise - case insensitive)
   ============================  =======================================

   |

   **Returns:**

   `int` 

--------

.. method:: GetReplaceString()

   Get the replacement string.

   |

   **Returns:**

   `string` 

--------

.. method:: SetFindString(str)

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

   **Parameters:**

   * `str` (string) 


--------

.. method:: SetFlags(flags)

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

   **Parameters:**

   * `flags` (int) 


.. seealso:: `GetFlags <#GetFlags>`_

--------

.. method:: SetReplaceString(str)

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

   **Parameters:**

   * `str` (string) 


--------

Properties
^^^^^^^^^^


.. attribute:: FindString

   See `GetFindString <#GetFindString>`_ and `SetFindString <#SetFindString>`_
   

.. attribute:: Flags

   See `GetFlags <#GetFlags>`_ and `SetFlags <#SetFlags>`_
   
   
.. attribute:: ReplaceString

   See `GetReplaceString <#GetReplaceString>`_ and `SetReplaceString <#SetReplaceString>`_