Struct gtk4::TextTagTable

#[repr(transparent)]
pub struct TextTagTable { /* private fields */ }

The collection of tags in a TextBuffer

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.

GtkTextTagTables as GtkBuildable

The TextTagTable implementation of the Buildable interface supports adding tags by specifying “tag” as the “type” attribute of a <child> element.

An example of a UI definition fragment specifying tags:

<object class="GtkTextTagTable">
 <child type="tag">
   <object class="GtkTextTag"/>
 </child>
</object>

Signals

tag-added

Emitted every time a new tag is added in the TextTagTable.

tag-changed

Emitted every time a tag in the TextTagTable changes.

tag-removed

Emitted every time a tag is removed from the TextTagTable.

The @tag is still valid by the time the signal is emitted, but it is not associated with a tag table any more.

Implements

glib::ObjectExt, BuildableExt

Implementations

impl TextTagTable

pub fn new() -> TextTagTable

Creates a new TextTagTable.

The table contains no tags by default.

Returns

a new TextTagTable

pub fn add(&self, tag: &impl IsA<TextTag>) -> bool

Add a tag to the table.

The tag is assigned the highest priority in the table.

@tag must not be in a tag table already, and may not have the same name as an already-added tag.

tag

a TextTag

Returns

true on success.

pub fn foreach<P: FnMut(&TextTag)>(&self, func: P)

Calls @func on each tag in @self, with user data @data.

Note that the table may not be modified while iterating over it (you can’t add/remove tags).

func

a function to call on each tag

pub fn size(&self) -> i32

Returns the size of the table (number of tags)

Returns

number of tags in @self

pub fn lookup(&self, name: &str) -> Option<TextTag>

Look up a named tag.

name

name of a tag

Returns

The tag

pub fn remove(&self, tag: &impl IsA<TextTag>)

Remove a tag from the table.

If a TextBuffer has @self as its tag table, the tag is removed from the buffer. The table’s reference to the tag is removed, so the tag will end up destroyed if you don’t have a reference to it.

tag

a TextTag

pub fn connect_tag_added<F: Fn(&Self, &TextTag) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted every time a new tag is added in the TextTagTable.

tag

the added tag.

pub fn connect_tag_changed<F: Fn(&Self, &TextTag, bool) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted every time a tag in the TextTagTable changes.

tag

the changed tag.

size_changed

whether the change affects the TextView layout.

pub fn connect_tag_removed<F: Fn(&Self, &TextTag) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted every time a tag is removed from the TextTagTable.

The @tag is still valid by the time the signal is emitted, but it is not associated with a tag table any more.

tag

the removed tag.

Trait Implementations

impl Clone for TextTagTable

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 TextTagTable

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

Formats the value using the given formatter.

impl Default for TextTagTable

fn default() -> Self

Returns the “default value” for a type.

impl Display for TextTagTable

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

Formats the value using the given formatter.

impl HasParamSpec for TextTagTable

type ParamSpec = ParamSpecObject

type SetValue = TextTagTable

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TextTagTable

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 TextTagTable

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for TextTagTable

type Parent = Object

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

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 TextTagTable

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 TextTagTable

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TextTagTable

impl IsA<Buildable> for TextTagTable