Index

Package: Text_Tag

Description

package Gtk.Text_Tag is

You may wish to begin by reading the <link linkend="TextWidget">text widget conceptual overview</link> 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 <application>gtk3-demo</application> 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.

Packages

Text_Tag_List (new Glib.GSlist.Generic_SList)

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

Classes

Gtk_Text_Tag_Record

type Gtk_Text_Tag_Record is new GObject_Record with null record;

Ancestors:

Primitive operations:

Get_Priority
Glib.Object.Deallocate (Inherited)
Glib.Object.Get_Type (Inherited)
Glib.Object.Notify (Inherited)
Glib.Object.Ref (Inherited)
Glib.Object.Ref_Sink (Inherited)
Glib.Object.Unref (Inherited)
Set_Priority

Types

Gtk_Text_Tag

type Gtk_Text_Tag is access all Gtk_Text_Tag_Record'Class;

Constants & Global variables

Accumulative_Margin_Property (Glib.Properties.Property_Boolean)

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_Property (Glib.Properties.Property_String)

Background_Property : constant Glib.Properties.Property_String;
Flags: write

Background_Full_Height_Property (Glib.Properties.Property_Boolean)

Background_Full_Height_Property : constant Glib.Properties.Property_Boolean;

Background_Full_Height_Set_Property (Glib.Properties.Property_Boolean)

Background_Full_Height_Set_Property : constant Glib.Properties.Property_Boolean;

Background_Gdk_Property (Gdk.Color.Property_Gdk_Color)

Background_Gdk_Property : constant Gdk.Color.Property_Gdk_Color;
Type: Gdk.Color.Gdk_Color Background color as a Gdk.Color.Gdk_Color.

Background_Rgba_Property (Gdk.RGBA.Property_RGBA)

Background_Rgba_Property : constant Gdk.RGBA.Property_RGBA;
Type: Gdk.RGBA.Gdk_RGBA Background color as a Gdk.RGBA.Gdk_RGBA.

Background_Set_Property (Glib.Properties.Property_Boolean)

Background_Set_Property : constant Glib.Properties.Property_Boolean;

Editable_Set_Property (Glib.Properties.Property_Boolean)

Editable_Set_Property : constant Glib.Properties.Property_Boolean;

Font_Property (Glib.Properties.Property_String)

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_Property (Glib.Properties.Property_String)

Foreground_Property : constant Glib.Properties.Property_String;
Flags: write

Foreground_Gdk_Property (Gdk.Color.Property_Gdk_Color)

Foreground_Gdk_Property : constant Gdk.Color.Property_Gdk_Color;
Type: Gdk.Color.Gdk_Color Foreground color as a Gdk.Color.Gdk_Color.

Foreground_Rgba_Property (Gdk.RGBA.Property_RGBA)

Foreground_Rgba_Property : constant Gdk.RGBA.Property_RGBA;
Type: Gdk.RGBA.Gdk_RGBA Foreground color as a Gdk.RGBA.Gdk_RGBA.

Foreground_Set_Property (Glib.Properties.Property_Boolean)

Foreground_Set_Property : constant Glib.Properties.Property_Boolean;

Invisible_Property (Glib.Properties.Property_Boolean)

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 (Glib.Properties.Property_Boolean)

Invisible_Set_Property : constant Glib.Properties.Property_Boolean;

Justification_Set_Property (Glib.Properties.Property_Boolean)

Justification_Set_Property : constant Glib.Properties.Property_Boolean;

Language_Property (Glib.Properties.Property_String)

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 (Glib.Properties.Property_Boolean)

Language_Set_Property : constant Glib.Properties.Property_Boolean;

Left_Margin_Property (Glib.Properties.Property_Int)

Left_Margin_Property : constant Glib.Properties.Property_Int;

Left_Margin_Set_Property (Glib.Properties.Property_Boolean)

Left_Margin_Set_Property : constant Glib.Properties.Property_Boolean;

Paragraph_Background_Property (Glib.Properties.Property_String)

Paragraph_Background_Property : constant Glib.Properties.Property_String;
Flags: write The paragraph background color as a string.

Paragraph_Background_Gdk_Property (Gdk.Color.Property_Gdk_Color)

Paragraph_Background_Gdk_Property : constant Gdk.Color.Property_Gdk_Color;
Type: Gdk.Color.Gdk_Color The paragraph background color as a as a Gdk.Color.Gdk_Color.

