Struct sourceview5::Buffer

pub struct Buffer { /* private fields */ }

Subclass of gtk::TextBuffer.

A Buffer object is the model for View widgets. It extends the gtk::TextBuffer class by adding features useful to display and edit source code such as syntax highlighting and bracket matching.

To create a Buffer use new() or with_language(). The second form is just a convenience function which allows you to initially set a Language. You can also directly create a View and get its Buffer with [TextViewExtManual::buffer()][crate::gtk::prelude::TextViewExtManual::buffer()].

The highlighting is enabled by default, but you can disable it with BufferExt::set_highlight_syntax().

Context Classes:

It is possible to retrieve some information from the syntax highlighting engine. The default context classes that are applied to regions of a Buffer:

• comment: the region delimits a comment;
• no-spell-check: the region should not be spell checked;
• path: the region delimits a path to a file;
• string: the region delimits a string.

Custom language definition files can create their own context classes, since the functions like BufferExt::iter_has_context_class() take a string parameter as the context class.

Buffer provides an API to access the context classes: BufferExt::iter_has_context_class(), BufferExt::context_classes_at_iter(), Buffer::iter_forward_to_context_class_toggle() and Buffer::iter_backward_to_context_class_toggle().

And the highlight-updated signal permits to be notified when a context class region changes.

Each context class has also an associated gtk::TextTag with the name gtksourceview:context-classes:<name>. For example to retrieve the gtk::TextTag for the string context class, one can write: ⚠️ The following code is in c ⚠️

GtkTextTagTable *tag_table;
GtkTextTag *tag;

tag_table = gtk_text_buffer_get_tag_table (buffer);
tag = gtk_text_tag_table_lookup (tag_table, "gtksourceview:context-classes:string");

The tag must be used for read-only purposes.

Accessing a context class via the associated gtk::TextTag is less convenient than the Buffer API, because:

• The tag doesn’t always exist, you need to listen to the tag-added and tag-removed signals.
• Instead of the highlight-updated signal, you can listen to the apply-tag and remove-tag signals.

A possible use-case for accessing a context class via the associated gtk::TextTag is to read the region but without adding a hard dependency on the GtkSourceView library (for example for a spell-checking library that wants to read the no-spell-check region).

Properties

highlight-matching-brackets

Whether to highlight matching brackets in the buffer.

Readable | Writeable

highlight-syntax

Whether to highlight syntax in the buffer.

Readable | Writeable

implicit-trailing-newline

Whether the buffer has an implicit trailing newline. See BufferExt::set_implicit_trailing_newline().

Readable | Writeable | Construct

language

Readable | Writeable

loading

The “loading” property denotes that a FileLoader is currently loading the buffer.

Applications may want to use this setting to avoid doing work while the buffer is loading such as spellchecking.

Readable

style-scheme

Style scheme. It contains styles for syntax highlighting, optionally foreground, background, cursor color, current line color, and matching brackets style.

Readable | Writeable

TextBuffer

can-redo

Denotes that the buffer can reapply the last undone action.

Readable

can-undo

Denotes that the buffer can undo the last applied action.

Readable

cursor-position

The position of the insert mark.

This is an offset from the beginning of the buffer. It is useful for getting notified when the cursor moves.

Readable

enable-undo

Denotes if support for undoing and redoing changes to the buffer is allowed.

Readable | Writeable

has-selection

Whether the buffer has some text currently selected.

Readable

tag-table

The GtkTextTagTable for the buffer.

Readable | Writeable | Construct Only

text

The text content of the buffer.

Without child widgets and images, see [TextBufferExtManual::text()][crate::gtk::prelude::TextBufferExtManual::text()] for more information.

Readable | Writeable

Signals

bracket-matched

@iter is set to a valid iterator pointing to the matching bracket if @state is BracketMatchType::Found. Otherwise @iter is meaningless.

The signal is emitted only when the @state changes, typically when the cursor moves.

A use-case for this signal is to show messages in a Gtk::Statusbar.

cursor-moved

The “cursor-moved” signal is emitted when then insertion mark has moved.

highlight-updated

The ::highlight-updated signal is emitted when the syntax highlighting and context classes are updated in a certain region of the @buffer.

source-mark-updated

The ::source-mark-updated signal is emitted each time a mark is added to, moved or removed from the @buffer.

TextBuffer

apply-tag

Emitted to apply a tag to a range of text in a gtk::TextBuffer.

Applying actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the @start and @end iters (or has to revalidate them).

See also: [TextBufferExtManual::apply_tag()][crate::gtk::prelude::TextBufferExtManual::apply_tag()], TextBufferExtManual::insert_with_tags(), [TextBufferExtManual::insert_range()][crate::gtk::prelude::TextBufferExtManual::insert_range()].

begin-user-action

Emitted at the beginning of a single user-visible operation on a gtk::TextBuffer.

See also: [TextBufferExtManual::begin_user_action()][crate::gtk::prelude::TextBufferExtManual::begin_user_action()], [TextBufferExtManual::insert_interactive()][crate::gtk::prelude::TextBufferExtManual::insert_interactive()], [TextBufferExtManual::insert_range_interactive()][crate::gtk::prelude::TextBufferExtManual::insert_range_interactive()], [TextBufferExtManual::delete_interactive()][crate::gtk::prelude::TextBufferExtManual::delete_interactive()], [TextBufferExtManual::backspace()][crate::gtk::prelude::TextBufferExtManual::backspace()], [TextBufferExtManual::delete_selection()][crate::gtk::prelude::TextBufferExtManual::delete_selection()].

