Gtk.Text_Tag

Entities

Tagged Types

Access Types

Constants

Subprograms

Generic Instantiations

Description

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 Gtk.Text_Tag_Table.Gtk_Text_Tag_Table for a given Gtk.Text_Buffer.Gtk_Text_Buffer 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 Gtk.Text_Tag.Gtk_Text_Tag, 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.

Accumulative_Margin_Property

Accumulative_Margin_Property : constant Glib.Properties.Property_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).

Background_Full_Height_Property

Background_Full_Height_Property : constant Glib.Properties.Property_Boolean;

Background_Full_Height_Set_Property

Background_Full_Height_Set_Property : constant Glib.Properties.Property_Boolean;

Background_Gdk_Property

Background_Gdk_Property : constant Gdk.Color.Property_Gdk_Color;

Type: Gdk.Color.Gdk_Color Background color as a Gdk.Color.Gdk_Color.

Background_Property

Background_Property : constant Glib.Properties.Property_String;

Flags: write

Background_Rgba_Property

Background_Rgba_Property : constant Gdk.RGBA.Property_RGBA;

Type: Gdk.RGBA.Gdk_RGBA Background color as a Gdk.RGBA.Gdk_RGBA.

Background_Set_Property

Background_Set_Property : constant Glib.Properties.Property_Boolean;

Changed

procedure Changed
   (Tag          : not null access Gtk_Text_Tag_Record;
    Size_Changed : Boolean)

Emits the Gtk.Text_Tag_Table.Gtk_Text_Tag_Table::tag-changed signal on the Gtk.Text_Tag_Table.Gtk_Text_Tag_Table where the tag is included. The signal is already emitted when setting a Gtk.Text_Tag.Gtk_Text_Tag property. This function is useful for a Gtk.Text_Tag.Gtk_Text_Tag subclass. Since: gtk+ 3.20

Parameters
Tag
Size_Changed

whether the change affects the Gtk.Text_View.Gtk_Text_View layout.

Convert

function Convert (R : Gtk.Text_Tag.Gtk_Text_Tag) return System.Address
Parameters
R
Return Value

Convert

function Convert (R : System.Address) return Gtk.Text_Tag.Gtk_Text_Tag
Parameters
R
Return Value

Direction_Property

Direction_Property : constant Gtk.Enums.Property_Gtk_Text_Direction;

Editable_Property

Editable_Property : constant Glib.Properties.Property_Boolean;

Editable_Set_Property

Editable_Set_Property : constant Glib.Properties.Property_Boolean;

Fallback_Property

Fallback_Property : constant Glib.Properties.Property_Boolean;

Whether font fallback is enabled.

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

Fallback_Set_Property

Fallback_Set_Property : constant Glib.Properties.Property_Boolean;

Family_Property

Family_Property : constant Glib.Properties.Property_String;

Family_Set_Property

Family_Set_Property : constant Glib.Properties.Property_Boolean;

Font_Desc_Property

Font_Desc_Property : constant Pango.Font.Property_Font_Description;

Type: Pango.Font.Pango_Font_Description

Font_Features_Property

Font_Features_Property : constant Glib.Properties.Property_String;

OpenType font features, as a string.

Font_Features_Set_Property

Font_Features_Set_Property : constant Glib.Properties.Property_Boolean;

Font_Property

Font_Property : constant Glib.Properties.Property_String;

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

Note that the initial value of this property depends on the internals of Pango.Font.Pango_Font_Description.

Foreground_Gdk_Property

Foreground_Gdk_Property : constant Gdk.Color.Property_Gdk_Color;

Type: Gdk.Color.Gdk_Color Foreground color as a Gdk.Color.Gdk_Color.

Foreground_Property

Foreground_Property : constant Glib.Properties.Property_String;

Flags: write

Foreground_Rgba_Property

Foreground_Rgba_Property : constant Gdk.RGBA.Property_RGBA;

Type: Gdk.RGBA.Gdk_RGBA Foreground color as a Gdk.RGBA.Gdk_RGBA.

Foreground_Set_Property

Foreground_Set_Property : constant Glib.Properties.Property_Boolean;

Get_Priority

function Get_Priority
   (Tag : not null access Gtk_Text_Tag_Record) return Glib.Gint

Get the tag priority.

Parameters
Tag
Return Value

The tag's priority.

Get_Type

function Get_Type return Glib.GType
Return Value

Gtk_New

procedure Gtk_New (Tag : out Gtk_Text_Tag; Name : UTF8_String := "")