Paragraph_Background_Rgba_Property (Gdk.RGBA.Property_RGBA)

Paragraph_Background_Rgba_Property : constant Gdk.RGBA.Property_RGBA;
Type: Gdk.RGBA.Gdk_RGBA The paragraph background color as a as a Gdk.RGBA.Gdk_RGBA.

Paragraph_Background_Set_Property (Glib.Properties.Property_Boolean)

Paragraph_Background_Set_Property : constant Glib.Properties.Property_Boolean;

Pixels_Above_Lines_Property (Glib.Properties.Property_Int)

Pixels_Above_Lines_Property : constant Glib.Properties.Property_Int;

Pixels_Above_Lines_Set_Property (Glib.Properties.Property_Boolean)

Pixels_Above_Lines_Set_Property : constant Glib.Properties.Property_Boolean;

Pixels_Below_Lines_Property (Glib.Properties.Property_Int)

Pixels_Below_Lines_Property : constant Glib.Properties.Property_Int;

Pixels_Below_Lines_Set_Property (Glib.Properties.Property_Boolean)

Pixels_Below_Lines_Set_Property : constant Glib.Properties.Property_Boolean;

Pixels_Inside_Wrap_Property (Glib.Properties.Property_Int)

Pixels_Inside_Wrap_Property : constant Glib.Properties.Property_Int;

Pixels_Inside_Wrap_Set_Property (Glib.Properties.Property_Boolean)

Pixels_Inside_Wrap_Set_Property : constant Glib.Properties.Property_Boolean;

Right_Margin_Property (Glib.Properties.Property_Int)

Right_Margin_Property : constant Glib.Properties.Property_Int;

Right_Margin_Set_Property (Glib.Properties.Property_Boolean)

Right_Margin_Set_Property : constant Glib.Properties.Property_Boolean;

Scale_Property (Glib.Properties.Property_Double)

Scale_Property : constant Glib.Properties.Property_Double;
Type: Gdouble

Size_Points_Property (Glib.Properties.Property_Double)

Size_Points_Property : constant Glib.Properties.Property_Double;
Type: Gdouble

Stretch_Set_Property (Glib.Properties.Property_Boolean)

Stretch_Set_Property : constant Glib.Properties.Property_Boolean;

Strikethrough_Property (Glib.Properties.Property_Boolean)

Strikethrough_Property : constant Glib.Properties.Property_Boolean;

Strikethrough_Set_Property (Glib.Properties.Property_Boolean)

Strikethrough_Set_Property : constant Glib.Properties.Property_Boolean;

Tabs_Property (Glib.Properties.Property_Boxed)

Tabs_Property : constant Glib.Properties.Property_Boxed;
Type: Pango.Tab_Array

Underline_Set_Property (Glib.Properties.Property_Boolean)

Underline_Set_Property : constant Glib.Properties.Property_Boolean;

Variant_Set_Property (Glib.Properties.Property_Boolean)

Variant_Set_Property : constant Glib.Properties.Property_Boolean;

Wrap_Mode_Set_Property (Glib.Properties.Property_Boolean)

Wrap_Mode_Set_Property : constant Glib.Properties.Property_Boolean;

Signal_Event (Glib.Signal_Name)

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: -- "object": the object the event was fired from (typically a -- Gtk.Text_View.Gtk_Text_View) -- "event": the event which triggered the signal -- "iter": a Gtk.Text_Iter.Gtk_Text_Iter pointing at the location the -- event occured -- Returns True to stop other handlers from being invoked for the event. False to propagate the event further.

Subprograms & Entries

Convert

function Convert 
(R: Gtk.Text_Tag.Gtk_Text_Tag) return System.Address;

Convert

function Convert 
(R: System.Address) return Gtk.Text_Tag.Gtk_Text_Tag;

Gtk_New

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

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. "name": tag name, or null

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. "name": tag name, or null

Get_Type

function Get_Type return Glib.GType;

Get_Priority

function Get_Priority 
(Tag: not null access Gtk_Text_Tag_Record) return Gint;
Get the tag priority.

Set_Priority

procedure Set_Priority 
(Tag: not null access Gtk_Text_Tag_Record;
Priority: Gint);
Sets the priority of a Gtk.Text_Tag.Gtk_Text_Tag. Valid priorities are 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. "priority": the new priority