SourceRegion

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_source_region_get_type ()" ) ]
[ GIR ( name = "Region" ) ]
public class SourceRegion : Object

Region utility.

A `GtkSourceRegion` permits to store a group of subregions of a [class@Gtk.TextBuffer]. `GtkSourceRegion` stores the subregions with pairs of [class@Gtk.TextMark]'s, so the region is still valid after insertions and deletions in the [class@Gtk.TextBuffer].

The [class@Gtk.TextMark] for the start of a subregion has a left gravity, while the [class@Gtk.TextMark] for the end of a subregion has a right gravity.

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

To iterate through the subregions, you need to use a [struct@RegionIter], for example: ```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); } ``` ```python buffer: GtkSource.Buffer = GtkSource.Buffer() region: GtkSource.Region = GtkSource.Region(buffer=buffer) region_iter = region.get_start_region_iter()

while not region_iter.is_end(): success, start, end = region_iter.get_subregion() if not success: break

Do something useful with the subregion

region_iter.next() ```

Namespace: Gtk

Package: gtksourceview-3.0

Content:

Properties:

public TextBuffer buffer { get; construct; }
The [class@Gtk.

Creation methods:

public SourceRegion (TextBuffer buffer)

Methods:

public void add_region (SourceRegion? region_to_add)
Adds region_to_add to this .
public void add_subregion (TextIter _start, TextIter _end)
Adds the subregion delimited by @_start and @_end to this.
public bool get_bounds (out TextIter start, out TextIter end)
Gets the start and end bounds of the this.
public unowned TextBuffer? get_buffer ()
public SourceRegionIter get_start_region_iter ()
Initializes a [struct@RegionIter] to the first subregion of this.
public SourceRegion? intersect_region (SourceRegion? region2)
Returns the intersection between this and region2.
public SourceRegion? intersect_subregion (TextIter _start, TextIter _end)
Returns the intersection between this and the subregion delimited by @_start and @_end.
public bool is_empty ()
Returns whether the this is empty.
public void subtract_region (SourceRegion? region_to_subtract)
Subtracts region_to_subtract from this.
public void subtract_subregion (TextIter _start, TextIter _end)
Subtracts the subregion delimited by @_start and @_end from this.
public string? to_string ()
Gets a string represention of this, for debugging purposes.

Inherited Members:

All known members inherited from class GLib.Object