Creates a Gtk.Text_Tag.Gtk_Text_Tag. Configure the tag using object arguments, i.e. using g_object_set. Newly created tags must be added to the tags table for the buffer you intend to use them in, as in: "Gtk.Text_Tag_Table.Add (Get_Tag_Table (Buffer), Tag)". See also Gtk.Text_Buffer.Create_Tag which is a more convenient way of creating a tag. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Tag
Name

tag name, or null

Gtk_Text_Tag

type Gtk_Text_Tag is access all Gtk_Text_Tag_Record'Class;

Gtk_Text_Tag_New

function Gtk_Text_Tag_New (Name : UTF8_String := "") return Gtk_Text_Tag

Creates a Gtk.Text_Tag.Gtk_Text_Tag. Configure the tag using object arguments, i.e. using g_object_set. Newly created tags must be added to the tags table for the buffer you intend to use them in, as in: "Gtk.Text_Tag_Table.Add (Get_Tag_Table (Buffer), Tag)". See also Gtk.Text_Buffer.Create_Tag which is a more convenient way of creating a tag.

Parameters
Name

tag name, or null

Return Value

Gtk_Text_Tag_Record

type Gtk_Text_Tag_Record is new GObject_Record with null record;

Indent_Property

Indent_Property : constant Glib.Properties.Property_Int;

Indent_Set_Property

Indent_Set_Property : constant Glib.Properties.Property_Boolean;

Initialize

procedure Initialize
   (Tag  : not null access Gtk_Text_Tag_Record'Class;
    Name : UTF8_String := "")

Creates a Gtk.Text_Tag.Gtk_Text_Tag. Configure the tag using object arguments, i.e. using g_object_set. Newly created tags must be added to the tags table for the buffer you intend to use them in, as in: "Gtk.Text_Tag_Table.Add (Get_Tag_Table (Buffer), Tag)". See also Gtk.Text_Buffer.Create_Tag which is a more convenient way of creating a tag. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Tag
Name

tag name, or null

Invisible_Property

Invisible_Property : constant Glib.Properties.Property_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_Property

Invisible_Set_Property : constant Glib.Properties.Property_Boolean;

Justification_Property

Justification_Property : constant Gtk.Enums.Property_Gtk_Justification;

Justification_Set_Property

Justification_Set_Property : constant Glib.Properties.Property_Boolean;

Language_Property

Language_Property : constant Glib.Properties.Property_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 Gtk.Main.Get_Default_Language.

Language_Set_Property

Language_Set_Property : constant Glib.Properties.Property_Boolean;

Left_Margin_Property

Left_Margin_Property : constant Glib.Properties.Property_Int;

Left_Margin_Set_Property

Left_Margin_Set_Property : constant Glib.Properties.Property_Boolean;

Letter_Spacing_Property

Letter_Spacing_Property : constant Glib.Properties.Property_Int;

Extra spacing between graphemes, in Pango units.

Letter_Spacing_Set_Property

Letter_Spacing_Set_Property : constant Glib.Properties.Property_Boolean;

Name_Property

Name_Property : constant Glib.Properties.Property_String;

Paragraph_Background_Gdk_Property

Paragraph_Background_Gdk_Property : constant Gdk.Color.Property_Gdk_Color;

Type: Gdk.Color.Gdk_Color The paragraph background color as a Gdk.Color.Gdk_Color.

Paragraph_Background_Property

Paragraph_Background_Property : constant Glib.Properties.Property_String;

Flags: write The paragraph background color as a string.

Paragraph_Background_Rgba_Property

Paragraph_Background_Rgba_Property : constant Gdk.RGBA.Property_RGBA;

Type: Gdk.RGBA.Gdk_RGBA The paragraph background color as a Gdk.RGBA.Gdk_RGBA.

Paragraph_Background_Set_Property

Paragraph_Background_Set_Property : constant Glib.Properties.Property_Boolean;

Pixels_Above_Lines_Property

Pixels_Above_Lines_Property : constant Glib.Properties.Property_Int;

Pixels_Above_Lines_Set_Property

Pixels_Above_Lines_Set_Property : constant Glib.Properties.Property_Boolean;

Pixels_Below_Lines_Property

Pixels_Below_Lines_Property : constant Glib.Properties.Property_Int;

Pixels_Below_Lines_Set_Property

Pixels_Below_Lines_Set_Property : constant Glib.Properties.Property_Boolean;

Pixels_Inside_Wrap_Property

Pixels_Inside_Wrap_Property : constant Glib.Properties.Property_Int;

Pixels_Inside_Wrap_Set_Property

Pixels_Inside_Wrap_Set_Property : constant Glib.Properties.Property_Boolean;

Right_Margin_Property

Right_Margin_Property : constant Glib.Properties.Property_Int;

Right_Margin_Set_Property

Right_Margin_Set_Property : constant Glib.Properties.Property_Boolean;

