gi-gtksource-3.0.13: GtkSource bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.GtkSource.Objects.SearchSettings

Contents

Description

 

Synopsis

Exported types

Methods

getAtWordBoundaries

searchSettingsGetAtWordBoundaries Source #

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

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

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

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

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

Arguments

:: (HasCallStack, MonadIO m) 
=> m SearchSettings

Returns: a new search settings object.

Creates a new search settings object.

Since: 3.10

setAtWordBoundaries

searchSettingsSetAtWordBoundaries Source #

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

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

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

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

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

data SearchSettingsAtWordBoundariesPropertyInfo Source #

Instances

AttrInfo SearchSettingsAtWordBoundariesPropertyInfo Source # 
type AttrOrigin SearchSettingsAtWordBoundariesPropertyInfo Source # 
type AttrLabel SearchSettingsAtWordBoundariesPropertyInfo Source # 
type AttrGetType SearchSettingsAtWordBoundariesPropertyInfo Source # 
type AttrBaseTypeConstraint SearchSettingsAtWordBoundariesPropertyInfo Source # 
type AttrSetTypeConstraint SearchSettingsAtWordBoundariesPropertyInfo Source # 
type AttrAllowedOps SearchSettingsAtWordBoundariesPropertyInfo Source # 

caseSensitive

data SearchSettingsCaseSensitivePropertyInfo Source #

Instances

AttrInfo SearchSettingsCaseSensitivePropertyInfo Source # 
type AttrOrigin SearchSettingsCaseSensitivePropertyInfo Source # 
type AttrLabel SearchSettingsCaseSensitivePropertyInfo Source # 
type AttrGetType SearchSettingsCaseSensitivePropertyInfo Source # 
type AttrBaseTypeConstraint SearchSettingsCaseSensitivePropertyInfo Source # 
type AttrSetTypeConstraint SearchSettingsCaseSensitivePropertyInfo Source # 
type AttrAllowedOps SearchSettingsCaseSensitivePropertyInfo Source # 

regexEnabled

data SearchSettingsRegexEnabledPropertyInfo Source #

Instances

AttrInfo SearchSettingsRegexEnabledPropertyInfo Source # 
type AttrOrigin SearchSettingsRegexEnabledPropertyInfo Source # 
type AttrLabel SearchSettingsRegexEnabledPropertyInfo Source # 
type AttrGetType SearchSettingsRegexEnabledPropertyInfo Source # 
type AttrBaseTypeConstraint SearchSettingsRegexEnabledPropertyInfo Source # 
type AttrSetTypeConstraint SearchSettingsRegexEnabledPropertyInfo Source # 
type AttrAllowedOps SearchSettingsRegexEnabledPropertyInfo Source # 

searchText

data SearchSettingsSearchTextPropertyInfo Source #

Instances

AttrInfo SearchSettingsSearchTextPropertyInfo Source # 
type AttrOrigin SearchSettingsSearchTextPropertyInfo Source # 
type AttrLabel SearchSettingsSearchTextPropertyInfo Source # 
type AttrGetType SearchSettingsSearchTextPropertyInfo Source # 
type AttrBaseTypeConstraint SearchSettingsSearchTextPropertyInfo Source # 
type AttrSetTypeConstraint SearchSettingsSearchTextPropertyInfo Source # 
type AttrAllowedOps SearchSettingsSearchTextPropertyInfo Source # 

wrapAround

data SearchSettingsWrapAroundPropertyInfo Source #

Instances

AttrInfo SearchSettingsWrapAroundPropertyInfo Source # 
type AttrOrigin SearchSettingsWrapAroundPropertyInfo Source # 
type AttrLabel SearchSettingsWrapAroundPropertyInfo Source # 
type AttrGetType SearchSettingsWrapAroundPropertyInfo Source # 
type AttrBaseTypeConstraint SearchSettingsWrapAroundPropertyInfo Source # 
type AttrSetTypeConstraint SearchSettingsWrapAroundPropertyInfo Source # 
type AttrAllowedOps SearchSettingsWrapAroundPropertyInfo Source #