Class
WPEWebKitFindController
Description [src]
class WPEWebKit.FindController : GObject.Object {
parent: GObject
}Controls text search in a WebKitWebView.
A WebKitFindController is used to search text in a WebKitWebView. You
can get a WebKitWebView‘s WebKitFindController with
webkit_web_view_get_find_controller(), and later use it to search
for text using webkit_find_controller_search(), or get the
number of matches using webkit_find_controller_count_matches(). The
operations are asynchronous and trigger signals when ready, such as
WebKitFindController::found-text,
WebKitFindController::failed-to-find-text or
WebKitFindController::counted-matches.
Instance methods
webkit_find_controller_count_matches
Counts the number of matches for search_text found in the
WebKitWebView with the provided find_options. The number of
matches will be provided by the
WebKitFindController::counted-matches signal.
webkit_find_controller_get_max_match_count
Gets the maximum number of matches to report during a text
lookup. This number is passed as the last argument of
webkit_find_controller_search() or webkit_find_controller_count_matches().
webkit_find_controller_get_options
Gets a bitmask containing the WebKitFindOptions associated with
the current search.
webkit_find_controller_get_search_text
Gets the text that find_controller is currently searching
for. This text is passed to either
webkit_find_controller_search() or webkit_find_controller_count_matches().
webkit_find_controller_get_web_view
Gets the WebKitWebView this find controller is associated to. Do
not dereference the returned instance as it belongs to the
WebKitFindController.
webkit_find_controller_search
Looks for search_text in the WebKitWebView associated with
find_controller since the beginning of the document highlighting
up to max_match_count matches. The outcome of the search will be
asynchronously provided by the WebKitFindController::found-text
and WebKitFindController::failed-to-find-text signals.
webkit_find_controller_search_finish
Finishes a find operation started by webkit_find_controller_search(). It will basically unhighlight every text match found.
webkit_find_controller_search_next
Looks for the next occurrence of the search text.
webkit_find_controller_search_previous
Looks for the previous occurrence of the search text.
Properties
WPEWebKit.FindController:max-match-count
The maximum number of matches to report for a given search.
WPEWebKit.FindController:options
The options to be used in the search operation.
WPEWebKit.FindController:text
The current search text for this WebKitFindController.
WPEWebKit.FindController:web-view
The WebKitWebView this controller is associated to.
Signals
WPEWebKit.FindController::counted-matches
This signal is emitted when the WebKitFindController has
counted the number of matches for a given text after a call
to webkit_find_controller_count_matches().
WPEWebKit.FindController::failed-to-find-text
This signal is emitted when a search operation does not find
any result for the given text. It will be issued if the text
is not found asynchronously after a call to
webkit_find_controller_search(), webkit_find_controller_search_next()
or webkit_find_controller_search_previous().
WPEWebKit.FindController::found-text
This signal is emitted when a given text is found in the web
page text. It will be issued if the text is found
asynchronously after a call to webkit_find_controller_search(),
webkit_find_controller_search_next() or webkit_find_controller_search_previous().
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct WPEWebKitFindControllerClass {
GObjectClass parent_class;
void (* _webkit_reserved0) (
void
);
void (* _webkit_reserved1) (
void
);
void (* _webkit_reserved2) (
void
);
void (* _webkit_reserved3) (
void
);
}Class members
parent_class |
|
| No description available. | |
_webkit_reserved0 |
|
| No description available. | |
_webkit_reserved1 |
|
| No description available. | |
_webkit_reserved2 |
|
| No description available. | |
_webkit_reserved3 |
|
| No description available. |