Struct gtk4::TextTag

source ·

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

Expand description

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

`background-full-height`

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

Readable | Writeable

`background-rgba`

Background color as a gdk::RGBA.

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

`fallback`

Whether font fallback is enabled.

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

Readable | Writeable

`family`

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

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

`foreground-rgba`

Foreground color as a gdk::RGBA.

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

`insert-hyphens`

Whether to insert hyphens at breaks.

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

`justification`

Left, right, or center justification.

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

`left-margin`

Width of the left margin in pixels.

Readable | Writeable

`letter-spacing`

Extra spacing between graphemes, in Pango units.

Readable | Writeable

`line-height`

Factor to scale line height by.

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

`paragraph-background`

The paragraph background color as a string.

Writeable

`paragraph-background-rgba`

The paragraph background color as a gdk::RGBA.

Readable | Writeable

`pixels-above-lines`

Pixels of blank space above paragraphs.

Readable | Writeable

`pixels-below-lines`

Pixels of blank space below paragraphs.

Readable | Writeable

`pixels-inside-wrap`

Pixels of blank space between wrapped lines in a paragraph.

Readable | Writeable

`right-margin`

Width of the right margin, in pixels.

Readable | Writeable

`rise`

Offset of text above the baseline, in Pango units.

Negative values go below the baseline.

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

`sentence`

Whether this tag represents a single sentence.

This affects cursor movement.

Readable | Writeable

`show-spaces`

How to render invisible characters.

Readable | Writeable

`size`

Font size in Pango units.

Readable | Writeable

`size-points`

Font size in points.

Readable | Writeable

`stretch`

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

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

`style`

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

Readable | Writeable

`tabs`

Custom tabs for this text.

Readable | Writeable

`text-transform`

How to transform the text for display.

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

`variant`

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

Readable | Writeable

`weight`

Font weight as an integer.

Readable | Writeable

`word`

Whether this tag represents a single word.

This affects line breaks and cursor movement.

Readable | Writeable

`wrap-mode`

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

Readable | Writeable

Struct gtk4::TextTag

Implementations§

impl TextTag

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

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

pub fn builder() -> TextTagBuilder

Trait Implementations§

impl Clone for TextTag

fn clone(&self) -> Self

fn clone_from(&mut self, source: &Self)

impl Debug for TextTag

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

impl Default for TextTag

fn default() -> Self

impl Display for TextTag

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

impl HasParamSpec for TextTag

type ParamSpec = ParamSpecObject

type SetValue = TextTag

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,

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl Ord for TextTag

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

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

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

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

impl ParentClassIs for TextTag

type Parent = Object

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

fn eq(&self, other: &OT) -> bool

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

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

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

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

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

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

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

impl StaticType for TextTag

fn static_type() -> Type

impl Eq for TextTag

Auto Trait Implementations§

impl RefUnwindSafe for TextTag

impl !Send for TextTag

impl !Sync for TextTag

impl Unpin for TextTag

impl UnwindSafe for TextTag

Blanket Implementations§