GI.GtkSource.Objects.SearchSettings

Search settings.

A GtkSourceSearchSettings object represents the settings of a search. The search settings can be associated with one or several [classsearchContext]s.

Exported types

newtype SearchSettings

Memory-managed wrapper type.

Constructors

SearchSettings (ManagedPtr SearchSettings)

Instances

Eq SearchSettings

Defined in GI.GtkSource.Objects.SearchSettings

Methods

(==) :: SearchSettings -> SearchSettings -> Bool

(/=) :: SearchSettings -> SearchSettings -> Bool

GObject SearchSettings

Defined in GI.GtkSource.Objects.SearchSettings

ManagedPtrNewtype SearchSettings

Defined in GI.GtkSource.Objects.SearchSettings

Methods

toManagedPtr :: SearchSettings -> ManagedPtr SearchSettings

TypedObject SearchSettings

Defined in GI.GtkSource.Objects.SearchSettings

Methods

glibType :: IO GType

HasParentTypes SearchSettings

Defined in GI.GtkSource.Objects.SearchSettings

IsGValue (Maybe SearchSettings)

Convert SearchSettings to and from GValue. See toGValue and fromGValue.

Defined in GI.GtkSource.Objects.SearchSettings

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SearchSettings -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SearchSettings)

type ParentTypes SearchSettings

Defined in GI.GtkSource.Objects.SearchSettings

type ParentTypes SearchSettings = '[Object]

class (GObject o, IsDescendantOf SearchSettings o) => IsSearchSettings o

Type class for types which can be safely cast to SearchSettings, for instance with toSearchSettings.

Instances

(GObject o, IsDescendantOf SearchSettings o) => IsSearchSettings o

Defined in GI.GtkSource.Objects.SearchSettings

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

Cast to SearchSettings, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAtWordBoundaries, getCaseSensitive, getData, getProperty, getQdata, getRegexEnabled, getSearchText, getVisibleOnly, getWrapAround.

Setters

setAtWordBoundaries, setCaseSensitive, setData, setDataFull, setProperty, setRegexEnabled, setSearchText, setVisibleOnly, setWrapAround.

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.

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.

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.

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 [funcutilsEscapeSearchText] after this function.

getVisibleOnly

searchSettingsGetVisibleOnly

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> m Bool

Returns: whether to exclude invisible text from the search.

No description available in the introspection data.

Since: 5.12

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.

new

searchSettingsNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SearchSettings

Returns: a new search settings object.

Creates a new search settings object.

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.

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.

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 [propertysearchSettings:search-text] property contains the pattern of the regular expression.

classsearchContext

uses Regex when regex search is enabled. See the Regular expression syntax page in the GLib reference manual.

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 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 [funcutilsUnescapeSearchText] before this function.

setVisibleOnly

searchSettingsSetVisibleOnly

Arguments

:: (HasCallStack, MonadIO m, IsSearchSettings a)

=> a

settings: a SearchSettings.

-> Bool

visibleOnly: the setting.

-> m ()

Enables or disables whether to exclude invisible text from the search.

If enabled, only visible text will be searched. A search match may have invisible text interspersed.

Since: 5.12

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.

Properties

atWordBoundaries

If True, a search match must start and end a word. The match can span multiple words.

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

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

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

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.

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

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

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

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 [propertysearchSettings:search-text] as the pattern.

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

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

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

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, [propertysearchSettings:search-text] is the pattern.

clearSearchSettingsSearchText :: (MonadIO m, IsSearchSettings o) => o -> m ()

Set the value of the “search-text” property to Nothing. When overloading is enabled, this is equivalent to

clear #searchText

constructSearchSettingsSearchText :: (IsSearchSettings o, MonadIO m) => Text -> m (GValueConstruct o)

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)

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

Set the value of the “search-text” property. When overloading is enabled, this is equivalent to

set searchSettings [ #searchText := value ]

visibleOnly

Exclude invisible text from the search. A search match may have invisible text interspersed.

Since: 5.12

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

Construct a GValueConstruct with valid value for the “visible-only” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “visible-only” property. When overloading is enabled, this is equivalent to

get searchSettings #visibleOnly

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

Set the value of the “visible-only” property. When overloading is enabled, this is equivalent to

set searchSettings [ #visibleOnly := 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.

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

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

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

Set the value of the “wrap-around” property. When overloading is enabled, this is equivalent to

set searchSettings [ #wrapAround := value ]