FindController QML Type

Find-in-page helper More...

Import Statement:	import com.canonical.Oxide 1.15
Since:	OxideQt 1.8
Instantiates:	OxideQFindController

List of all members, including inherited members

Properties

caseSensitive : bool
count : int
current : int
text : string

Methods

void next()
void previous()

Detailed Description

FindController provides a mechanism to allow an application to provide find-in-page functionality.

Applications specify the search term by setting text. In response, the engine highlights any matches and updates count with the number of results. The application can then cycle through the results by calls to previous and next. The current position is indicated by current.

The current find-in-page request can be terminated by setting text to an empty string.

Property Documentation

caseSensitive : bool

Set this to true if the search should be case sensitive.

count : int

The number of results found. This will be 0 if text is an empty string.

current : int

The current position within the search results. This will be a number between 0 and count, and will be 0 if text is an empty string.

text : string

Set this to the desired search term to begin a search in the current page. Set it to an empty string to terminate the current search.

Method Documentation

void next()

Advance the document to the next search result. This will result in current being incremented by 1.

void previous()

Move the document back to the previous search result. This will result in current being decremented by 1.