GI.WebKit2.Objects.FindController

Exported types

newtype FindController

Constructors

FindController (ManagedPtr FindController)

Instances

GObject FindController

Methods

gobjectType :: FindController -> IO GType

IsObject FindController

IsFindController FindController

class GObject o => IsFindController o

Instances

(GObject a, UnknownAncestorError Constraint FindController a) => IsFindController a

IsFindController FindController

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

noFindController :: Maybe FindController

Methods

countMatches

findControllerCountMatches

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

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

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

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

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 unref the returned instance as it belongs to the FindController.

search

findControllerSearch

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

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

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

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

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

options

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

text

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

webView

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

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

Signals

countedMatches

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

type FindControllerCountedMatchesCallback = Word32 -> IO ()

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

genClosure_FindControllerCountedMatches :: FindControllerCountedMatchesCallback -> IO Closure

mk_FindControllerCountedMatchesCallback :: C_FindControllerCountedMatchesCallback -> IO (FunPtr C_FindControllerCountedMatchesCallback)

noFindControllerCountedMatchesCallback :: Maybe FindControllerCountedMatchesCallback

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

wrap_FindControllerCountedMatchesCallback :: FindControllerCountedMatchesCallback -> Ptr () -> Word32 -> Ptr () -> IO ()

failedToFindText

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

type FindControllerFailedToFindTextCallback = IO ()

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

genClosure_FindControllerFailedToFindText :: FindControllerFailedToFindTextCallback -> IO Closure

mk_FindControllerFailedToFindTextCallback :: C_FindControllerFailedToFindTextCallback -> IO (FunPtr C_FindControllerFailedToFindTextCallback)

noFindControllerFailedToFindTextCallback :: Maybe FindControllerFailedToFindTextCallback

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

wrap_FindControllerFailedToFindTextCallback :: FindControllerFailedToFindTextCallback -> Ptr () -> Ptr () -> IO ()

foundText

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

type FindControllerFoundTextCallback = Word32 -> IO ()

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

genClosure_FindControllerFoundText :: FindControllerFoundTextCallback -> IO Closure

mk_FindControllerFoundTextCallback :: C_FindControllerFoundTextCallback -> IO (FunPtr C_FindControllerFoundTextCallback)

noFindControllerFoundTextCallback :: Maybe FindControllerFoundTextCallback

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

wrap_FindControllerFoundTextCallback :: FindControllerFoundTextCallback -> Ptr () -> Word32 -> Ptr () -> IO ()