Struct TextTag

pub struct TextTag { /* private fields */ }

A tag that can be applied to text contained 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.

Tags should be in the TextTagTable for a given TextBuffer before using them with that buffer.

TextBufferExtManual::create_tag() is the best way to create tags. See “gtk4-demo” for numerous examples.

For each property of TextTag, there is a “set” property, e.g. “font-set” corresponds to “font”. These “set” properties reflect whether a property has been set or not.

They are maintained by GTK and you should not set them independently.

Properties

accumulative-margin

Whether the margins accumulate or override each other.

When set to true the margins of this tag are added to the margins of any other non-accumulative margins present. When set to false the margins override one another (the default).

Readable | Writeable

allow-breaks

Whether breaks are allowed.

Readable | Writeable

allow-breaks-set

Whether the allow-breaks property is set.

Readable | Writeable

background

Background color as a string.

Writeable

background-full-height

Whether the background color fills the entire line height or only the height of the tagged characters.

Readable | Writeable

background-full-height-set

Whether the background-full-height property is set.

Readable | Writeable

background-rgba

Background color as a gdk::RGBA.

Readable | Writeable

background-set

Whether the background property is set.

Readable | Writeable

direction

Text direction, e.g. right-to-left or left-to-right.

Readable | Writeable

editable

Whether the text can be modified by the user.

Readable | Writeable

editable-set

Whether the editable property is set.

Readable | Writeable

fallback

Whether font fallback is enabled.

When set to true, other fonts will be substituted where the current font is missing glyphs.

Readable | Writeable

fallback-set

Whether the fallback property is set.

Readable | Writeable

family

Name of the font family, e.g. Sans, Helvetica, Times, Monospace.

Readable | Writeable

family-set

Whether the family property is set.

Readable | Writeable

font

Font description as string, e.g. "Sans Italic 12".

Note that the initial value of this property depends on the internals of pango::FontDescription.

Readable | Writeable

font-desc

Font description as a pango::FontDescription.

Readable | Writeable

font-features

OpenType font features, as a string.

Readable | Writeable

font-features-set

Whether the font-features property is set.

Readable | Writeable

foreground

Foreground color as a string.

Writeable

foreground-rgba

Foreground color as a gdk::RGBA.

Readable | Writeable

foreground-set

Whether the foreground property is set.

Readable | Writeable

indent

Amount to indent the paragraph, in pixels.

A negative value of indent will produce a hanging indentation. That is, the first line will have the full width, and subsequent lines will be indented by the absolute value of indent.

Readable | Writeable

indent-set

Whether the indent property is set.

Readable | Writeable

insert-hyphens

Whether to insert hyphens at breaks.

Readable | Writeable

insert-hyphens-set

Whether the insert-hyphens property is set.

Readable | Writeable

invisible

Whether this text is hidden.

Note that there may still be problems with the support for invisible text, in particular when navigating programmatically inside a buffer containing invisible segments.

Readable | Writeable

invisible-set

Whether the invisible property is set.

Readable | Writeable

justification

Left, right, or center justification.

Readable | Writeable

justification-set

Whether the justification property is set.

Readable | Writeable

language

The language this text is in, as an ISO code.

Pango can use this as a hint when rendering the text. If not set, an appropriate default will be used.

Note that the initial value of this property depends on the current locale, see also default_language().

Readable | Writeable

language-set

Whether the language property is set.

Readable | Writeable

left-margin

Width of the left margin in pixels.

Readable | Writeable

left-margin-set

Whether the left-margin property is set.

Readable | Writeable

letter-spacing

Extra spacing between graphemes, in Pango units.

Readable | Writeable

letter-spacing-set

Whether the letter-spacing property is set.

Readable | Writeable

line-height

Factor to scale line height by.

Readable | Writeable

line-height-set

Whether the line-height property is set.

Readable | Writeable

name

The name used to refer to the tag.

None for anonymous tags.

Readable | Writeable | Construct Only

overline

Style of overline for this text.

Readable | Writeable

overline-rgba

This property modifies the color of overlines.

If not set, overlines will use the foreground color.

Readable | Writeable

overline-rgba-set

Whether the overline-rgba property is set.

Readable | Writeable

overline-set

Whether the overline property is set.

Readable | Writeable

paragraph-background

The paragraph background color as a string.

Writeable

paragraph-background-rgba

The paragraph background color as a gdk::RGBA.

Readable | Writeable

paragraph-background-set

