gtksource.search_settings

Module for [SearchSettings] class

class SearchSettings SearchSettingsGidBuilder SearchSettingsGidBuilderImpl

Types 3

classSearchSettings : gobject.object.ObjectWrap

Search settings.

A [gtksource.search_settings.SearchSettings] object represents the settings of a search. The search settings can be associated with one or several class@SearchContexts.

Methods
GType _getGType()
GType _gType() @property
SearchSettings self()Returns `this`, for use in `with` statements.
SearchSettingsGidBuilder builder()Get builder for [gtksource.search_settings.SearchSettings] Returns: New builder object
bool atWordBoundaries() @propertyGet `atWordBoundaries` property. Returns: If true, a search match must start and end a word. The match can span multiple words.
void atWordBoundaries(bool propval) @propertySet `atWordBoundaries` property. Params: propval = If true, a search match must start and end a word. The match can span multiple words.
bool caseSensitive() @propertyGet `caseSensitive` property. Returns: Whether the search is case sensitive.
void caseSensitive(bool propval) @propertySet `caseSensitive` property. Params: propval = Whether the search is case sensitive.
bool regexEnabled() @propertyGet `regexEnabled` property. Returns: Search by regular expressions with `property@SearchSettings:search-text` as the pattern.
void regexEnabled(bool propval) @propertySet `regexEnabled` property. Params: propval = Search by regular expressions with `property@SearchSettings:search-text` as the pattern.
string searchText() @propertyGet `searchText` property. Returns: A search string, or null if the search is disabled.
void searchText(string propval) @propertySet `searchText` property. Params: propval = A search string, or null if the search is disabled.
bool visibleOnly() @propertyGet `visibleOnly` property. Returns: Exclude invisible text from the search. A search match may have invisible text interspersed.
void visibleOnly(bool propval) @propertySet `visibleOnly` property. Params: propval = Exclude invisible text from the search. A search match may have invisible text interspersed.
bool wrapAround() @propertyGet `wrapAround` property. Returns: 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.
void wrapAround(bool propval) @propertySet `wrapAround` property. Params: propval = 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.
bool getAtWordBoundaries()
bool getCaseSensitive()
bool getRegexEnabled()
string getSearchText()Gets the text to search.
bool getVisibleOnly()
bool getWrapAround()
void setAtWordBoundaries(bool atWordBoundaries)Change whether the search is done at word boundaries.
void setCaseSensitive(bool caseSensitive)Enables or disables the case sensitivity for the search.
void setRegexEnabled(bool regexEnabled)Enables or disables whether to search by regular expressions.
void setSearchText(string searchText = null)Sets the text to search.
void setVisibleOnly(bool visibleOnly)Enables or disables whether to exclude invisible text from the search.
void setWrapAround(bool wrapAround)Enables or disables the wrap around search.
Constructors
this(void * ptr, Flag!"Take" take)
this()Creates a new search settings object. Returns: a new search settings object.
classSearchSettingsGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T
Methods
T atWordBoundaries(bool propval)Set `atWordBoundaries` property. Params: propval = If true, a search match must start and end a word. The match can span multiple words. Returns: Builder instance for fluent chaining
T caseSensitive(bool propval)Set `caseSensitive` property. Params: propval = Whether the search is case sensitive. Returns: Builder instance for fluent chaining
T regexEnabled(bool propval)Set `regexEnabled` property. Params: propval = Search by regular expressions with `property@SearchSettings:search-text` as the pattern. Returns: Builder instance for fluent chaining
T searchText(string propval)Set `searchText` property. Params: propval = A search string, or null if the search is disabled.
T visibleOnly(bool propval)Set `visibleOnly` property. Params: propval = Exclude invisible text from the search. A search match may have invisible text interspersed. Returns: Builder instance for fluent chaining
T wrapAround(bool propval)Set `wrapAround` property. Params: propval = 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...
classSearchSettingsGidBuilder : SearchSettingsGidBuilderImpl!SearchSettingsGidBuilder

Fluent builder for [gtksource.search_settings.SearchSettings]

Methods
SearchSettings build()