Gjsify LogoGjsify Logo

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

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 [classGtk.TextTagTable] for a given GtkTextBuffer before using them with that buffer.

[methodGtk.TextBuffer.create_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.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

accumulative_margin: boolean

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).

allow_breaks: boolean

Whether breaks are allowed.

allow_breaks_set: boolean
background: string

Background color as a string.

background_full_height: boolean

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

background_full_height_set: boolean
background_rgba: Gdk.RGBA

Background color as a GdkRGBA.

background_set: boolean
direction: Gtk.TextDirection

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

editable: boolean

Whether the text can be modified by the user.

editable_set: boolean
fallback: boolean

Whether font fallback is enabled.

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

fallback_set: boolean
family: string

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

family_set: boolean
font: string

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

Note that the initial value of this property depends on the internals of PangoFontDescription.

font_desc: FontDescription

Font description as a PangoFontDescription.

font_features: string

OpenType font features, as a string.

font_features_set: boolean
foreground: string

Foreground color as a string.

foreground_rgba: Gdk.RGBA

Foreground color as a GdkRGBA.

foreground_set: boolean
g_type_instance: TypeInstance
indent: number

Amount to indent the paragraph, in pixels.

indent_set: boolean
insert_hyphens: boolean

Whether to insert hyphens at breaks.

insert_hyphens_set: boolean
invisible: boolean

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.

invisible_set: boolean
justification: Gtk.Justification

Left, right, or center justification.

justification_set: boolean
language: string

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 [funcGtk.get_default_language].

language_set: boolean
left_margin: number

Width of the left margin in pixels.

left_margin_set: boolean
letter_spacing: number

Extra spacing between graphemes, in Pango units.

letter_spacing_set: boolean
line_height: number
line_height_set: boolean
name: string

The name used to refer to the tag.

%NULL for anonymous tags.

overline: Overline

Style of overline for this text.

overline_rgba: Gdk.RGBA

This property modifies the color of overlines.

If not set, overlines will use the foreground color.

overline_rgba_set: boolean
overline_set: boolean
paragraph_background: string

The paragraph background color as a string.

paragraph_background_rgba: Gdk.RGBA

The paragraph background color as a GdkRGBA.

paragraph_background_set: boolean
parent_instance: GObject.Object
pixels_above_lines: number

Pixels of blank space above paragraphs.

pixels_above_lines_set: boolean
pixels_below_lines: number

Pixels of blank space below paragraphs.

pixels_below_lines_set: boolean
pixels_inside_wrap: number

Pixels of blank space between wrapped lines in a paragraph.

pixels_inside_wrap_set: boolean
right_margin: number

Width of the right margin, in pixels.

right_margin_set: boolean
rise: number

Offset of text above the baseline, in Pango units.

Negative values go below the baseline.

rise_set: boolean
scale: number

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.

scale_set: boolean
sentence: boolean

Whether this tag represents a single sentence.

This affects cursor movement.

sentence_set: boolean
show_spaces: ShowFlags

How to render invisible characters.

show_spaces_set: boolean
size: number

Font size in Pango units.

size_points: number

Font size in points.

size_set: boolean
stretch: Stretch

Font stretch as a PangoStretch, e.g. %PANGO_STRETCH_CONDENSED.

stretch_set: boolean
strikethrough: boolean

Whether to strike through the text.

strikethrough_rgba: Gdk.RGBA

This property modifies the color of strikeouts.

If not set, strikeouts will use the foreground color.

strikethrough_rgba_set: boolean

If the strikethrough-rgba property has been set.

strikethrough_set: boolean
style: Pango.Style

Font style as a PangoStyle, e.g. %PANGO_STYLE_ITALIC.

style_set: boolean
tabs: TabArray

Custom tabs for this text.

tabs_set: boolean
text_transform: TextTransform

How to transform the text for display.

text_transform_set: boolean
underline: Underline

Style of underline for this text.

underline_rgba: Gdk.RGBA

This property modifies the color of underlines.

If not set, underlines will use the foreground color.

