Find-in-page helper More...
Header: | #include <oxideqfindcontroller.h> |
Instantiated By: | FindController |
Inherits: | QObject |
bool | caseSensitive() const |
int | count() const |
int | current() const |
void | setCaseSensitive(bool caseSensitive) |
void | setText(const QString & text) |
QString | text() const |
void | caseSensitiveChanged() const |
void | countChanged() const |
void | currentChanged() const |
void | textChanged() const |
Find-in-page helper
OxideQFindController 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.
Set this to true if the search should be case sensitive.
Access functions:
bool | caseSensitive() const |
void | setCaseSensitive(bool caseSensitive) |
Notifier signal:
void | caseSensitiveChanged() const |
The number of results found. This will be 0 if text is an empty string.
Access functions:
int | count() const |
Notifier signal:
void | countChanged() const |
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.
Access functions:
int | current() const |
Notifier signal:
void | currentChanged() const |
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.
Access functions:
QString | text() const |
void | setText(const QString & text) |
Notifier signal:
void | textChanged() const |
[slot]
void OxideQFindController::next()Advance the document to the next search result. This will result in current being incremented by 1.
[slot]
void OxideQFindController::previous()Move the document back to the previous search result. This will result in current being decremented by 1.