gi-webkit2-4.0.24: WebKit2 bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.WebKit2.Objects.FindController

Contents

Description

No description available in the introspection data.

Synopsis

Exported types

newtype FindController Source #

Memory-managed wrapper type.

class (GObject o, IsDescendantOf FindController o) => IsFindController o Source #

Type class for types which can be safely cast to FindController, for instance with toFindController.

toFindController :: (MonadIO m, IsFindController o) => o -> m FindController Source #

Cast to FindController, for types for which this is known to be safe. For general casts, use castTo.

Methods

countMatches

findControllerCountMatches Source #

Arguments

:: (HasCallStack, MonadIO m, IsFindController a) 
=> a

findController: the FindController

-> Text

searchText: the text to look for

-> Word32

findOptions: a bitmask with the FindOptions used in the search

-> Word32

maxMatchCount: the maximum number of matches allowed in the search

-> m () 

Counts the number of matches for searchText found in the WebView with the provided findOptions. The number of matches will be provided by the FindController::counted-matches signal.

getMaxMatchCount

findControllerGetMaxMatchCount Source #

Arguments

:: (HasCallStack, MonadIO m, IsFindController a) 
=> a

findController: the FindController

-> m Word32

Returns: 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 findControllerSearch or findControllerCountMatches.

getOptions

findControllerGetOptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsFindController a) 
=> a

findController: the FindController

-> m Word32

Returns: a bitmask containing the FindOptions associated with the current search.

Gets a bitmask containing the FindOptions associated with the current search.

getSearchText

findControllerGetSearchText Source #

Arguments

:: (HasCallStack, MonadIO m, IsFindController a) 
=> a

findController: the FindController

-> m Text

Returns: the text to look for in the WebView.

Gets the text that findController is currently searching for. This text is passed to either findControllerSearch or findControllerCountMatches.

getWebView

findControllerGetWebView Source #

Arguments

:: (HasCallStack, MonadIO m, IsFindController a) 
=> a

findController: the FindController

-> m WebView

Returns: the WebView.

Gets the WebView this find controller is associated to. Do not dereference the returned instance as it belongs to the FindController.

search

findControllerSearch Source #

Arguments

:: (HasCallStack, MonadIO m, IsFindController a) 
=> a

findController: the FindController

-> Text

searchText: the text to look for

-> Word32

findOptions: a bitmask with the FindOptions used in the search

-> Word32

maxMatchCount: the maximum number of matches allowed in the search

-> m () 

Looks for searchText in the WebView associated with findController since the beginning of the document highlighting up to maxMatchCount matches. The outcome of the search will be asynchronously provided by the FindController::found-text and FindController::failed-to-find-text signals.

To look for the next or previous occurrences of the same text with the same find options use findControllerSearchNext and/or findControllerSearchPrevious. The FindController 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 maxMatchCount then FindController::found-text will report G_MAXUINT matches instead of the actual number.

Callers should call findControllerSearchFinish to finish the current search operation.

searchFinish

findControllerSearchFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsFindController a) 
=> a

findController: a FindController

-> m () 

Finishes a find operation started by findControllerSearch. 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.

searchNext

findControllerSearchNext Source #

Arguments

:: (HasCallStack, MonadIO m, IsFindController a) 
=> a

findController: the FindController

-> m () 

Looks for the next occurrence of the search text.

Calling this method before findControllerSearch or findControllerCountMatches is a programming error.

searchPrevious

findControllerSearchPrevious Source #

Arguments

:: (HasCallStack, MonadIO m, IsFindController a) 
=> a

findController: the FindController

-> m () 

Looks for the previous occurrence of the search text.

Calling this method before findControllerSearch or findControllerCountMatches is a programming error.

Properties

maxMatchCount

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

getFindControllerMaxMatchCount :: (MonadIO m, IsFindController o) => o -> m Word32 Source #

Get the value of the “max-match-count” property. When overloading is enabled, this is equivalent to

get findController #maxMatchCount

options

The options to be used in the search operation.

getFindControllerOptions :: (MonadIO m, IsFindController o) => o -> m [FindOptions] Source #

Get the value of the “options” property. When overloading is enabled, this is equivalent to

get findController #options

text

The current search text for this FindController.

getFindControllerText :: (MonadIO m, IsFindController o) => o -> m (Maybe Text) Source #

Get the value of the “text” property. When overloading is enabled, this is equivalent to

get findController #text

webView

The WebView this controller is associated to.

constructFindControllerWebView :: (IsFindController o, IsWebView a) => a -> IO (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “web-view” property. This is rarely needed directly, but it is used by new.

getFindControllerWebView :: (MonadIO m, IsFindController o) => o -> m WebView Source #

Get the value of the “web-view” property. When overloading is enabled, this is equivalent to

get findController #webView

Signals

countedMatches

type C_FindControllerCountedMatchesCallback = Ptr () -> Word32 -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type FindControllerCountedMatchesCallback Source #

Arguments

 = Word32

matchCount: the number of matches of the search text

-> IO () 

This signal is emitted when the FindController has counted the number of matches for a given text after a call to findControllerCountMatches.

afterFindControllerCountedMatches :: (IsFindController a, MonadIO m) => a -> FindControllerCountedMatchesCallback -> m SignalHandlerId Source #

Connect a signal handler for the “counted-matches” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after findController #countedMatches callback

onFindControllerCountedMatches :: (IsFindController a, MonadIO m) => a -> FindControllerCountedMatchesCallback -> m SignalHandlerId Source #

Connect a signal handler for the “counted-matches” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on findController #countedMatches callback

failedToFindText

type C_FindControllerFailedToFindTextCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type FindControllerFailedToFindTextCallback = IO () Source #

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 findControllerSearch, findControllerSearchNext or findControllerSearchPrevious.

afterFindControllerFailedToFindText :: (IsFindController a, MonadIO m) => a -> FindControllerFailedToFindTextCallback -> m SignalHandlerId Source #

Connect a signal handler for the “failed-to-find-text” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after findController #failedToFindText callback

onFindControllerFailedToFindText :: (IsFindController a, MonadIO m) => a -> FindControllerFailedToFindTextCallback -> m SignalHandlerId Source #

Connect a signal handler for the “failed-to-find-text” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on findController #failedToFindText callback

foundText

type C_FindControllerFoundTextCallback = Ptr () -> Word32 -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type FindControllerFoundTextCallback Source #

Arguments

 = Word32

matchCount: the number of matches found of the search text

-> IO () 

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 findControllerSearch, findControllerSearchNext or findControllerSearchPrevious.

afterFindControllerFoundText :: (IsFindController a, MonadIO m) => a -> FindControllerFoundTextCallback -> m SignalHandlerId Source #

Connect a signal handler for the “found-text” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after findController #foundText callback

onFindControllerFoundText :: (IsFindController a, MonadIO m) => a -> FindControllerFoundTextCallback -> m SignalHandlerId Source #

Connect a signal handler for the “found-text” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on findController #foundText callback