| 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.GtkSource.Objects.SearchSettings
Contents
Description
- newtype SearchSettings = SearchSettings (ManagedPtr SearchSettings)
- class GObject o => IsSearchSettings o
- toSearchSettings :: IsSearchSettings o => o -> IO SearchSettings
- noSearchSettings :: Maybe SearchSettings
- data SearchSettingsGetAtWordBoundariesMethodInfo
- searchSettingsGetAtWordBoundaries :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m Bool
- data SearchSettingsGetCaseSensitiveMethodInfo
- searchSettingsGetCaseSensitive :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m Bool
- data SearchSettingsGetRegexEnabledMethodInfo
- searchSettingsGetRegexEnabled :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m Bool
- data SearchSettingsGetSearchTextMethodInfo
- searchSettingsGetSearchText :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m (Maybe Text)
- data SearchSettingsGetWrapAroundMethodInfo
- searchSettingsGetWrapAround :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> m Bool
- searchSettingsNew :: (HasCallStack, MonadIO m) => m SearchSettings
- data SearchSettingsSetAtWordBoundariesMethodInfo
- searchSettingsSetAtWordBoundaries :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Bool -> m ()
- data SearchSettingsSetCaseSensitiveMethodInfo
- searchSettingsSetCaseSensitive :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Bool -> m ()
- data SearchSettingsSetRegexEnabledMethodInfo
- searchSettingsSetRegexEnabled :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Bool -> m ()
- data SearchSettingsSetSearchTextMethodInfo
- searchSettingsSetSearchText :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Maybe Text -> m ()
- data SearchSettingsSetWrapAroundMethodInfo
- searchSettingsSetWrapAround :: (HasCallStack, MonadIO m, IsSearchSettings a) => a -> Bool -> m ()
- data SearchSettingsAtWordBoundariesPropertyInfo
- constructSearchSettingsAtWordBoundaries :: IsSearchSettings o => Bool -> IO (GValueConstruct o)
- getSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> m Bool
- searchSettingsAtWordBoundaries :: AttrLabelProxy "atWordBoundaries"
- setSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()
- data SearchSettingsCaseSensitivePropertyInfo
- constructSearchSettingsCaseSensitive :: IsSearchSettings o => Bool -> IO (GValueConstruct o)
- getSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> m Bool
- searchSettingsCaseSensitive :: AttrLabelProxy "caseSensitive"
- setSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()
- data SearchSettingsRegexEnabledPropertyInfo
- constructSearchSettingsRegexEnabled :: IsSearchSettings o => Bool -> IO (GValueConstruct o)
- getSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> m Bool
- searchSettingsRegexEnabled :: AttrLabelProxy "regexEnabled"
- setSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()
- data SearchSettingsSearchTextPropertyInfo
- clearSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> m ()
- constructSearchSettingsSearchText :: IsSearchSettings o => Text -> IO (GValueConstruct o)
- getSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> m (Maybe Text)
- searchSettingsSearchText :: AttrLabelProxy "searchText"
- setSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> Text -> m ()
- data SearchSettingsWrapAroundPropertyInfo
- constructSearchSettingsWrapAround :: IsSearchSettings o => Bool -> IO (GValueConstruct o)
- getSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> m Bool
- searchSettingsWrapAround :: AttrLabelProxy "wrapAround"
- setSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()
Exported types
newtype SearchSettings Source #
Constructors
| SearchSettings (ManagedPtr SearchSettings) |
Instances
| GObject SearchSettings Source # | |
| IsObject SearchSettings Source # | |
| IsSearchSettings SearchSettings Source # | |
| ((~) * info (ResolveSearchSettingsMethod t SearchSettings), MethodInfo * info SearchSettings p) => IsLabel t (SearchSettings -> p) Source # | |
| ((~) * info (ResolveSearchSettingsMethod t SearchSettings), MethodInfo * info SearchSettings p) => IsLabelProxy t (SearchSettings -> p) Source # | |
| HasAttributeList * SearchSettings Source # | |
| type AttributeList SearchSettings Source # | |
| type SignalList SearchSettings Source # | |
class GObject o => IsSearchSettings o Source #
Instances
toSearchSettings :: IsSearchSettings o => o -> IO SearchSettings Source #
Methods
getAtWordBoundaries
data SearchSettingsGetAtWordBoundariesMethodInfo Source #
Instances
| ((~) * signature (m Bool), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsGetAtWordBoundariesMethodInfo a signature Source # | |
searchSettingsGetAtWordBoundaries Source #
Arguments
| :: (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
data SearchSettingsGetCaseSensitiveMethodInfo Source #
Instances
| ((~) * signature (m Bool), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsGetCaseSensitiveMethodInfo a signature Source # | |
searchSettingsGetCaseSensitive Source #
Arguments
| :: (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
data SearchSettingsGetRegexEnabledMethodInfo Source #
Instances
| ((~) * signature (m Bool), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsGetRegexEnabledMethodInfo a signature Source # | |
searchSettingsGetRegexEnabled Source #
Arguments
| :: (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
data SearchSettingsGetSearchTextMethodInfo Source #
Instances
| ((~) * signature (m (Maybe Text)), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsGetSearchTextMethodInfo a signature Source # | |
searchSettingsGetSearchText Source #
Arguments
| :: (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
data SearchSettingsGetWrapAroundMethodInfo Source #
Instances
| ((~) * signature (m Bool), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsGetWrapAroundMethodInfo a signature Source # | |
searchSettingsGetWrapAround Source #
Arguments
| :: (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
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m SearchSettings | Returns: a new search settings object. |
Creates a new search settings object.
Since: 3.10
setAtWordBoundaries
data SearchSettingsSetAtWordBoundariesMethodInfo Source #
Instances
| ((~) * signature (Bool -> m ()), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsSetAtWordBoundariesMethodInfo a signature Source # | |
searchSettingsSetAtWordBoundaries Source #
Arguments
| :: (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
data SearchSettingsSetCaseSensitiveMethodInfo Source #
Instances
| ((~) * signature (Bool -> m ()), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsSetCaseSensitiveMethodInfo a signature Source # | |
searchSettingsSetCaseSensitive Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSearchSettings a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Enables or disables the case sensitivity for the search.
Since: 3.10
setRegexEnabled
data SearchSettingsSetRegexEnabledMethodInfo Source #
Instances
| ((~) * signature (Bool -> m ()), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsSetRegexEnabledMethodInfo a signature Source # | |
searchSettingsSetRegexEnabled Source #
Arguments
| :: (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
data SearchSettingsSetSearchTextMethodInfo Source #
Instances
| ((~) * signature (Maybe Text -> m ()), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsSetSearchTextMethodInfo a signature Source # | |
searchSettingsSetSearchText Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSearchSettings a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets the text to search. If text is Nothing or is empty, the search will be
disabled. A copy of text will be made, so you can safely free text after
a call to this function.
You may be interested to call utilsUnescapeSearchText before
this function.
Since: 3.10
setWrapAround
data SearchSettingsSetWrapAroundMethodInfo Source #
Instances
| ((~) * signature (Bool -> m ()), MonadIO m, IsSearchSettings a) => MethodInfo * SearchSettingsSetWrapAroundMethodInfo a signature Source # | |
searchSettingsSetWrapAround Source #
Arguments
| :: (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
data SearchSettingsAtWordBoundariesPropertyInfo Source #
Instances
constructSearchSettingsAtWordBoundaries :: IsSearchSettings o => Bool -> IO (GValueConstruct o) Source #
getSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> m Bool Source #
searchSettingsAtWordBoundaries :: AttrLabelProxy "atWordBoundaries" Source #
setSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m () Source #
caseSensitive
data SearchSettingsCaseSensitivePropertyInfo Source #
Instances
constructSearchSettingsCaseSensitive :: IsSearchSettings o => Bool -> IO (GValueConstruct o) Source #
getSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> m Bool Source #
searchSettingsCaseSensitive :: AttrLabelProxy "caseSensitive" Source #
setSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m () Source #
regexEnabled
data SearchSettingsRegexEnabledPropertyInfo Source #
Instances
constructSearchSettingsRegexEnabled :: IsSearchSettings o => Bool -> IO (GValueConstruct o) Source #
getSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> m Bool Source #
searchSettingsRegexEnabled :: AttrLabelProxy "regexEnabled" Source #
setSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m () Source #
searchText
data SearchSettingsSearchTextPropertyInfo Source #
Instances
clearSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> m () Source #
constructSearchSettingsSearchText :: IsSearchSettings o => Text -> IO (GValueConstruct o) Source #
getSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> m (Maybe Text) Source #
searchSettingsSearchText :: AttrLabelProxy "searchText" Source #
setSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> Text -> m () Source #
wrapAround
data SearchSettingsWrapAroundPropertyInfo Source #
Instances
constructSearchSettingsWrapAround :: IsSearchSettings o => Bool -> IO (GValueConstruct o) Source #
getSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> m Bool Source #
searchSettingsWrapAround :: AttrLabelProxy "wrapAround" Source #
setSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m () Source #