Whether the paragraph-background property is set.

Readable | Writeable

pixels-above-lines

Pixels of blank space above paragraphs.

Readable | Writeable

pixels-above-lines-set

Whether the pixels-above-lines property is set.

Readable | Writeable

pixels-below-lines

Pixels of blank space below paragraphs.

Readable | Writeable

pixels-below-lines-set

Whether the pixels-below-lines property is set.

Readable | Writeable

pixels-inside-wrap

Pixels of blank space between wrapped lines in a paragraph.

Readable | Writeable

pixels-inside-wrap-set

Whether the pixels-inside-wrap property is set.

Readable | Writeable

right-margin

Width of the right margin, in pixels.

Readable | Writeable

right-margin-set

Whether the right-margin property is set.

Readable | Writeable

rise

Offset of text above the baseline, in Pango units.

Negative values go below the baseline.

Readable | Writeable

rise-set

Whether the rise property is set.

Readable | Writeable

scale

Font size as a scale factor relative to the default font size.

This properly adapts to theme changes, etc. so is recommended. Pango predefines some scales such as PANGO_SCALE_X_LARGE.

Readable | Writeable

scale-set

Whether the scale property is set.

Readable | Writeable

sentence

Whether this tag represents a single sentence.

This affects cursor movement.

Readable | Writeable

sentence-set

Whether the sentence property is set.

Readable | Writeable

show-spaces

How to render invisible characters.

Readable | Writeable

show-spaces-set

Whether the show-spaces property is set.

Readable | Writeable

size

Font size in Pango units.

Readable | Writeable

size-points

Font size in points.

Readable | Writeable

size-set

Whether the size property is set.

Readable | Writeable

stretch

Font stretch as a pango::Stretch, e.g. pango::Stretch::Condensed.

Readable | Writeable

stretch-set

Whether the stretch property is set.

Readable | Writeable

strikethrough

Whether to strike through the text.

Readable | Writeable

strikethrough-rgba

This property modifies the color of strikeouts.

If not set, strikeouts will use the foreground color.

Readable | Writeable

strikethrough-rgba-set

If the strikethrough-rgba property has been set.

Readable | Writeable

strikethrough-set

Whether the strikethrough property is set.

Readable | Writeable

style

Font style as a pango::Style, e.g. pango::Style::Italic.

Readable | Writeable

style-set

Whether the style property is set.

Readable | Writeable

tabs

Custom tabs for this text.

Readable | Writeable

tabs-set

Whether the tabs property is set.

Readable | Writeable

text-transform

How to transform the text for display.

Readable | Writeable

text-transform-set

Whether the text-transform property is set.

Readable | Writeable

underline

Style of underline for this text.

Readable | Writeable

underline-rgba

This property modifies the color of underlines.

If not set, underlines will use the foreground color.

If underline is set to pango::Underline::Error, an alternate color may be applied instead of the foreground. Setting this property will always override those defaults.

Readable | Writeable

underline-rgba-set

If the underline-rgba property has been set.

Readable | Writeable

underline-set

Whether the underline property is set.

Readable | Writeable

variant

Font variant as a pango::Variant, e.g. pango::Variant::SmallCaps.

Readable | Writeable

variant-set

Whether the variant property is set.

Readable | Writeable

weight

Font weight as an integer.

Readable | Writeable

weight-set

Whether the weight property is set.

Readable | Writeable

word

Whether this tag represents a single word.

This affects line breaks and cursor movement.

Readable | Writeable

word-set

Whether the word property is set.

Readable | Writeable

wrap-mode

Whether to wrap lines never, at word boundaries, or at character boundaries.

Readable | Writeable

wrap-mode-set

Whether the wrap-mode property is set.

Readable | Writeable

Implements

TextTagExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl TextTag

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

pub fn new(name: Option<&str>) -> TextTag

Creates a TextTag.

name

tag name

Returns

a new TextTag

pub fn builder() -> TextTagBuilder

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

This method returns an instance of TextTagBuilder which can be used to create TextTag objects.

Trait Implementations

impl Clone for TextTag

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 TextTag

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

Formats the value using the given formatter.

impl Default for TextTag

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for TextTag

type ParamSpec = ParamSpecObject

type SetValue = TextTag

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TextTag

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 TextTag

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,

Restrict a value to a certain interval.

impl ParentClassIs for TextTag

type Parent = Object

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

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for TextTag

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

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for TextTag

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TextTag