Trait sourceview5::prelude::SearchSettingsExt

pub trait SearchSettingsExt: IsA<SearchSettings> + Sealed + 'static {
    // Provided methods
    fn is_at_word_boundaries(&self) -> bool { ... }
    fn is_case_sensitive(&self) -> bool { ... }
    fn is_regex_enabled(&self) -> bool { ... }
    fn search_text(&self) -> Option<GString> { ... }
    fn is_visible_only(&self) -> bool { ... }
    fn wraps_around(&self) -> bool { ... }
    fn set_at_word_boundaries(&self, at_word_boundaries: bool) { ... }
    fn set_case_sensitive(&self, case_sensitive: bool) { ... }
    fn set_regex_enabled(&self, regex_enabled: bool) { ... }
    fn set_search_text(&self, search_text: Option<&str>) { ... }
    fn set_visible_only(&self, visible_only: bool) { ... }
    fn set_wrap_around(&self, wrap_around: bool) { ... }
    fn connect_at_word_boundaries_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_case_sensitive_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_regex_enabled_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_search_text_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_visible_only_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_wrap_around_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
}

Trait containing all SearchSettings methods.

Implementors

SearchSettings

Provided Methods

fn is_at_word_boundaries(&self) -> bool

Returns

whether to search at word boundaries.

fn is_case_sensitive(&self) -> bool

Returns

whether the search is case sensitive.

fn is_regex_enabled(&self) -> bool

Returns

whether to search by regular expressions.

fn search_text(&self) -> Option<GString>

Gets the text to search.

The return value must not be freed.

You may be interested to call utils_escape_search_text() after this function.

Returns

the text to search, or None if the search is disabled.

fn is_visible_only(&self) -> bool

Returns

whether to exclude invisible text from the search.

fn wraps_around(&self) -> bool

Returns

whether to wrap around the search.

fn set_at_word_boundaries(&self, at_word_boundaries: bool)

Change whether the search is done at word boundaries.

If @at_word_boundaries is true, a search match must start and end a word. The match can span multiple words. See also gtk::TextIter::starts_word() and gtk::TextIter::ends_word().

at_word_boundaries

the setting.

fn set_case_sensitive(&self, case_sensitive: bool)

Enables or disables the case sensitivity for the search.

case_sensitive

the setting.

fn set_regex_enabled(&self, regex_enabled: bool)

Enables or disables whether to search by regular expressions.

If enabled, the search-text property contains the pattern of the regular expression.

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

regex_enabled

the setting.

fn set_search_text(&self, search_text: Option<&str>)

Sets the text to search.

If @search_text is None or is empty, the search will be disabled. A copy of @search_text will be made, so you can safely free @search_text after a call to this function.

You may be interested to call utils_unescape_search_text() before this function.

search_text

the nul-terminated text to search, or None to disable the search.

fn set_visible_only(&self, visible_only: bool)

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.

visible_only

the setting.

fn set_wrap_around(&self, wrap_around: bool)

Enables or disables the wrap around search.

If @wrap_around 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.

wrap_around

the setting.

fn connect_at_word_boundaries_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_case_sensitive_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_regex_enabled_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_search_text_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_visible_only_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

fn connect_wrap_around_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Object Safety

This trait is not object safe.

Implementors

impl<O: IsA<SearchSettings>> SearchSettingsExt for O