If [propertyGtk.TextTag: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.

underline_rgba_set: boolean

If the underline-rgba property has been set.

underline_set: boolean
variant: Pango.Variant

Font variant as a PangoVariant, e.g. %PANGO_VARIANT_SMALL_CAPS.

variant_set: boolean
weight: number

Font weight as an integer.

weight_set: boolean
word: boolean

Whether this tag represents a single word.

This affects line breaks and cursor movement.

word_set: boolean
wrap_mode: Gtk.WrapMode

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

wrap_mode_set: boolean
$gtype: GType<Gtk.TextTag>
name: string

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • changed(size_changed: boolean): void
  • Emits the [signalGtk.TextTagTable::tag-changed] signal on the GtkTextTagTable where the tag is included.

    The signal is already emitted when setting a GtkTextTag property. This function is useful for a GtkTextTag subclass.

    Parameters

    • size_changed: boolean

      whether the change affects the GtkTextView layout

    Returns void

  • connect(sigName: "notify::accumulative-margin", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::allow-breaks", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::allow-breaks-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::background", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::background-full-height", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::background-full-height-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::background-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::background-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::direction", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::editable", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::editable-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::fallback", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::fallback-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::family", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::family-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::font", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::font-desc", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::font-features", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::font-features-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::foreground", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::foreground-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::foreground-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::indent", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::indent-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::insert-hyphens", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::insert-hyphens-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::invisible", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::invisible-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::justification", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::justification-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::language", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::language-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::left-margin", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::left-margin-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::letter-spacing", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::letter-spacing-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::line-height", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::line-height-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::name", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::overline", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::overline-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::overline-rgba-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::overline-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::paragraph-background", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::paragraph-background-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::paragraph-background-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::pixels-above-lines", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::pixels-above-lines-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::pixels-below-lines", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::pixels-below-lines-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::pixels-inside-wrap", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::pixels-inside-wrap-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::right-margin", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::right-margin-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::rise", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::rise-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::scale", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::scale-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::sentence", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::sentence-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::show-spaces", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::show-spaces-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::size", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::size-points", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::size-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::stretch", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::stretch-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::strikethrough", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::strikethrough-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::strikethrough-rgba-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::strikethrough-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::style", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::style-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::tabs", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::tabs-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::text-transform", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::text-transform-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::underline", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::underline-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::underline-rgba-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::underline-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::variant", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::variant-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::weight", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::weight-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::word", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::word-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::wrap-mode", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: "notify::wrap-mode-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: "notify::accumulative-margin", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::allow-breaks", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::allow-breaks-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::background", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::background-full-height", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::background-full-height-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::background-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::background-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::direction", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::editable", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::editable-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::fallback", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::fallback-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::family", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::family-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::font", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::font-desc", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::font-features", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::font-features-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::foreground", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::foreground-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::foreground-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::indent", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::indent-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::insert-hyphens", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::insert-hyphens-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::invisible", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::invisible-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::justification", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::justification-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::language", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::language-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::left-margin", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::left-margin-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::letter-spacing", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::letter-spacing-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::line-height", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::line-height-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::name", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::overline", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::overline-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::overline-rgba-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::overline-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::paragraph-background", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::paragraph-background-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::paragraph-background-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::pixels-above-lines", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::pixels-above-lines-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::pixels-below-lines", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::pixels-below-lines-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::pixels-inside-wrap", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::pixels-inside-wrap-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::right-margin", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::right-margin-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::rise", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::rise-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::scale", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::scale-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::sentence", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::sentence-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::show-spaces", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::show-spaces-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::size", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::size-points", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::size-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::stretch", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::stretch-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::strikethrough", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::strikethrough-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::strikethrough-rgba-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::strikethrough-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::style", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::style-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::tabs", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::tabs-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::text-transform", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::text-transform-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::underline", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::underline-rgba", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::underline-rgba-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::underline-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::variant", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::variant-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::weight", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::weight-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::word", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::word-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::wrap-mode", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: "notify::wrap-mode-set", callback: (($obj: Gtk.TextTag, pspec: ParamSpec) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): void
  • emit(sigName: "notify::accumulative-margin", ...args: any[]): void
  • emit(sigName: "notify::allow-breaks", ...args: any[]): void
  • emit(sigName: "notify::allow-breaks-set", ...args: any[]): void
  • emit(sigName: "notify::background", ...args: any[]): void
  • emit(sigName: "notify::background-full-height", ...args: any[]): void
  • emit(sigName: "notify::background-full-height-set", ...args: any[]): void
  • emit(sigName: "notify::background-rgba", ...args: any[]): void
  • emit(sigName: "notify::background-set", ...args: any[]): void
  • emit(sigName: "notify::direction", ...args: any[]): void
  • emit(sigName: "notify::editable", ...args: any[]): void
  • emit(sigName: "notify::editable-set", ...args: any[]): void
  • emit(sigName: "notify::fallback", ...args: any[]): void
  • emit(sigName: "notify::fallback-set", ...args: any[]): void
  • emit(sigName: "notify::family", ...args: any[]): void
  • emit(sigName: "notify::family-set", ...args: any[]): void
  • emit(sigName: "notify::font", ...args: any[]): void
  • emit(sigName: "notify::font-desc", ...args: any[]): void
  • emit(sigName: "notify::font-features", ...args: any[]): void
  • emit(sigName: "notify::font-features-set", ...args: any[]): void
  • emit(sigName: "notify::foreground", ...args: any[]): void
  • emit(sigName: "notify::foreground-rgba", ...args: any[]): void
  • emit(sigName: "notify::foreground-set", ...args: any[]): void
  • emit(sigName: "notify::indent", ...args: any[]): void
  • emit(sigName: "notify::indent-set", ...args: any[]): void
  • emit(sigName: "notify::insert-hyphens", ...args: any[]): void
  • emit(sigName: "notify::insert-hyphens-set", ...args: any[]): void
  • emit(sigName: "notify::invisible", ...args: any[]): void
  • emit(sigName: "notify::invisible-set", ...args: any[]): void
  • emit(sigName: "notify::justification", ...args: any[]): void
  • emit(sigName: "notify::justification-set", ...args: any[]): void
  • emit(sigName: "notify::language", ...args: any[]): void
  • emit(sigName: "notify::language-set", ...args: any[]): void
  • emit(sigName: "notify::left-margin", ...args: any[]): void
  • emit(sigName: "notify::left-margin-set", ...args: any[]): void
  • emit(sigName: "notify::letter-spacing", ...args: any[]): void
  • emit(sigName: "notify::letter-spacing-set", ...args: any[]): void
  • emit(sigName: "notify::line-height", ...args: any[]): void
  • emit(sigName: "notify::line-height-set", ...args: any[]): void
  • emit(sigName: "notify::name", ...args: any[]): void
  • emit(sigName: "notify::overline", ...args: any[]): void
  • emit(sigName: "notify::overline-rgba", ...args: any[]): void
  • emit(sigName: "notify::overline-rgba-set", ...args: any[]): void
  • emit(sigName: "notify::overline-set", ...args: any[]): void
  • emit(sigName: "notify::paragraph-background", ...args: any[]): void
  • emit(sigName: "notify::paragraph-background-rgba", ...args: any[]): void
  • emit(sigName: "notify::paragraph-background-set", ...args: any[]): void
  • emit(sigName: "notify::pixels-above-lines", ...args: any[]): void
  • emit(sigName: "notify::pixels-above-lines-set", ...args: any[]): void
  • emit(sigName: "notify::pixels-below-lines", ...args: any[]): void
  • emit(sigName: "notify::pixels-below-lines-set", ...args: any[]): void
  • emit(sigName: "notify::pixels-inside-wrap", ...args: any[]): void
  • emit(sigName: "notify::pixels-inside-wrap-set", ...args: any[]): void
  • emit(sigName: "notify::right-margin", ...args: any[]): void
  • emit(sigName: "notify::right-margin-set", ...args: any[]): void
  • emit(sigName: "notify::rise", ...args: any[]): void
  • emit(sigName: "notify::rise-set", ...args: any[]): void
  • emit(sigName: "notify::scale", ...args: any[]): void
  • emit(sigName: "notify::scale-set", ...args: any[]): void
  • emit(sigName: "notify::sentence", ...args: any[]): void
  • emit(sigName: "notify::sentence-set", ...args: any[]): void
  • emit(sigName: "notify::show-spaces", ...args: any[]): void
  • emit(sigName: "notify::show-spaces-set", ...args: any[]): void
  • emit(sigName: "notify::size", ...args: any[]): void
  • emit(sigName: "notify::size-points", ...args: any[]): void
  • emit(sigName: "notify::size-set", ...args: any[]): void
  • emit(sigName: "notify::stretch", ...args: any[]): void
  • emit(sigName: "notify::stretch-set", ...args: any[]): void
  • emit(sigName: "notify::strikethrough", ...args: any[]): void
  • emit(sigName: "notify::strikethrough-rgba", ...args: any[]): void
  • emit(sigName: "notify::strikethrough-rgba-set", ...args: any[]): void
  • emit(sigName: "notify::strikethrough-set", ...args: any[]): void
  • emit(sigName: "notify::style", ...args: any[]): void
  • emit(sigName: "notify::style-set", ...args: any[]): void
  • emit(sigName: "notify::tabs", ...args: any[]): void
  • emit(sigName: "notify::tabs-set", ...args: any[]): void
  • emit(sigName: "notify::text-transform", ...args: any[]): void
  • emit(sigName: "notify::text-transform-set", ...args: any[]): void
  • emit(sigName: "notify::underline", ...args: any[]): void
  • emit(sigName: "notify::underline-rgba", ...args: any[]): void
  • emit(sigName: "notify::underline-rgba-set", ...args: any[]): void
  • emit(sigName: "notify::underline-set", ...args: any[]): void
  • emit(sigName: "notify::variant", ...args: any[]): void
  • emit(sigName: "notify::variant-set", ...args: any[]): void
  • emit(sigName: "notify::weight", ...args: any[]): void
  • emit(sigName: "notify::weight-set", ...args: any[]): void
  • emit(sigName: "notify::word", ...args: any[]): void
  • emit(sigName: "notify::word-set", ...args: any[]): void
  • emit(sigName: "notify::wrap-mode", ...args: any[]): void
  • emit(sigName: "notify::wrap-mode-set", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freeze_notify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • get_data(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • get_priority(): number
  • get_property(property_name?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • get_qdata(quark: number): object
  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • is_floating(): boolean
  • notify(property_name: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • run_dispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • set_data(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • set_priority(priority: number): void
  • Sets the priority of a GtkTextTag.

    Valid priorities start at 0 and go to one less than [methodGtk.TextTagTable.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 [methodGtk.TextBuffer.create_tag], which adds the tag to the buffer’s table automatically.

    Parameters

    • priority: number

      the new priority

    Returns void

  • set_property(property_name: string, value?: any): void
  • steal_data(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • steal_qdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thaw_notify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compat_control(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • property_name: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • g_iface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method