Struct sourceview5::Region

pub struct Region { /* private fields */ }

Region utility.

A Region permits to store a group of subregions of a gtk::TextBuffer. Region stores the subregions with pairs of gtk::TextMark’s, so the region is still valid after insertions and deletions in the gtk::TextBuffer.

The gtk::TextMark for the start of a subregion has a left gravity, while the gtk::TextMark for the end of a subregion has a right gravity.

The typical use-case of Region is to scan a gtk::TextBuffer chunk by chunk, not the whole buffer at once to not block the user interface. The Region represents in that case the remaining region to scan. You can listen to the insert-text and delete-range signals to update the Region accordingly.

To iterate through the subregions, you need to use a RegionIter, for example: ⚠️ The following code is in c ⚠️

GtkSourceRegion *region;
GtkSourceRegionIter region_iter;

gtk_source_region_get_start_region_iter (region, &region_iter);

while (!gtk_source_region_iter_is_end (&region_iter))
{
        GtkTextIter subregion_start;
        GtkTextIter subregion_end;

        if (!gtk_source_region_iter_get_subregion (&region_iter,
                                                   &subregion_start,
                                                   &subregion_end))
        {
                break;
        }

        // Do something useful with the subregion.

        gtk_source_region_iter_next (&region_iter);
}

Properties

buffer

The gtk::TextBuffer. The #GtkSourceRegion has a weak reference to the buffer.

Readable | Writeable | Construct Only

Implements

RegionExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Region

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

pub fn new(buffer: &impl IsA<TextBuffer>) -> Region

buffer

a #GtkTextBuffer.

Returns

a new #GtkSourceRegion object for @buffer.

pub fn builder() -> RegionBuilder

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

This method returns an instance of RegionBuilder which can be used to create Region objects.

Trait Implementations

impl Clone for Region

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl Default for Region

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Region

type ParamSpec = ParamSpecObject

type SetValue = Region

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Region

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

where H: Hasher,

Hashes the memory address of this object.

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 Region

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 Region

type Parent = Object

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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 Region

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 Region

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Region