Gtk.TextTag – gtk4 – Vala Binding Reference

Description:

[ CCode ( type_id = "gtk_text_tag_get_type ()" ) ]
public class TextTag : Object

A tag that can be applied to text contained in a `GtkTextBuffer`.

You may wish to begin by reading the [text widget conceptual overview](section-text-widget.html), 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 [[email protected]] for a given `GtkTextBuffer` before using them with that buffer.

[[email protected]_tag] is the best way to create tags. See “gtk4-demo” for numerous examples.

For each property of `GtkTextTag`, 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.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public bool accumulative_margin { get; set; }

Whether the margins accumulate or override each other.

public bool allow_breaks { get; set; }

Whether breaks are allowed.

public bool allow_breaks_set { get; set; }

public string background { set; }

Background color as a string.

public bool background_full_height { get; set; }

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

public bool background_full_height_set { get; set; }

public RGBA background_rgba { owned get; set; }

Background color as a `GdkRGBA`.

public bool background_set { get; set; }

public TextDirection direction { get; set; }

Text direction, e.

public bool editable { get; set; }

Whether the text can be modified by the user.

public bool editable_set { get; set; }

public bool fallback { get; set; }

Whether font fallback is enabled.

public bool fallback_set { get; set; }

public string family { owned get; set; }

Name of the font family, e.

public bool family_set { get; set; }

public string font { owned get; set; }

Font description as string, e.

public FontDescription font_desc { owned get; set; }

Font description as a `PangoFontDescription`.

public string font_features { owned get; set; }

OpenType font features, as a string.

public bool font_features_set { get; set; }

public string foreground { set; }

Foreground color as a string.

public RGBA foreground_rgba { owned get; set; }

Foreground color as a `GdkRGBA`.

public bool foreground_set { get; set; }

public int indent { get; set; }

Amount to indent the paragraph, in pixels.

public bool indent_set { get; set; }

public bool insert_hyphens { get; set; }

Whether to insert hyphens at breaks.

public bool insert_hyphens_set { get; set; }

public bool invisible { get; set; }

Whether this text is hidden.

public bool invisible_set { get; set; }

public Justification justification { get; set; }

Left, right, or center justification.

public bool justification_set { get; set; }

public string language { owned get; set; }

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

public bool language_set { get; set; }

public int left_margin { get; set; }

Width of the left margin in pixels.

public bool left_margin_set { get; set; }

public int letter_spacing { get; set; }

Extra spacing between graphemes, in Pango units.

public bool letter_spacing_set { get; set; }

public float line_height { get; set; }

Factor to scale line height by.

public bool line_height_set { get; set; }

public string name { owned get; construct; }

The name used to refer to the tag.

public Overline overline { get; set; }

Style of overline for this text.

public RGBA overline_rgba { owned get; set; }

This property modifies the color of overlines.

public bool overline_rgba_set { get; set; }

public bool overline_set { get; set; }

public string paragraph_background { set; }

The paragraph background color as a string.

public RGBA paragraph_background_rgba { owned get; set; }

The paragraph background color as a `GdkRGBA`.

public bool paragraph_background_set { get; set; }

public int pixels_above_lines { get; set; }

Pixels of blank space above paragraphs.

public bool pixels_above_lines_set { get; set; }

public int pixels_below_lines { get; set; }

Pixels of blank space below paragraphs.

public bool pixels_below_lines_set { get; set; }

public int pixels_inside_wrap { get; set; }

Pixels of blank space between wrapped lines in a paragraph.

public bool pixels_inside_wrap_set { get; set; }

public int right_margin { get; set; }

Width of the right margin, in pixels.

public bool right_margin_set { get; set; }

public int rise { get; set; }

Offset of text above the baseline, in Pango units.

public bool rise_set { get; set; }

public double scale { get; set; }

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

public bool scale_set { get; set; }

public bool sentence { get; set; }

Whether this tag represents a single sentence.

public bool sentence_set { get; set; }

public ShowFlags show_spaces { get; set; }

How to render invisible characters.

public bool show_spaces_set { get; set; }

public int size { get; set; }

Font size in Pango units.

public double size_points { get; set; }

Font size in points.

public bool size_set { get; set; }

public Stretch stretch { get; set; }

Font stretch as a `PangoStretch`, e.

public bool stretch_set { get; set; }

public bool strikethrough { get; set; }

Whether to strike through the text.

public RGBA strikethrough_rgba { owned get; set; }

This property modifies the color of strikeouts.

public bool strikethrough_rgba_set { get; set; }

If the `strikethrough-rgba` property has been set.

public bool strikethrough_set { get; set; }

public Style style { get; set; }

Font style as a `PangoStyle`, e.

public bool style_set { get; set; }

public TabArray tabs { owned get; set; }

Custom tabs for this text.

public bool tabs_set { get; set; }

public TextTransform text_transform { get; set; }

How to transform the text for display.

public bool text_transform_set { get; set; }

public Underline underline { get; set; }

Style of underline for this text.

public RGBA underline_rgba { owned get; set; }

This property modifies the color of underlines.

public bool underline_rgba_set { get; set; }

If the `underline-rgba` property has been set.

public bool underline_set { get; set; }

public Variant variant { get; set; }

Font variant as a `PangoVariant`, e.

public bool variant_set { get; set; }

public int weight { get; set; }

Font weight as an integer.

public bool weight_set { get; set; }

public bool word { get; set; }

Whether this tag represents a single word.

public bool word_set { get; set; }

public WrapMode wrap_mode { get; set; }

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

public bool wrap_mode_set { get; set; }

Creation methods:

public TextTag (string? name = null)

Creates a `GtkTextTag`.

Methods:

public void changed (bool size_changed)

Emits the [signal@Gtk.

public int get_priority ()

Get the tag priority.

public void set_priority (int priority)

Sets the priority of a `GtkTextTag`.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref