Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.WebKit2.Objects.FindController

Contents

Exported types
Methods
Properties
Signals

Description

Synopsis

Exported types

newtype FindController Source #

Constructors

FindController (ManagedPtr FindController)

Instances

GObject FindController Source #
Methods gobjectType :: FindController -> IO GType #
IsObject FindController Source #

IsFindController FindController Source #

((~) * info (ResolveFindControllerMethod t FindController), MethodInfo * info FindController p) => IsLabel t (FindController -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> FindController -> p #
((~) * info (ResolveFindControllerMethod t FindController), MethodInfo * info FindController p) => IsLabelProxy t (FindController -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> FindController -> p #
HasAttributeList * FindController Source #

type AttributeList FindController Source #
type AttributeList FindController
type SignalList FindController Source #
type SignalList FindController

class GObject o => IsFindController o Source #

Instances

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

IsFindController FindController Source #

toFindController :: IsFindController o => o -> IO FindController Source #

noFindController :: Maybe FindController Source #

Methods

countMatches

data FindControllerCountMatchesMethodInfo Source #

Instances

((~) * signature (Text -> Word32 -> Word32 -> m ()), MonadIO m, IsFindController a) => MethodInfo * FindControllerCountMatchesMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FindControllerCountMatchesMethodInfo a -> signature -> s #

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

data FindControllerGetMaxMatchCountMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m, IsFindController a) => MethodInfo * FindControllerGetMaxMatchCountMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FindControllerGetMaxMatchCountMethodInfo a -> signature -> s #

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

data FindControllerGetOptionsMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m, IsFindController a) => MethodInfo * FindControllerGetOptionsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FindControllerGetOptionsMethodInfo a -> signature -> s #

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

data FindControllerGetSearchTextMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsFindController a) => MethodInfo * FindControllerGetSearchTextMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FindControllerGetSearchTextMethodInfo a -> signature -> s #

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

data FindControllerGetWebViewMethodInfo Source #

Instances

((~) * signature (m WebView), MonadIO m, IsFindController a) => MethodInfo * FindControllerGetWebViewMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FindControllerGetWebViewMethodInfo a -> signature -> s #

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

search

data FindControllerSearchMethodInfo Source #

Instances

((~) * signature (Text -> Word32 -> Word32 -> m ()), MonadIO m, IsFindController a) => MethodInfo * FindControllerSearchMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FindControllerSearchMethodInfo a -> signature -> s #

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

data FindControllerSearchFinishMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsFindController a) => MethodInfo * FindControllerSearchFinishMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FindControllerSearchFinishMethodInfo a -> signature -> s #

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

data FindControllerSearchNextMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsFindController a) => MethodInfo * FindControllerSearchNextMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FindControllerSearchNextMethodInfo a -> signature -> s #

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

data FindControllerSearchPreviousMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsFindController a) => MethodInfo * FindControllerSearchPreviousMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy FindControllerSearchPreviousMethodInfo a -> signature -> s #

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

data FindControllerMaxMatchCountPropertyInfo Source #

Instances

AttrInfo FindControllerMaxMatchCountPropertyInfo Source #
Associated Types type AttrAllowedOps FindControllerMaxMatchCountPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FindControllerMaxMatchCountPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FindControllerMaxMatchCountPropertyInfo :: * -> Constraint # type AttrGetType FindControllerMaxMatchCountPropertyInfo :: * # type AttrLabel FindControllerMaxMatchCountPropertyInfo :: Symbol # type AttrOrigin FindControllerMaxMatchCountPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FindControllerMaxMatchCountPropertyInfo o => Proxy * FindControllerMaxMatchCountPropertyInfo -> o -> IO (AttrGetType FindControllerMaxMatchCountPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FindControllerMaxMatchCountPropertyInfo o, AttrSetTypeConstraint FindControllerMaxMatchCountPropertyInfo b) => Proxy * FindControllerMaxMatchCountPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FindControllerMaxMatchCountPropertyInfo o => Proxy * FindControllerMaxMatchCountPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FindControllerMaxMatchCountPropertyInfo o, AttrSetTypeConstraint FindControllerMaxMatchCountPropertyInfo b) => Proxy * FindControllerMaxMatchCountPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FindControllerMaxMatchCountPropertyInfo Source #
type AttrOrigin FindControllerMaxMatchCountPropertyInfo = FindController
type AttrLabel FindControllerMaxMatchCountPropertyInfo Source #
type AttrLabel FindControllerMaxMatchCountPropertyInfo = "max-match-count"
type AttrGetType FindControllerMaxMatchCountPropertyInfo Source #
type AttrGetType FindControllerMaxMatchCountPropertyInfo = Word32
type AttrBaseTypeConstraint FindControllerMaxMatchCountPropertyInfo Source #
type AttrBaseTypeConstraint FindControllerMaxMatchCountPropertyInfo = IsFindController
type AttrSetTypeConstraint FindControllerMaxMatchCountPropertyInfo Source #
type AttrSetTypeConstraint FindControllerMaxMatchCountPropertyInfo = * ~ ()
type AttrAllowedOps FindControllerMaxMatchCountPropertyInfo Source #
type AttrAllowedOps FindControllerMaxMatchCountPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

