GI.GtkSource.Objects.SearchSettings

Exported types

newtype SearchSettings

Constructors

SearchSettings (ManagedPtr SearchSettings)

Instances

GObject SearchSettings

Methods

gobjectType :: SearchSettings -> IO GType

IsObject SearchSettings

IsSearchSettings SearchSettings

class GObject o => IsSearchSettings o

Instances

(GObject a, UnknownAncestorError Constraint SearchSettings a) => IsSearchSettings a

IsSearchSettings SearchSettings

toSearchSettings :: (MonadIO m, IsSearchSettings o) => o -> m SearchSettings

noSearchSettings :: Maybe SearchSettings

Methods

getAtWordBoundaries

searchSettingsGetAtWordBoundaries

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> m Bool

Returns: whether to search at word boundaries.

No description available in the introspection data.

Since: 3.10

getCaseSensitive

searchSettingsGetCaseSensitive

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> m Bool

Returns: whether the search is case sensitive.

No description available in the introspection data.

Since: 3.10

getRegexEnabled

searchSettingsGetRegexEnabled

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> m Bool

Returns: whether to search by regular expressions.

No description available in the introspection data.

Since: 3.10

getSearchText

searchSettingsGetSearchText

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> m (Maybe Text)

Returns: the text to search, or Nothing if the search is disabled.

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

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> m Bool

Returns: whether to wrap around the search.

No description available in the introspection data.

Since: 3.10

new

searchSettingsNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SearchSettings

Returns: a new search settings object.

Creates a new search settings object.

Since: 3.10

setAtWordBoundaries

searchSettingsSetAtWordBoundaries

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> Bool

atWordBoundaries: the setting.

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> Bool

caseSensitive: the setting.

-> m ()

Enables or disables the case sensitivity for the search.

Since: 3.10

setRegexEnabled

searchSettingsSetRegexEnabled

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> Bool

regexEnabled: the setting.

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> Maybe Text

searchText: the nul-terminated text to search, or Nothing to disable the search.

-> 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

searchSettingsSetWrapAround

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> Bool

wrapAround: the setting.

-> 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

constructSearchSettingsAtWordBoundaries :: IsSearchSettings o => Bool -> IO (GValueConstruct o)

getSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> m Bool

setSearchSettingsAtWordBoundaries :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()

caseSensitive

constructSearchSettingsCaseSensitive :: IsSearchSettings o => Bool -> IO (GValueConstruct o)

getSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> m Bool

setSearchSettingsCaseSensitive :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()

regexEnabled

constructSearchSettingsRegexEnabled :: IsSearchSettings o => Bool -> IO (GValueConstruct o)

getSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> m Bool

setSearchSettingsRegexEnabled :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()

searchText

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 ()

wrapAround

constructSearchSettingsWrapAround :: IsSearchSettings o => Bool -> IO (GValueConstruct o)

getSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> m Bool

setSearchSettingsWrapAround :: (MonadIO m, IsSearchSettings o) => o -> Bool -> m ()