.. 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.TextSearch:

==========================================================================================================================================
|phoenix_title|  **wx.TextSearch**
==========================================================================================================================================

Search options for :meth:`wx.TextCtrl.SearchText` . 
         

This is a builder class, where property functions can be called during construction. For example: 




         



.. versionadded:: 4.3/wxWidgets-3.3.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>TextSearch</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.TextSearch_inheritance.svg" alt="Inheritance diagram of TextSearch" 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.TextSearch.html" title="Search options for wx.TextCtrl.SearchText ." alt="" coords="5,5,138,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.TextSearch.__init__`                                                  The string to search for.
:meth:`~wx.TextSearch.MatchCase`                                                 Whether the search should match case (i.e., be case sensitive).
:meth:`~wx.TextSearch.MatchWholeWord`                                            Whether the search should match the whole word.
:meth:`~wx.TextSearch.SearchDirection`                                           Whether the search should go up or down in the text control.
:meth:`~wx.TextSearch.SearchValue`                                               The string to search for.
:meth:`~wx.TextSearch.Start`                                                     Where the search should start from.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.TextSearch.m_direction`                                               A public C++ attribute of type `~wx.TextSearch.Direction`     .
:attr:`~wx.TextSearch.m_matchCase`                                               A public C++ attribute of type ``bool``.
:attr:`~wx.TextSearch.m_searchValue`                                             A public C++ attribute of type ``string``.
:attr:`~wx.TextSearch.m_startingPosition`                                        A public C++ attribute of type ``long``.
:attr:`~wx.TextSearch.m_wholeWord`                                               A public C++ attribute of type ``bool``.
================================================================================ ================================================================================


|


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


.. class:: wx.TextSearch(object)

   **Possible constructors**::

       TextSearch(text) -> None
       
   
   Search options for `TextCtrl.SearchText().`



   .. method:: __init__(self, text)

      The string to search for. 
                 


      :param `text`: 
      :type `text`: string




      :rtype: `None`     








   .. method:: MatchCase(self, matchCase=True)

      Whether the search should match case (i.e., be case sensitive). 
                 

      By default, this is  ``false`` ; search will be case insensitive.  
                 


      :param `matchCase`: 
      :type `matchCase`: bool




      :rtype: :ref:`wx.TextSearch`








   .. method:: MatchWholeWord(self, matchWholeWord=True)

      Whether the search should match the whole word. 
                 

      By default, this is  ``false`` ; searching will not match by whole word.  
                 


      :param `matchWholeWord`: 
      :type `matchWholeWord`: bool




      :rtype: :ref:`wx.TextSearch`








   .. method:: SearchDirection(self, direction)

      Whether the search should go up or down in the text control. 
                 

      By default, search will go downward. 
                 


      :param `direction`: 
      :type `direction`: TextSearch.Direction




      :rtype: :ref:`wx.TextSearch`








   .. method:: SearchValue(self, value)

      The string to search for. 
                 


      :param `value`: 
      :type `value`: string




      :rtype: :ref:`wx.TextSearch`








   .. method:: Start(self, startPosition)

      Where the search should start from. 
                 

      By default, if searching down, then the search will start at 0. If searching up, then will start at the end of control. 
                 


      :param `startPosition`: 
      :type `startPosition`: long




      :rtype: :ref:`wx.TextSearch`








   .. attribute:: m_direction

      A public C++ attribute of type `~wx.TextSearch.Direction`     .


   .. attribute:: m_matchCase

      A public C++ attribute of type ``bool``.


   .. attribute:: m_searchValue

      A public C++ attribute of type ``string``.


   .. attribute:: m_startingPosition

      A public C++ attribute of type ``long``.


   .. attribute:: m_wholeWord

      A public C++ attribute of type ``bool``.


.. toctree::
   :maxdepth: 1
   :hidden:

   wx.TextSearch.Direction.enumeration