Struct webkit6::FindController

pub struct FindController { /* private fields */ }

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.

Properties

max-match-count

The maximum number of matches to report for a given search.

Readable

options

The options to be used in the search operation.

Readable

text

The current search text for this #WebKitFindController.

Readable

web-view

The #WebKitWebView this controller is associated to.

Readable | Writeable | Construct Only

Signals

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().

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().

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().

GLib type: GObject with reference counted clone semantics.

Implementations

impl FindController

pub fn count_matches( &self, search_text: &str, find_options: u32, max_match_count: u32, )

Counts the number of matches for @search_text.

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.

search_text

the text to look for

find_options

a bitmask with the #WebKitFindOptions used in the search

max_match_count

the maximum number of matches allowed in the search

pub fn max_match_count(&self) -> u32

Gets the maximum number of matches to report.

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().

Returns

the maximum number of matches to report.

pub fn options(&self) -> u32

Gets the #WebKitFindOptions for the current search.

Gets a bitmask containing the #WebKitFindOptions associated with the current search.

Returns

a bitmask containing the #WebKitFindOptions associated with the current search.

pub fn search_text(&self) -> Option<GString>

Gets the text that @self is searching for.

Gets the text that @self is currently searching for. This text is passed to either webkit_find_controller_search() or webkit_find_controller_count_matches().

Returns

the text to look for in the #WebKitWebView.

pub fn web_view(&self) -> Option<WebView>

Gets the #WebKitWebView this find controller is associated to.

Do not dereference the returned instance as it belongs to the #WebKitFindController.

Returns

the #WebKitWebView.

pub fn search(&self, search_text: &str, find_options: u32, max_match_count: u32)

Looks for @search_text associated with @self.

Looks for @search_text in the #WebKitWebView associated with @self 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.

To look for the next or previous occurrences of the same text with the same find options use webkit_find_controller_search_next() and/or webkit_find_controller_search_previous(). The #WebKitFindController will use the same text and options for the following searches unless they are modified by another call to this method.

Note that if the number of matches is higher than @max_match_count then #WebKitFindController::found-text will report G_MAXUINT matches instead of the actual number.

Callers should call webkit_find_controller_search_finish() to finish the current search operation.

search_text

the text to look for

find_options

a bitmask with the #WebKitFindOptions used in the search

max_match_count

the maximum number of matches allowed in the search

pub fn search_finish(&self)

Finishes a find operation.

Finishes a find operation started by webkit_find_controller_search(). It will basically unhighlight every text match found.

This method will be typically called when the search UI is closed/hidden by the client application.

pub fn search_next(&self)

Looks for the next occurrence of the search text.

Calling this method before webkit_find_controller_search() or webkit_find_controller_count_matches() is a programming error.

pub fn search_previous(&self)

Looks for the previous occurrence of the search text.

Calling this method before webkit_find_controller_search() or webkit_find_controller_count_matches() is a programming error.

pub fn text(&self) -> Option<GString>

The current search text for this #WebKitFindController.

pub fn connect_counted_matches<F: Fn(&Self, u32) + 'static>( &self, f: F, ) -> SignalHandlerId

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().

match_count

the number of matches of the search text

pub fn connect_failed_to_find_text<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

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().

pub fn connect_found_text<F: Fn(&Self, u32) + 'static>( &self, f: F, ) -> SignalHandlerId

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().

match_count

the number of matches found of the search text

pub fn connect_max_match_count_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_options_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_text_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for FindController

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FindController

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for FindController

type ParamSpec = ParamSpecObject

type SetValue = FindController

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, FindController>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FindController

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FindController

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for FindController

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for FindController

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FindController

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FindController

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FindController