Provides search functionality for use on Scintilla objects.
The ScintillaSearch class consists of the following fields:
Access | Name | Type | Comment | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
End | INT | End of the current/most recent selection | |||||||||||||||
Flags | STF | Optional flags. | |||||||||||||||
Optional flags that affect the search process are specified here.
| |||||||||||||||||
Scintilla | *Scintilla | Targets a Scintilla object for searching. | |||||||||||||||
A Scintilla object must be targeted in this field in order to perform the search process. | |||||||||||||||||
Start | INT | Start of the current/most recent selection | |||||||||||||||
Text | CSTRING | The string sequence to search for. | |||||||||||||||
The following methods are currently supported:
Name | Comment | ||||||
---|---|---|---|---|---|---|---|
Find | Searches for a specific text string. | ||||||
ERR ss::Find(OBJECTPTR Object, LONG * Pos, STF Flags)
Call Find to initiate a string search within the targeted Scintilla object. The method will scan for the first instance of the Text string sequence and return its position in Pos. The Flags parameter defines special options that affect the search process. To find subsequent string matches, call one of either the Next() or Prev() methods. | |||||||
Next | Continues a text search. | ||||||
ERR ss::Next(OBJECTPTR Object, LONG * Pos)
| |||||||
Prev | Continues a text search in reverse. | ||||||
Scintilla search flags.
Name | Description |
---|---|
STF::BACKWARDS | Search backwards. |
STF::CASE | Case sensitive search. |
STF::EXPRESSION | Search text is a regular expression. |
STF::MOVE_CURSOR | The cursor is moved to the discovered string. If not set, the string is auto-selected. |
STF::SCAN_SELECTION | Limit search to within the user's current selection. |
STF::WRAP | Wrap search at the end of the document. |
Class Info | |
---|---|
ID | ID_SCINTILLASEARCH |
Category | Tool |
Include | modules/scintillasearch.h |
Version | 1 |