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 |
- newtype FindController = FindController (ManagedPtr FindController)
- class GObject o => IsFindController o
- toFindController :: (MonadIO m, IsFindController o) => o -> m FindController
- noFindController :: Maybe FindController
- findControllerCountMatches :: (HasCallStack, MonadIO m, IsFindController a) => a -> Text -> Word32 -> Word32 -> m ()
- findControllerGetMaxMatchCount :: (HasCallStack, MonadIO m, IsFindController a) => a -> m Word32
- findControllerGetOptions :: (HasCallStack, MonadIO m, IsFindController a) => a -> m Word32
- findControllerGetSearchText :: (HasCallStack, MonadIO m, IsFindController a) => a -> m Text
- findControllerGetWebView :: (HasCallStack, MonadIO m, IsFindController a) => a -> m WebView
- findControllerSearch :: (HasCallStack, MonadIO m, IsFindController a) => a -> Text -> Word32 -> Word32 -> m ()
- findControllerSearchFinish :: (HasCallStack, MonadIO m, IsFindController a) => a -> m ()
- findControllerSearchNext :: (HasCallStack, MonadIO m, IsFindController a) => a -> m ()
- findControllerSearchPrevious :: (HasCallStack, MonadIO m, IsFindController a) => a -> m ()
- getFindControllerMaxMatchCount :: (MonadIO m, IsFindController o) => o -> m Word32
- getFindControllerOptions :: (MonadIO m, IsFindController o) => o -> m [FindOptions]
- getFindControllerText :: (MonadIO m, IsFindController o) => o -> m (Maybe Text)
- constructFindControllerWebView :: (IsFindController o, IsWebView a) => a -> IO (GValueConstruct o)
- getFindControllerWebView :: (MonadIO m, IsFindController o) => o -> m WebView
- 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 ()
- 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 ()
- 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 ()
Exported types
newtype FindController Source #
class GObject o => IsFindController o Source #
toFindController :: (MonadIO m, IsFindController o) => o -> m FindController Source #
Methods
countMatches
findControllerCountMatches Source #
:: (HasCallStack, MonadIO m, IsFindController a) | |
=> a |
|
-> Text |
|
-> Word32 |
|
-> Word32 |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsFindController a) | |
=> a |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsFindController a) | |
=> a |
|
-> m Word32 | Returns: a bitmask containing the |
Gets a bitmask containing the FindOptions
associated with
the current search.
getSearchText
findControllerGetSearchText Source #
:: (HasCallStack, MonadIO m, IsFindController a) | |
=> a |
|
-> m Text | Returns: the text to look for in the |
Gets the text that findController
is currently searching
for. This text is passed to either
findControllerSearch
or
findControllerCountMatches
.
getWebView
findControllerGetWebView Source #
:: (HasCallStack, MonadIO m, IsFindController a) | |
=> a |
|
-> m WebView | Returns: the |
Gets the WebView
this find controller is associated to. Do
not unref the returned instance as it belongs to the
FindController
.
search
:: (HasCallStack, MonadIO m, IsFindController a) | |
=> a |
|
-> Text |
|
-> Word32 |
|
-> Word32 |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsFindController a) | |
=> a |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsFindController a) | |
=> a |
|
-> m () |
Looks for the next occurrence of the search text.
Calling this method before findControllerSearch
or
findControllerCountMatches
is a programming error.
searchPrevious
findControllerSearchPrevious Source #
:: (HasCallStack, MonadIO m, IsFindController a) | |
=> a |
|
-> 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 Source #
options
getFindControllerOptions :: (MonadIO m, IsFindController o) => o -> m [FindOptions] Source #
text
getFindControllerText :: (MonadIO m, IsFindController o) => o -> m (Maybe Text) Source #
webView
constructFindControllerWebView :: (IsFindController o, IsWebView a) => a -> IO (GValueConstruct o) Source #
getFindControllerWebView :: (MonadIO m, IsFindController o) => o -> m WebView Source #
Signals
countedMatches
type FindControllerCountedMatchesCallback = Word32 -> IO () Source #
afterFindControllerCountedMatches :: (IsFindController a, MonadIO m) => a -> FindControllerCountedMatchesCallback -> m SignalHandlerId Source #
genClosure_FindControllerCountedMatches :: FindControllerCountedMatchesCallback -> IO Closure Source #
mk_FindControllerCountedMatchesCallback :: C_FindControllerCountedMatchesCallback -> IO (FunPtr C_FindControllerCountedMatchesCallback) Source #
onFindControllerCountedMatches :: (IsFindController a, MonadIO m) => a -> FindControllerCountedMatchesCallback -> m SignalHandlerId Source #
wrap_FindControllerCountedMatchesCallback :: FindControllerCountedMatchesCallback -> Ptr () -> Word32 -> Ptr () -> IO () Source #
failedToFindText
type FindControllerFailedToFindTextCallback = IO () Source #
afterFindControllerFailedToFindText :: (IsFindController a, MonadIO m) => a -> FindControllerFailedToFindTextCallback -> m SignalHandlerId Source #
genClosure_FindControllerFailedToFindText :: FindControllerFailedToFindTextCallback -> IO Closure Source #
mk_FindControllerFailedToFindTextCallback :: C_FindControllerFailedToFindTextCallback -> IO (FunPtr C_FindControllerFailedToFindTextCallback) Source #
onFindControllerFailedToFindText :: (IsFindController a, MonadIO m) => a -> FindControllerFailedToFindTextCallback -> m SignalHandlerId Source #
wrap_FindControllerFailedToFindTextCallback :: FindControllerFailedToFindTextCallback -> Ptr () -> Ptr () -> IO () Source #
foundText
type FindControllerFoundTextCallback = Word32 -> IO () Source #
afterFindControllerFoundText :: (IsFindController a, MonadIO m) => a -> FindControllerFoundTextCallback -> m SignalHandlerId Source #
mk_FindControllerFoundTextCallback :: C_FindControllerFoundTextCallback -> IO (FunPtr C_FindControllerFoundTextCallback) Source #
onFindControllerFoundText :: (IsFindController a, MonadIO m) => a -> FindControllerFoundTextCallback -> m SignalHandlerId Source #
wrap_FindControllerFoundTextCallback :: FindControllerFoundTextCallback -> Ptr () -> Word32 -> Ptr () -> IO () Source #