Search provider interface
The current index of the selected match.
Signal emitted when filter definition changed.
Test whether the object has been disposed.
This property is always safe to access.
Set to true if the widget under search is read-only, false if it is editable. Will be used to determine whether to show the replace option.
The number of matches.
Specifies which replace options are supported by provider.
Signal indicating that something in the search has changed, so the UI should update
Clear currently highlighted match.
Dispose of the resources held by the object.
If the object's
dispose method is called more than once, all
calls made after the first will be a no-op.
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
Stop a search and clear any internal state of the provider
Get an initial query value if applicable so that it can be entered into the search box as an initial query
Initial value used to populate the search box.
Is there one or more objects selected?
The selection can be made of one or more lines, notebook cells, or other objects (e.g. spreadsheet cells). The provider can decide whether it counts multiple characters (as opposed to lines) as multiple selection or not, which will influence the heuristic auto-enabling "search in selection" mode.
Replace the currently selected match with the provided text and highlight the next match.
The replacement text
Whether to loop within the matches list.
A promise that resolves with a boolean indicating whether a replace occurred.
Validate a new filter value for the widget.
The filter name
The filter value candidate
The valid filter value
Generated using TypeDoc