Class: Wx::TextSearch

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/text_ctrl.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

Search options for Wx::TextCtrl#search_text.

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

  wxTextSearchResult result =
      textctrl->SearchText(wxTextSearch(L"Institutional Research").
          SearchDirection(wxTextSearch::Direction::Down).
          MatchCase().
          MatchWholeWord());

Defined Under Namespace

Classes: Direction

Instance Method Summary collapse

Constructor Details

#initialize(text) ⇒ Wx::TextSearch

The string to search for.

Parameters:

  • text (String) 


973
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 973

def initialize(text) end

Instance Method Details

#get_direction ⇒ Wx::URLDataObject::Direction

Returns:



968
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 968

def get_direction; end

#get_search_value ⇒ String

Returns:

  • (String) 


944
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 944

def get_search_value; end

#get_starting_position ⇒ Integer

Returns:

  • (Integer) 


950
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 950

def get_starting_position; end

#match_case(matchCase = true) ⇒ Wx::TextSearch

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

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

Parameters:

  • matchCase (Boolean) (defaults to: true)

Returns:



985
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 985

def match_case(matchCase=true) end

#match_case? ⇒ Boolean

Returns:

  • (Boolean) 


956
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 956

def match_case?; end

#match_whole_word(matchWholeWord = true) ⇒ Wx::TextSearch

Whether the search should match the whole word.

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

Parameters:

  • matchWholeWord (Boolean) (defaults to: true)

Returns:



992
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 992

def match_whole_word(matchWholeWord=true) end

#search_direction(direction) ⇒ Wx::TextSearch

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

By default, search will go downward.

Parameters:

Returns:



999
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 999

def search_direction(direction) end

#search_value(value) ⇒ Wx::TextSearch

The string to search for.

Parameters:

  • value (String)

Returns:



978
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 978

def search_value(value) end

#start(startPosition) ⇒ Wx::TextSearch

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 (Integer)

Returns:



1006
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 1006

def start(startPosition) end

#whole_word? ⇒ Boolean

Returns:

  • (Boolean) 


962
 
# File 'lib/wx/doc/gen/text_ctrl.rb', line 962

def whole_word?; end