Class

GtkTextTag

Description [src]

class Gtk.TextTag : GObject.Object {
  parent_instance: GObject,
  priv: GtkTextTagPrivate*
}

You may wish to begin by reading the [text widget conceptual overview][TextWidget] 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 GtkTextTagTable for a given GtkTextBuffer before using them with that buffer.

gtk_text_buffer_create_tag() is the best way to create tags. See “gtk3-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.

Hierarchy

hierarchy this GtkTextTag ancestor_0 GObject ancestor_0--this

Ancestors

Constructors

gtk_text_tag_new

Creates a GtkTextTag. Configure the tag using object arguments, i.e. using g_object_set().

Instance methods

gtk_text_tag_changed

Emits the GtkTextTagTable::tag-changed signal on the GtkTextTagTable where the tag is included.

Available since: 3.20

gtk_text_tag_event

Emits the “event” signal on the GtkTextTag.

gtk_text_tag_get_priority

Get the tag priority.

gtk_text_tag_set_priority

Sets the priority of a GtkTextTag. Valid priorities start at 0 and go to one less than gtk_text_tag_table_get_size(). Each tag in a table has a unique priority; setting the priority of one tag shifts the priorities of all the other tags in the table to maintain a unique priority for each tag. Higher priority tags “win” if two tags both set the same text attribute. When adding a tag to a tag table, it will be assigned the highest priority in the table by default; so normally the precedence of a set of tags is the order in which they were added to the table, or created with gtk_text_buffer_create_tag(), which adds the tag to the buffer’s table automatically.

Methods inherited from GObject (42)

Properties

Gtk.TextTag:accumulative-margin

Whether the margins accumulate or override each other.

Available since: 2.12

Gtk.TextTag:background
No description available.
Gtk.TextTag:background-full-height
No description available.
Gtk.TextTag:background-full-height-set
No description available.
Gtk.TextTag:background-gdk

Background color as a GdkColor.

Deprecated since: 3.4

Gtk.TextTag:background-rgba

Background color as a GdkRGBA.

Available since: 3.2

Gtk.TextTag:background-set
No description available.
Gtk.TextTag:direction
No description available.
Gtk.TextTag:editable
No description available.
Gtk.TextTag:editable-set
No description available.
Gtk.TextTag:fallback

Whether font fallback is enabled.

Available since: 3.16

Gtk.TextTag:fallback-set
No description available.
Gtk.TextTag:family
No description available.
Gtk.TextTag:family-set
No description available.
Gtk.TextTag:font

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

Gtk.TextTag:font-desc
No description available.
Gtk.TextTag:font-features

OpenType font features, as a string.

Available since: 3.18

Gtk.TextTag:font-features-set
No description available.
Gtk.TextTag:foreground
No description available.
Gtk.TextTag:foreground-gdk

Foreground color as a GdkColor.

Deprecated since: 3.4

Gtk.TextTag:foreground-rgba

Foreground color as a GdkRGBA.

Available since: 3.2

Gtk.TextTag:foreground-set
No description available.
Gtk.TextTag:indent
No description available.
Gtk.TextTag:indent-set
No description available.
Gtk.TextTag:invisible

Whether this text is hidden.

Available since: 2.8

Gtk.TextTag:invisible-set
No description available.
Gtk.TextTag:justification
No description available.
Gtk.TextTag:justification-set
No description available.
Gtk.TextTag: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.

Gtk.TextTag:language-set
No description available.
Gtk.TextTag:left-margin
No description available.
Gtk.TextTag:left-margin-set
No description available.
Gtk.TextTag:letter-spacing

Extra spacing between graphemes, in Pango units.

Available since: 3.16

Gtk.TextTag:letter-spacing-set
No description available.
Gtk.TextTag:name
No description available.
Gtk.TextTag:paragraph-background

The paragraph background color as a string.

Available since: 2.8

Gtk.TextTag:paragraph-background-gdk

The paragraph background color as a GdkColor.

Available since: 2.8

Deprecated since: 3.4

Gtk.TextTag:paragraph-background-rgba

The paragraph background color as a GdkRGBA.

Available since: 3.2

Gtk.TextTag:paragraph-background-set
No description available.
Gtk.TextTag:pixels-above-lines
No description available.
Gtk.TextTag:pixels-above-lines-set
No description available.
Gtk.TextTag:pixels-below-lines
No description available.
Gtk.TextTag:pixels-below-lines-set
No description available.
Gtk.TextTag:pixels-inside-wrap
No description available.
Gtk.TextTag:pixels-inside-wrap-set
No description available.
Gtk.TextTag:right-margin
No description available.
Gtk.TextTag:right-margin-set
No description available.
Gtk.TextTag:rise
No description available.
Gtk.TextTag:rise-set
No description available.
Gtk.TextTag:scale
No description available.
Gtk.TextTag:scale-set
No description available.
Gtk.TextTag:size
No description available.
Gtk.TextTag:size-points
No description available.
Gtk.TextTag:size-set
No description available.
Gtk.TextTag:stretch
No description available.
Gtk.TextTag:stretch-set
No description available.
Gtk.TextTag:strikethrough
No description available.
Gtk.TextTag:strikethrough-rgba

This property modifies the color of strikeouts. If not set, strikeouts will use the forground color.

Available since: 3.16

Gtk.TextTag:strikethrough-rgba-set

If the GtkTextTag:strikethrough-rgba property has been set.

Available since: 3.16

Gtk.TextTag:strikethrough-set
No description available.
Gtk.TextTag:style
No description available.
Gtk.TextTag:style-set
No description available.
Gtk.TextTag:tabs
No description available.
Gtk.TextTag:tabs-set
No description available.
Gtk.TextTag:underline
No description available.
Gtk.TextTag:underline-rgba

This property modifies the color of underlines. If not set, underlines will use the forground color.

Available since: 3.16

Gtk.TextTag:underline-rgba-set

If the GtkTextTag:underline-rgba property has been set.

Available since: 3.16

Gtk.TextTag:underline-set
No description available.
Gtk.TextTag:variant
No description available.
Gtk.TextTag:variant-set
No description available.
Gtk.TextTag:weight
No description available.
Gtk.TextTag:weight-set
No description available.
Gtk.TextTag:wrap-mode
No description available.
Gtk.TextTag:wrap-mode-set
No description available.

Signals

Gtk.TextTag::event

The ::event signal is emitted when an event occurs on a region of the buffer marked with this tag.

Signals inherited from GObject (1)

Class structure

struct GtkTextTagClass {
  GObjectClass parent_class;
  gboolean (* event) (
    GtkTextTag* tag,
    GObject* event_object,
    GdkEvent* event,
    const GtkTextIter* iter
  );
  void (* _gtk_reserved1) (
void
  );
  void (* _gtk_reserved2) (
void
  );
  void (* _gtk_reserved3) (
void
  );
  void (* _gtk_reserved4) (
void
  );
  
}
Class members
parent_class
GObjectClass
  No description available.
event
gboolean (* event) (
    GtkTextTag* tag,
    GObject* event_object,
    GdkEvent* event,
    const GtkTextIter* iter
  )
  No description available.
_gtk_reserved1
void (* _gtk_reserved1) (
void
  )
  No description available.
_gtk_reserved2
void (* _gtk_reserved2) (
void
  )
  No description available.
_gtk_reserved3
void (* _gtk_reserved3) (
void
  )
  No description available.
_gtk_reserved4
void (* _gtk_reserved4) (
void
  )
  No description available.

Virtual methods

Gtk.TextTagClass.event

Emits the “event” signal on the GtkTextTag.