findControllerMaxMatchCount :: AttrLabelProxy "maxMatchCount" Source #

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

options

data FindControllerOptionsPropertyInfo Source #

Instances

AttrInfo FindControllerOptionsPropertyInfo Source #
Associated Types type AttrAllowedOps FindControllerOptionsPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FindControllerOptionsPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FindControllerOptionsPropertyInfo :: * -> Constraint # type AttrGetType FindControllerOptionsPropertyInfo :: * # type AttrLabel FindControllerOptionsPropertyInfo :: Symbol # type AttrOrigin FindControllerOptionsPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FindControllerOptionsPropertyInfo o => Proxy * FindControllerOptionsPropertyInfo -> o -> IO (AttrGetType FindControllerOptionsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FindControllerOptionsPropertyInfo o, AttrSetTypeConstraint FindControllerOptionsPropertyInfo b) => Proxy * FindControllerOptionsPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FindControllerOptionsPropertyInfo o => Proxy * FindControllerOptionsPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FindControllerOptionsPropertyInfo o, AttrSetTypeConstraint FindControllerOptionsPropertyInfo b) => Proxy * FindControllerOptionsPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FindControllerOptionsPropertyInfo Source #
type AttrOrigin FindControllerOptionsPropertyInfo = FindController
type AttrLabel FindControllerOptionsPropertyInfo Source #
type AttrLabel FindControllerOptionsPropertyInfo = "options"
type AttrGetType FindControllerOptionsPropertyInfo Source #
type AttrGetType FindControllerOptionsPropertyInfo = [FindOptions]
type AttrBaseTypeConstraint FindControllerOptionsPropertyInfo Source #
type AttrBaseTypeConstraint FindControllerOptionsPropertyInfo = IsFindController
type AttrSetTypeConstraint FindControllerOptionsPropertyInfo Source #
type AttrSetTypeConstraint FindControllerOptionsPropertyInfo = * ~ ()
type AttrAllowedOps FindControllerOptionsPropertyInfo Source #
type AttrAllowedOps FindControllerOptionsPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

findControllerOptions :: AttrLabelProxy "options" Source #

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

text

data FindControllerTextPropertyInfo Source #

Instances

AttrInfo FindControllerTextPropertyInfo Source #
Associated Types type AttrAllowedOps FindControllerTextPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FindControllerTextPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FindControllerTextPropertyInfo :: * -> Constraint # type AttrGetType FindControllerTextPropertyInfo :: * # type AttrLabel FindControllerTextPropertyInfo :: Symbol # type AttrOrigin FindControllerTextPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FindControllerTextPropertyInfo o => Proxy * FindControllerTextPropertyInfo -> o -> IO (AttrGetType FindControllerTextPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FindControllerTextPropertyInfo o, AttrSetTypeConstraint FindControllerTextPropertyInfo b) => Proxy * FindControllerTextPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FindControllerTextPropertyInfo o => Proxy * FindControllerTextPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FindControllerTextPropertyInfo o, AttrSetTypeConstraint FindControllerTextPropertyInfo b) => Proxy * FindControllerTextPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FindControllerTextPropertyInfo Source #
type AttrOrigin FindControllerTextPropertyInfo = FindController
type AttrLabel FindControllerTextPropertyInfo Source #
type AttrLabel FindControllerTextPropertyInfo = "text"
type AttrGetType FindControllerTextPropertyInfo Source #
type AttrGetType FindControllerTextPropertyInfo = Maybe Text
type AttrBaseTypeConstraint FindControllerTextPropertyInfo Source #
type AttrBaseTypeConstraint FindControllerTextPropertyInfo = IsFindController
type AttrSetTypeConstraint FindControllerTextPropertyInfo Source #
type AttrSetTypeConstraint FindControllerTextPropertyInfo = * ~ ()
type AttrAllowedOps FindControllerTextPropertyInfo Source #
type AttrAllowedOps FindControllerTextPropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

findControllerText :: AttrLabelProxy "text" Source #

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

webView

data FindControllerWebViewPropertyInfo Source #

Instances

