Struct gtk4::TextBuffer

pub struct TextBuffer { /* private fields */ }

Stores text and attributes for display in a TextView.

You may wish to begin by reading the text widget conceptual overview, which gives an overview of all the objects and data types related to the text widget and how they work together.

GtkTextBuffer can support undoing changes to the buffer content, see TextBufferExt::set_enable_undo().

Properties

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 TextBufferExt::text() for more information.

Readable | Writeable

Signals

apply-tag

Emitted to apply a tag to a range of text in a 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: TextBufferExt::apply_tag(), TextBufferExtManual::insert_with_tags(), TextBufferExt::insert_range().

begin-user-action

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

See also: TextBufferExt::begin_user_action(), TextBufferExt::insert_interactive(), TextBufferExt::insert_range_interactive(), TextBufferExt::delete_interactive(), TextBufferExt::backspace(), TextBufferExt::delete_selection().

changed

Emitted when the content of a TextBuffer has changed.

delete-range

Emitted to delete a range from a 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: TextBufferExt::delete().

end-user-action

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

See also: TextBufferExt::end_user_action(), TextBufferExt::insert_interactive(), TextBufferExt::insert_range_interactive(), TextBufferExt::delete_interactive(), TextBufferExt::backspace(), TextBufferExt::delete_selection(), TextBufferExt::backspace().

insert-child-anchor

Emitted to insert a TextChildAnchor in a 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: TextBufferExt::insert_child_anchor().

insert-paintable

Emitted to insert a gdk::Paintable in a 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: TextBufferExt::insert_paintable().

insert-text

Emitted to insert text in a 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: TextBufferExt::insert(), TextBufferExt::insert_range().

mark-deleted

Emitted as notification after a TextMark is deleted.

See also: TextBufferExt::delete_mark().

mark-set

Emitted as notification after a TextMark is set.

See also: TextBufferExt::create_mark(), TextBufferExt::move_mark().

modified-changed

Emitted when the modified bit of a TextBuffer flips.

See also: TextBufferExt::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 TextBufferExt::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 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: TextBufferExt::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

TextBufferExt, [trait@glib::ObjectExt], TextBufferExtManual

Implementations

impl TextBuffer

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

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

Creates a new text buffer.

table

a tag table, or None to create a new one

Returns

a new text buffer

pub fn builder() -> TextBufferBuilder

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

This method returns an instance of TextBufferBuilder which can be used to create TextBuffer objects.

Trait Implementations

impl Clone for TextBuffer

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 TextBuffer

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

Formats the value using the given formatter.

impl Default for TextBuffer

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for TextBuffer

type ParamSpec = ParamSpecObject

type SetValue = TextBuffer

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TextBuffer

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<T: TextBufferImpl> IsSubclassable<T> for TextBuffer

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 TextBuffer

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 TextBuffer

type Parent = Object

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

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 TextBuffer

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 TextBuffer

fn static_type() -> Type

Returns the type identifier of Self.

impl Write for TextBuffer

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl Eq for TextBuffer