changed

Emitted when the content of a gtk::TextBuffer has changed.

delete-range

Emitted to delete a range from a gtk::TextBuffer.

Note that if your handler runs before the default handler it must not invalidate the @start and @end iters (or has to revalidate them). The default signal handler revalidates the @start and @end iters to both point to the location where text was deleted. Handlers which run after the default handler (see g_signal_connect_after()) do not have access to the deleted text.

See also: [TextBufferExtManual::delete()][crate::gtk::prelude::TextBufferExtManual::delete()].

end-user-action

Emitted at the end of a single user-visible operation on the gtk::TextBuffer.

See also: [TextBufferExtManual::end_user_action()][crate::gtk::prelude::TextBufferExtManual::end_user_action()], [TextBufferExtManual::insert_interactive()][crate::gtk::prelude::TextBufferExtManual::insert_interactive()], [TextBufferExtManual::insert_range_interactive()][crate::gtk::prelude::TextBufferExtManual::insert_range_interactive()], [TextBufferExtManual::delete_interactive()][crate::gtk::prelude::TextBufferExtManual::delete_interactive()], [TextBufferExtManual::backspace()][crate::gtk::prelude::TextBufferExtManual::backspace()], [TextBufferExtManual::delete_selection()][crate::gtk::prelude::TextBufferExtManual::delete_selection()], [TextBufferExtManual::backspace()][crate::gtk::prelude::TextBufferExtManual::backspace()].

insert-child-anchor

Emitted to insert a GtkTextChildAnchor in a gtk::TextBuffer.

Insertion actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the @location iter (or has to revalidate it). The default signal handler revalidates it to be placed after the inserted @anchor.

See also: [TextBufferExtManual::insert_child_anchor()][crate::gtk::prelude::TextBufferExtManual::insert_child_anchor()].

insert-paintable

Emitted to insert a [gdk::Paintable][crate::gdk::Paintable] in a gtk::TextBuffer.

Insertion actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the @location iter (or has to revalidate it). The default signal handler revalidates it to be placed after the inserted @paintable.

See also: [TextBufferExtManual::insert_paintable()][crate::gtk::prelude::TextBufferExtManual::insert_paintable()].

insert-text

Emitted to insert text in a gtk::TextBuffer.

Insertion actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the @location iter (or has to revalidate it). The default signal handler revalidates it to point to the end of the inserted text.

See also: [TextBufferExtManual::insert()][crate::gtk::prelude::TextBufferExtManual::insert()], [TextBufferExtManual::insert_range()][crate::gtk::prelude::TextBufferExtManual::insert_range()].

mark-deleted

Emitted as notification after a gtk::TextMark is deleted.

See also: [TextBufferExtManual::delete_mark()][crate::gtk::prelude::TextBufferExtManual::delete_mark()].

mark-set

Emitted as notification after a gtk::TextMark is set.

See also: [TextBufferExtManual::create_mark()][crate::gtk::prelude::TextBufferExtManual::create_mark()], [TextBufferExtManual::move_mark()][crate::gtk::prelude::TextBufferExtManual::move_mark()].

modified-changed

Emitted when the modified bit of a gtk::TextBuffer flips.

See also: [TextBufferExtManual::set_modified()][crate::gtk::prelude::TextBufferExtManual::set_modified()].

paste-done

Emitted after paste operation has been completed.

This is useful to properly scroll the view to the end of the pasted text. See [TextBufferExtManual::paste_clipboard()][crate::gtk::prelude::TextBufferExtManual::paste_clipboard()] for more details.

redo

Emitted when a request has been made to redo the previously undone operation.

remove-tag

Emitted to remove all occurrences of @tag from a range of text in a gtk::TextBuffer.

Removal actually occurs in the default handler.

Note that if your handler runs before the default handler it must not invalidate the @start and @end iters (or has to revalidate them).

See also: [TextBufferExtManual::remove_tag()][crate::gtk::prelude::TextBufferExtManual::remove_tag()].

undo

Emitted when a request has been made to undo the previous operation or set of operations that have been grouped together.

Implements

BufferExt, gtk::prelude::TextBufferExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Buffer

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

pub fn new(table: Option<&TextTagTable>) -> Buffer

Creates a new source buffer.

table

a #GtkTextTagTable, or None to create a new one.

Returns

a new source buffer.

pub fn with_language(language: &Language) -> Buffer

Creates a new source buffer using the highlighting patterns in language.

This is equivalent to creating a new source buffer with a new tag table and then calling BufferExt::set_language().

language

a #GtkSourceLanguage.

Returns

a new source buffer which will highlight text according to the highlighting patterns in language.

pub fn builder() -> BufferBuilder

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

This method returns an instance of BufferBuilder which can be used to create Buffer objects.

Trait Implementations

impl Clone for Buffer

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 Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Buffer

type ParamSpec = ParamSpecObject

type SetValue = Buffer

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Buffer

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<T: BufferImpl> IsSubclassable<T> for Buffer

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for Buffer

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 Buffer

type Parent = TextBuffer

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

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 Buffer

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 Buffer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Buffer

impl IsA<TextBuffer> for Buffer