Provides search functionality for use on Scintilla objects.

Structure

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.

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.

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.

This field defines the string sequence that will be searched for when calling either Find(), Next() or Prev().

Methods

The following methods are currently supported:

Find Searches for a specific text string.

ERR ss::Find(OBJECTPTR Object, LONG * Pos, STF Flags)

Parameter	Description
Pos	The position to start searching from. Set to -1 to start from the cursor position. This parameter is updated with the byte position of the discovered string sequence.
Flags	Optional 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)

Parameter	Description
Pos	The byte-position of the discovered string sequence is returned here.

Use Next to continue a search after calling the Find() method. If a string sequence matching that of Text is discovered, its byte position will be returned in the Pos parameter. If a new match is not discovered then ERR::Search is returned to indicate an end to the search.

Prev Continues a text search in reverse.

ERR ss::Prev(OBJECTPTR Object, LONG * Pos)

Parameter	Description
Pos	The byte-position of the discovered string is returned here.

The Prev() method operates under the same circumstances as Next(), except that the search will be in reverse. Please refer to Next() for further information.

STF Type

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.

ScintillaSearch Class

Structure

Methods

STF Type