Struct sourceview4::SearchContext

pub struct SearchContext { /* private fields */ }

Properties

buffer

The Buffer associated to the search context.

Readable | Writeable | Construct Only

highlight

Highlight the search occurrences.

Readable | Writeable | Construct

match-style

A Style, or None for theme’s scheme default style.

Readable | Writeable | Construct

occurrences-count

The total number of search occurrences. If the search is disabled, the value is 0. If the buffer is not already fully scanned, the value is -1.

Readable

regex-error

If the regex search pattern doesn’t follow all the rules, this glib::Error property will be set. If the pattern is valid, the value is None.

Free with g_error_free().

Readable

settings

The SearchSettings associated to the search context.

This property is construct-only since version 4.0.

Readable | Writeable | Construct Only

Implements

SearchContextExt, SearchContextExtManual

Implementations

impl SearchContext

pub const NONE: Option<&'static SearchContext> = None

pub fn new( buffer: &impl IsA<Buffer>, settings: Option<&impl IsA<SearchSettings>> ) -> SearchContext

Creates a new search context, associated with buffer, and customized with settings. If settings is None, a new SearchSettings object will be created, that you can retrieve with SearchContextExt::settings().

buffer

a Buffer.

settings

a SearchSettings, or None.

Returns

a new search context.

pub fn builder() -> SearchContextBuilder

Creates a new builder-pattern struct instance to construct SearchContext objects.

This method returns an instance of SearchContextBuilder which can be used to create SearchContext objects.

Trait Implementations

impl Clone for SearchContext

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchContext

fn default() -> Self

Returns the “default value” for a type.

impl Display for SearchContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for SearchContext

type ParamSpec = ParamSpecObject

type SetValue = SearchContext

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, SearchContext>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SearchContext

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SearchContext

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for SearchContext

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for SearchContext

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SearchContext

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SearchContext

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SearchContext