AttrInfo FindControllerWebViewPropertyInfo Source #
Associated Types type AttrAllowedOps FindControllerWebViewPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint FindControllerWebViewPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint FindControllerWebViewPropertyInfo :: * -> Constraint # type AttrGetType FindControllerWebViewPropertyInfo :: * # type AttrLabel FindControllerWebViewPropertyInfo :: Symbol # type AttrOrigin FindControllerWebViewPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint FindControllerWebViewPropertyInfo o => Proxy * FindControllerWebViewPropertyInfo -> o -> IO (AttrGetType FindControllerWebViewPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FindControllerWebViewPropertyInfo o, AttrSetTypeConstraint FindControllerWebViewPropertyInfo b) => Proxy * FindControllerWebViewPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FindControllerWebViewPropertyInfo o => Proxy * FindControllerWebViewPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FindControllerWebViewPropertyInfo o, AttrSetTypeConstraint FindControllerWebViewPropertyInfo b) => Proxy * FindControllerWebViewPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin FindControllerWebViewPropertyInfo Source #
type AttrOrigin FindControllerWebViewPropertyInfo = FindController
type AttrLabel FindControllerWebViewPropertyInfo Source #
type AttrLabel FindControllerWebViewPropertyInfo = "web-view"
type AttrGetType FindControllerWebViewPropertyInfo Source #
type AttrGetType FindControllerWebViewPropertyInfo = WebView
type AttrBaseTypeConstraint FindControllerWebViewPropertyInfo Source #
type AttrBaseTypeConstraint FindControllerWebViewPropertyInfo = IsFindController
type AttrSetTypeConstraint FindControllerWebViewPropertyInfo Source #
type AttrSetTypeConstraint FindControllerWebViewPropertyInfo = IsWebView
type AttrAllowedOps FindControllerWebViewPropertyInfo Source #
type AttrAllowedOps FindControllerWebViewPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

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

findControllerWebView :: AttrLabelProxy "webView" Source #

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

Signals

countedMatches

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

type FindControllerCountedMatchesCallback = Word32 -> IO () Source #

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

genClosure_FindControllerCountedMatches :: FindControllerCountedMatchesCallback -> IO Closure Source #

mk_FindControllerCountedMatchesCallback :: C_FindControllerCountedMatchesCallback -> IO (FunPtr C_FindControllerCountedMatchesCallback) Source #

noFindControllerCountedMatchesCallback :: Maybe FindControllerCountedMatchesCallback Source #

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

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

failedToFindText

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

type FindControllerFailedToFindTextCallback = IO () Source #

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

genClosure_FindControllerFailedToFindText :: FindControllerFailedToFindTextCallback -> IO Closure Source #

mk_FindControllerFailedToFindTextCallback :: C_FindControllerFailedToFindTextCallback -> IO (FunPtr C_FindControllerFailedToFindTextCallback) Source #

noFindControllerFailedToFindTextCallback :: Maybe FindControllerFailedToFindTextCallback Source #

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

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

foundText

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

type FindControllerFoundTextCallback = Word32 -> IO () Source #

data FindControllerFoundTextSignalInfo Source #

Instances

SignalInfo FindControllerFoundTextSignalInfo Source #
Associated Types type HaskellCallbackType FindControllerFoundTextSignalInfo :: * # Methods connectSignal :: GObject o => SignalProxy o FindControllerFoundTextSignalInfo -> o -> HaskellCallbackType FindControllerFoundTextSignalInfo -> SignalConnectMode -> IO SignalHandlerId #
type HaskellCallbackType FindControllerFoundTextSignalInfo Source #
type HaskellCallbackType FindControllerFoundTextSignalInfo = FindControllerFoundTextCallback

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

genClosure_FindControllerFoundText :: FindControllerFoundTextCallback -> IO Closure Source #

mk_FindControllerFoundTextCallback :: C_FindControllerFoundTextCallback -> IO (FunPtr C_FindControllerFoundTextCallback) Source #

noFindControllerFoundTextCallback :: Maybe FindControllerFoundTextCallback Source #

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

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

SignalInfo FindControllerCountedMatchesSignalInfo Source #
Associated Types type HaskellCallbackType FindControllerCountedMatchesSignalInfo :: * # Methods connectSignal :: GObject o => SignalProxy o FindControllerCountedMatchesSignalInfo -> o -> HaskellCallbackType FindControllerCountedMatchesSignalInfo -> SignalConnectMode -> IO SignalHandlerId #
type HaskellCallbackType FindControllerCountedMatchesSignalInfo Source #
type HaskellCallbackType FindControllerCountedMatchesSignalInfo = FindControllerCountedMatchesCallback

SignalInfo FindControllerFailedToFindTextSignalInfo Source #
Associated Types type HaskellCallbackType FindControllerFailedToFindTextSignalInfo :: * # Methods connectSignal :: GObject o => SignalProxy o FindControllerFailedToFindTextSignalInfo -> o -> HaskellCallbackType FindControllerFailedToFindTextSignalInfo -> SignalConnectMode -> IO SignalHandlerId #
type HaskellCallbackType FindControllerFailedToFindTextSignalInfo Source #
type HaskellCallbackType FindControllerFailedToFindTextSignalInfo = FindControllerFailedToFindTextCallback