Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype SearchSettings = SearchSettings (ManagedPtr SearchSettings)
- class (GObject o, IsDescendantOf SearchSettings o) => IsSearchSettings o
- toSearchSettings :: (MonadIO m, IsSearchSettings o) => o -> m SearchSettings
- noSearchSettings :: Maybe SearchSettings
- searchSettingsGetAtWordBoundaries :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m Bool
- searchSettingsGetCaseSensitive :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m Bool
- searchSettingsGetRegexEnabled :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m Bool
- searchSettingsGetSearchText :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m (Maybe Text)
- searchSettingsGetWrapAround :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m Bool
- searchSettingsNew :: (HasCallStack, MonadIO m) => m SearchSettings
- searchSettingsSetAtWordBoundaries :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Bool -> m ()
- searchSettingsSetCaseSensitive :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Bool -> m ()
- searchSettingsSetRegexEnabled :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Bool -> m ()
- searchSettingsSetSearchText :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Maybe Text -> m ()
- searchSettingsSetWrapAround :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Bool -> m ()
- constructSearchSettingsAtWordBoundaries :: IsSearchSettings o => Bool -> IO (GValueConstruct o)
- getSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> m Bool
- setSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()
- constructSearchSettingsCaseSensitive :: IsSearchSettings o => Bool -> IO (GValueConstruct o)
- getSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> m Bool
- setSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()
- constructSearchSettingsRegexEnabled :: IsSearchSettings o => Bool -> IO (GValueConstruct o)
- getSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> m Bool
- setSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()
- clearSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> m ()
- constructSearchSettingsSearchText :: IsSearchSettings o => Text -> IO (GValueConstruct o)
- getSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> m (Maybe Text)
- setSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> Text -> m ()
- constructSearchSettingsWrapAround :: IsSearchSettings o => Bool -> IO (GValueConstruct o)
- getSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> m Bool
- setSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()
Exported types
newtype SearchSettings Source #
Memory-managed wrapper type.
SearchSettings (ManagedPtr SearchSettings) |
Instances
GObject SearchSettings Source # | |
Defined in GI.GtkSource.Objects.SearchSettings gobjectType :: IO GType | |
HasParentTypes SearchSettings Source # | |
Defined in GI.GtkSource.Objects.SearchSettings | |
type ParentTypes SearchSettings Source # | |
Defined in GI.GtkSource.Objects.SearchSettings |
class (GObject o, IsDescendantOf SearchSettings o) => IsSearchSettings o Source #
Type class for types which can be safely cast to SearchSettings
, for instance with toSearchSettings
.
Instances
(GObject o, IsDescendantOf SearchSettings o) => IsSearchSettings o Source # | |
Defined in GI.GtkSource.Objects.SearchSettings |
toSearchSettings :: (MonadIO m, IsSearchSettings o) => o -> m SearchSettings Source #
Cast to SearchSettings
, for types for which this is known to be safe. For general casts, use castTo
.
noSearchSettings :: Maybe SearchSettings Source #
A convenience alias for Nothing
:: Maybe
SearchSettings
.
Methods
getAtWordBoundaries
searchSettingsGetAtWordBoundaries Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> m Bool | Returns: whether to search at word boundaries. |
No description available in the introspection data.
Since: 3.10
getCaseSensitive
searchSettingsGetCaseSensitive Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> m Bool | Returns: whether the search is case sensitive. |
No description available in the introspection data.
Since: 3.10
getRegexEnabled
searchSettingsGetRegexEnabled Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> m Bool | Returns: whether to search by regular expressions. |
No description available in the introspection data.
Since: 3.10
getSearchText
searchSettingsGetSearchText Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> m (Maybe Text) | Returns: the text to search, or |
Gets the text to search. The return value must not be freed.
You may be interested to call utilsEscapeSearchText
after
this function.
Since: 3.10
getWrapAround
searchSettingsGetWrapAround Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> m Bool | Returns: whether to wrap around the search. |
No description available in the introspection data.
Since: 3.10
new
:: (HasCallStack, MonadIO m) | |
=> m SearchSettings | Returns: a new search settings object. |
Creates a new search settings object.
Since: 3.10
setAtWordBoundaries
searchSettingsSetAtWordBoundaries Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> Bool |
|
-> m () |
Change whether the search is done at word boundaries. If atWordBoundaries
is True
, a search match must start and end a word. The match can span
multiple words. See also textIterStartsWord
and
textIterEndsWord
.
Since: 3.10
setCaseSensitive
searchSettingsSetCaseSensitive Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> Bool |
|
-> m () |
Enables or disables the case sensitivity for the search.
Since: 3.10
setRegexEnabled
searchSettingsSetRegexEnabled Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> Bool |
|
-> m () |
Enables or disables whether to search by regular expressions.
If enabled, the SearchSettings
:search-text
property contains the
pattern of the regular expression.
SearchContext
uses Regex
when regex search is enabled. See the
Regular expression syntax
page in the GLib reference manual.
Since: 3.10
setSearchText
searchSettingsSetSearchText Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the text to search. If searchText
is Nothing
or is empty, the search
will be disabled. A copy of searchText
will be made, so you can safely free
searchText
after a call to this function.
You may be interested to call utilsUnescapeSearchText
before
this function.
Since: 3.10
setWrapAround
searchSettingsSetWrapAround Source #
:: (HasCallStack, MonadIO m, IsSearchSettings a) | |
=> a |
|
-> Bool |
|
-> m () |
Enables or disables the wrap around search. If wrapAround
is True
, the
forward search continues at the beginning of the buffer if no search
occurrences are found. Similarly, the backward search continues to search at
the end of the buffer.
Since: 3.10
Properties
atWordBoundaries
If True
, a search match must start and end a word. The match can
span multiple words.
Since: 3.10
constructSearchSettingsAtWordBoundaries :: IsSearchSettings o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “at-word-boundaries
” property. This is rarely needed directly, but it is used by new
.
getSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> m Bool Source #
Get the value of the “at-word-boundaries
” property.
When overloading is enabled, this is equivalent to
get
searchSettings #atWordBoundaries
setSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m () Source #
Set the value of the “at-word-boundaries
” property.
When overloading is enabled, this is equivalent to
set
searchSettings [ #atWordBoundaries:=
value ]
caseSensitive
Whether the search is case sensitive.
Since: 3.10
constructSearchSettingsCaseSensitive :: IsSearchSettings o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “case-sensitive
” property. This is rarely needed directly, but it is used by new
.
getSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> m Bool Source #
Get the value of the “case-sensitive
” property.
When overloading is enabled, this is equivalent to
get
searchSettings #caseSensitive
setSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m () Source #
Set the value of the “case-sensitive
” property.
When overloading is enabled, this is equivalent to
set
searchSettings [ #caseSensitive:=
value ]
regexEnabled
Search by regular expressions with
SearchSettings
:search-text
as the pattern.
Since: 3.10
constructSearchSettingsRegexEnabled :: IsSearchSettings o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “regex-enabled
” property. This is rarely needed directly, but it is used by new
.
getSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> m Bool Source #
Get the value of the “regex-enabled
” property.
When overloading is enabled, this is equivalent to
get
searchSettings #regexEnabled
setSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m () Source #
Set the value of the “regex-enabled
” property.
When overloading is enabled, this is equivalent to
set
searchSettings [ #regexEnabled:=
value ]
searchText
A search string, or Nothing
if the search is disabled. If the regular
expression search is enabled, SearchSettings
:search-text
is
the pattern.
Since: 3.10
clearSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> m () Source #
Set the value of the “search-text
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#searchText
constructSearchSettingsSearchText :: IsSearchSettings o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “search-text
” property. This is rarely needed directly, but it is used by new
.
getSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> m (Maybe Text) Source #
Get the value of the “search-text
” property.
When overloading is enabled, this is equivalent to
get
searchSettings #searchText
setSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> Text -> m () Source #
Set the value of the “search-text
” property.
When overloading is enabled, this is equivalent to
set
searchSettings [ #searchText:=
value ]
wrapAround
For a forward search, continue at the beginning of the buffer if no search occurrence is found. For a backward search, continue at the end of the buffer.
Since: 3.10
constructSearchSettingsWrapAround :: IsSearchSettings o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “wrap-around
” property. This is rarely needed directly, but it is used by new
.
getSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> m Bool Source #
Get the value of the “wrap-around
” property.
When overloading is enabled, this is equivalent to
get
searchSettings #wrapAround
setSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m () Source #
Set the value of the “wrap-around
” property.
When overloading is enabled, this is equivalent to
set
searchSettings [ #wrapAround:=
value ]