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 gtksource.search_context.SearchContexts.

Methods
GType _getGType() static nothrow
GType _gType() @property nothrow
SearchSettings self() nothrowReturns `this`, for use in `with` statements.
SearchSettingsGidBuilder builder() static nothrowGet builder for [gtksource.search_settings.SearchSettings] Returns: New builder object
bool atWordBoundaries() @property nothrowGet `atWordBoundaries` property. Returns: If true, a search match must start and end a word. The match can span multiple words.
void atWordBoundaries(bool propval) @property nothrowSet `atWordBoundaries` property. Params: propval = If true, a search match must start and end a word. The match can span multiple words.
bool caseSensitive() @property nothrowGet `caseSensitive` property. Returns: Whether the search is case sensitive.
void caseSensitive(bool propval) @property nothrowSet `caseSensitive` property. Params: propval = Whether the search is case sensitive.
bool regexEnabled() @property nothrowGet `regexEnabled` property. Returns: Search by regular expressions with [gtksource.search_settings.SearchSettings.searchText] as the pattern.
void regexEnabled(bool propval) @property nothrowSet `regexEnabled` property. Params: propval = Search by regular expressions with [gtksource.search_settings.SearchSettings.searchText] as the pattern.
string searchText() @property nothrowGet `searchText` property. Returns: A search string, or null if the search is disabled.
void searchText(string propval) @property nothrowSet `searchText` property. Params: propval = A search string, or null if the search is disabled.
bool visibleOnly() @property nothrowGet `visibleOnly` property. Returns: Exclude invisible text from the search. A search match may have invisible text interspersed.
void visibleOnly(bool propval) @property nothrowSet `visibleOnly` property. Params: propval = Exclude invisible text from the search. A search match may have invisible text interspersed.
bool wrapAround() @property nothrowGet `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) @property nothrowSet `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() nothrow
bool getCaseSensitive() nothrow
bool getRegexEnabled() nothrow
string getSearchText() nothrowGets the text to search.
bool getVisibleOnly() nothrow
bool getWrapAround() nothrow
void setAtWordBoundaries(bool atWordBoundaries) nothrowChange whether the search is done at word boundaries.
void setCaseSensitive(bool caseSensitive) nothrowEnables or disables the case sensitivity for the search.
void setRegexEnabled(bool regexEnabled) nothrowEnables or disables whether to search by regular expressions.
void setSearchText(string searchText = null) nothrowSets the text to search.
void setVisibleOnly(bool visibleOnly) nothrowEnables or disables whether to exclude invisible text from the search.
void setWrapAround(bool wrapAround) nothrowEnables 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

Fluent builder implementation template for gtksource.search_settings.SearchSettings

Methods
T atWordBoundaries(bool propval) nothrowSet `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) nothrowSet `caseSensitive` property. Params: propval = Whether the search is case sensitive. Returns: Builder instance for fluent chaining
T regexEnabled(bool propval) nothrowSet `regexEnabled` property. Params: propval = Search by regular expressions with [gtksource.search_settings.SearchSettings.searchText] as the pattern. Returns: Builder instance for fluent chaining
T searchText(string propval) nothrowSet `searchText` property. Params: propval = A search string, or null if the search is disabled.
T visibleOnly(bool propval) nothrowSet `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) nothrowSet `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() nothrowCreate object from builder. Returns: New object