wx.TextSearch

Search options for wx.TextCtrl.SearchText .

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

Added in version 4.3/wxWidgets-3.3.0.

Class Hierarchy

Inheritance diagram for class TextSearch:

Methods Summary

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

Properties Summary

m_direction	A public C++ attribute of type Direction .
m_matchCase	A public C++ attribute of type bool.
m_searchValue	A public C++ attribute of type string.
m_startingPosition	A public C++ attribute of type long.
m_wholeWord	A public C++ attribute of type bool.

Class API

class wx.TextSearch(object)

Possible constructors:

TextSearch(text) -> None

Search options for TextCtrl.SearchText().

Methods

__init__(self, text)

The string to search for.

Parameters:

text (string)

Return type:

None

---

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.

Parameters:

matchCase (bool)

Return type:

wx.TextSearch

---

MatchWholeWord(self, matchWholeWord=True)

Whether the search should match the whole word.

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

Parameters:

matchWholeWord (bool)

Return type:

wx.TextSearch

---

SearchDirection(self, direction)

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

By default, search will go downward.

Parameters:

direction (TextSearch.Direction)

Return type:

wx.TextSearch

---

SearchValue(self, value)

The string to search for.

Parameters:

value (string)

Return type:

wx.TextSearch

---

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.

Parameters:

startPosition (long)

Return type:

wx.TextSearch

Properties

m_direction

A public C++ attribute of type Direction .

---

m_matchCase

A public C++ attribute of type bool.

---

m_searchValue

A public C++ attribute of type string.

---

m_startingPosition

A public C++ attribute of type long.

---

m_wholeWord

A public C++ attribute of type bool.