Class: GtkSource::SearchSettings

Inherits:

Object

• Object
• GtkSource::SearchSettings

Defined in:

(unknown)

Instance Method Summary

• #at_word_boundaries ⇒ Boolean

  Whether to search at word boundaries.

• #at_word_boundaries=(at_word_boundaries) ⇒ Boolean

  If true, a search match must start and end a word.

• #at_word_boundaries? ⇒ Boolean

  If true, a search match must start and end a word.

• #case_sensitive ⇒ Boolean

  Whether the search is case sensitive.

• #case_sensitive=(case_sensitive) ⇒ Boolean

  Whether the search is case sensitive.

• #case_sensitive? ⇒ Boolean

  Whether the search is case sensitive.

• #initialize ⇒ GtkSource::SearchSettings constructor

  Creates a new search settings object.

• #regex_enabled ⇒ Boolean

  Whether to search by regular expressions.

• #regex_enabled=(regex_enabled) ⇒ Boolean

  Search by regular expressions with [propertySearchSettings:search-text] as the pattern.

• #regex_enabled? ⇒ Boolean

  Search by regular expressions with [propertySearchSettings:search-text] as the pattern.

• #search_text ⇒ String

  A search string, or nil if the search is disabled.

• #search_text=(search_text) ⇒ String

  A search string, or nil if the search is disabled.

• #visible_only ⇒ Boolean

  Whether to exclude invisible text from the search.

• #visible_only=(visible_only) ⇒ Boolean

  Exclude invisible text from the search.

• #visible_only? ⇒ Boolean

  Exclude invisible text from the search.

• #wrap_around ⇒ Boolean

  Whether to wrap around the search.

• #wrap_around=(wrap_around) ⇒ Boolean

  For a forward search, continue at the beginning of the buffer if no search occurrence is found.

• #wrap_around? ⇒ Boolean

  For a forward search, continue at the beginning of the buffer if no search occurrence is found.

Constructor Details

#initialize ⇒ GtkSource::SearchSettings

Creates a new search settings object.

Instance Method Details

#at_word_boundaries ⇒ Boolean

Returns whether to search at word boundaries.

Returns:

• (Boolean) —

  whether to search at word boundaries.

#at_word_boundaries=(at_word_boundaries) ⇒ Boolean

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

Parameters:

• at_word_boundaries (Boolean)

Returns:

• (Boolean) —

  at-word-boundaries

• (Boolean) —

  at-word-boundaries

#at_word_boundaries? ⇒ Boolean

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

Returns:

• (Boolean) —

  at-word-boundaries

#case_sensitive ⇒ Boolean

Returns whether the search is case sensitive.

Returns:

• (Boolean) —

  whether the search is case sensitive.

#case_sensitive=(case_sensitive) ⇒ Boolean

Whether the search is case sensitive.

Parameters:

• case_sensitive (Boolean)

Returns:

• (Boolean) —

  case-sensitive

• (Boolean) —

  case-sensitive

#case_sensitive? ⇒ Boolean

Whether the search is case sensitive.

Returns:

• (Boolean) —

  case-sensitive

#regex_enabled ⇒ Boolean

Returns whether to search by regular expressions.

Returns:

• (Boolean) —

  whether to search by regular expressions.

#regex_enabled=(regex_enabled) ⇒ Boolean

Search by regular expressions with [propertySearchSettings:search-text] as the pattern.

Parameters:

• regex_enabled (Boolean)

Returns:

• (Boolean) —

  regex-enabled

• (Boolean) —

  regex-enabled

#regex_enabled? ⇒ Boolean

Search by regular expressions with [propertySearchSettings:search-text] as the pattern.

Returns:

• (Boolean) —

  regex-enabled

#search_text ⇒ String

A search string, or nil if the search is disabled.

If the regular expression search is enabled, [propertySearchSettings:search-text] is the pattern.

Returns:

• (String) —

  search-text

#search_text=(search_text) ⇒ String

A search string, or nil if the search is disabled.

If the regular expression search is enabled, [propertySearchSettings:search-text] is the pattern.

Parameters:

• search_text (String)

Returns:

• (String) —

  search-text

• (String) —

  search-text

#visible_only ⇒ Boolean

Returns whether to exclude invisible text from the search.

Returns:

• (Boolean) —

  whether to exclude invisible text from the search.

#visible_only=(visible_only) ⇒ Boolean

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

Parameters:

• visible_only (Boolean)

Returns:

• (Boolean) —

  visible-only

• (Boolean) —

  visible-only

#visible_only? ⇒ Boolean

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

Returns:

• (Boolean) —

  visible-only

#wrap_around ⇒ Boolean

Returns whether to wrap around the search.

Returns:

• (Boolean) —

  whether to wrap around the search.

#wrap_around=(wrap_around) ⇒ Boolean

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.

Parameters:

• wrap_around (Boolean)

Returns:

• (Boolean) —

  wrap-around

• (Boolean) —

  wrap-around

#wrap_around? ⇒ Boolean

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.

Returns:

• (Boolean) —

  wrap-around