Rise_Property

Rise_Property : constant Glib.Properties.Property_Int;

Rise_Set_Property

Rise_Set_Property : constant Glib.Properties.Property_Boolean;

Scale_Property

Scale_Property : constant Glib.Properties.Property_Double;

Type: Gdouble

Scale_Set_Property

Scale_Set_Property : constant Glib.Properties.Property_Boolean;

Set_Priority

procedure Set_Priority
   (Tag      : not null access Gtk_Text_Tag_Record;
    Priority : Glib.Gint)

Sets the priority of a Gtk.Text_Tag.Gtk_Text_Tag. 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.

Parameters
Tag
Priority

the new priority

Signal_Event

Signal_Event : constant Glib.Signal_Name := "event";

The ::event signal is emitted when an event occurs on a region of the buffer marked with this tag. function Handler (Self : access Gtk_Text_Tag_Record'Class; Object : not null access Glib.Object.GObject_Record'Class; Event : Gdk.Event.Gdk_Event; Iter : Gtk.Text_Iter.Gtk_Text_Iter) return Boolean

Callback parameters: -- @param Object the object the event was fired from (typically a -- Gtk.Text_View.Gtk_Text_View) -- @param Event the event which triggered the signal -- @param Iter a Gtk.Text_Iter.Gtk_Text_Iter pointing at the location the -- event occurred

Size_Points_Property

Size_Points_Property : constant Glib.Properties.Property_Double;

Type: Gdouble

Size_Property

Size_Property : constant Glib.Properties.Property_Int;

Size_Set_Property

Size_Set_Property : constant Glib.Properties.Property_Boolean;

Stretch_Property

Stretch_Property : constant Pango.Enums.Property_Stretch;

Type: Pango.Enums.Stretch

Stretch_Set_Property

Stretch_Set_Property : constant Glib.Properties.Property_Boolean;

Strikethrough_Property

Strikethrough_Property : constant Glib.Properties.Property_Boolean;

Strikethrough_Rgba_Property

Strikethrough_Rgba_Property : constant Gdk.RGBA.Property_RGBA;

Type: Gdk.RGBA.Gdk_RGBA This property modifies the color of strikeouts. If not set, strikeouts will use the forground color.

Strikethrough_Rgba_Set_Property

Strikethrough_Rgba_Set_Property : constant Glib.Properties.Property_Boolean;

If the Gtk.Text_Tag.Gtk_Text_Tag:strikethrough-rgba property has been set.

Strikethrough_Set_Property

Strikethrough_Set_Property : constant Glib.Properties.Property_Boolean;

Style_Property

Style_Property : constant Pango.Enums.Property_Style;

Type: Pango.Enums.Style

Style_Set_Property

Style_Set_Property : constant Glib.Properties.Property_Boolean;

Tabs_Property

Tabs_Property : constant Glib.Properties.Property_Boxed;

Type: Pango.Tab_Array

Tabs_Set_Property

Tabs_Set_Property : constant Glib.Properties.Property_Boolean;

Text_Tag_List

package Text_Tag_List is new Generic_SList (Gtk.Text_Tag.Gtk_Text_Tag);

Underline_Property

Underline_Property : constant Pango.Enums.Property_Underline;

Type: Pango.Enums.Underline

Underline_Rgba_Property

Underline_Rgba_Property : constant Gdk.RGBA.Property_RGBA;

Type: Gdk.RGBA.Gdk_RGBA This property modifies the color of underlines. If not set, underlines will use the forground color.

If Gtk.Text_Tag.Gtk_Text_Tag:underline is set to Pango.Enums.Pango_Underline_Error, an alternate color may be applied instead of the foreground. Setting this property will always override those defaults.

Underline_Rgba_Set_Property

Underline_Rgba_Set_Property : constant Glib.Properties.Property_Boolean;

If the Gtk.Text_Tag.Gtk_Text_Tag:underline-rgba property has been set.

Underline_Set_Property

Underline_Set_Property : constant Glib.Properties.Property_Boolean;

Variant_Property

Variant_Property : constant Pango.Enums.Property_Variant;

Type: Pango.Enums.Variant

Variant_Set_Property

Variant_Set_Property : constant Glib.Properties.Property_Boolean;

Weight_Property

Weight_Property : constant Pango.Enums.Property_Weight;

Type: Pango.Enums.Weight

Weight_Set_Property

Weight_Set_Property : constant Glib.Properties.Property_Boolean;

Wrap_Mode_Property

Wrap_Mode_Property : constant Gtk.Enums.Property_Gtk_Wrap_Mode;

Wrap_Mode_Set_Property

Wrap_Mode_Set_Property : constant Glib.Properties.Property_Boolean;