GtkTextTagTable

GtkTextTagTable — Collection of tags that can be used together

Synopsis

#include <gtk/gtk.h>

                    GtkTextTagTable;
void                (*GtkTextTagTableForeach)           (GtkTextTag *tag,
                                                         gpointer data);
GtkTextTagTable *   gtk_text_tag_table_new              (void);
void                gtk_text_tag_table_add              (GtkTextTagTable *table,
                                                         GtkTextTag *tag);
void                gtk_text_tag_table_remove           (GtkTextTagTable *table,
                                                         GtkTextTag *tag);
GtkTextTag *        gtk_text_tag_table_lookup           (GtkTextTagTable *table,
                                                         const gchar *name);
void                gtk_text_tag_table_foreach          (GtkTextTagTable *table,
                                                         GtkTextTagTableForeach func,
                                                         gpointer data);
gint                gtk_text_tag_table_get_size         (GtkTextTagTable *table);

Object Hierarchy

  GObject
   +----GtkTextTagTable

Implemented Interfaces

GtkTextTagTable implements GtkBuildable.

Signals

  "tag-added"                                      : Run Last
  "tag-changed"                                    : Run Last
  "tag-removed"                                    : Run Last

Description

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.

GtkTextTagTables as GtkBuildable

The GtkTextTagTable implementation of the GtkBuildable interface supports adding tags by specifying "tag" as the "type" attribute of a <child> element.

Example 20. A UI definition fragment specifying tags

1
2
3
4
5
 
<object class="GtkTextTagTable">
 <child type="tag">
   <object class="GtkTextTag"/>
 </child>
</object>

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.

Details

GtkTextTagTable

typedef struct _GtkTextTagTable GtkTextTagTable;

GtkTextTagTableForeach ()

void                (*GtkTextTagTableForeach)           (GtkTextTag *tag,
                                                         gpointer data);

gtk_text_tag_table_new ()

GtkTextTagTable *   gtk_text_tag_table_new              (void);

Creates a new GtkTextTagTable. The table contains no tags by default.

Returns :

 a new GtkTextTagTable

gtk_text_tag_table_add ()

void                gtk_text_tag_table_add              (GtkTextTagTable *table,
                                                         GtkTextTag *tag);

Add a tag to the table. The tag is assigned the highest priority in the table.

tag must not be in a tag table already, and may not have the same name as an already-added tag.

table :

 a GtkTextTagTable

tag :

 a GtkTextTag

gtk_text_tag_table_remove ()

void                gtk_text_tag_table_remove           (GtkTextTagTable *table,
                                                         GtkTextTag *tag);

Remove a tag from the table. This will remove the table's reference to the tag, so be careful - the tag will end up destroyed if you don't have a reference to it.

table :

 a GtkTextTagTable

tag :

 a GtkTextTag

gtk_text_tag_table_lookup ()

GtkTextTag *        gtk_text_tag_table_lookup           (GtkTextTagTable *table,
                                                         const gchar *name);

Look up a named tag.

table :

 a GtkTextTagTable

name :

 name of a tag

Returns :

 The tag, or NULL if none by that name is in the table. [transfer none]

gtk_text_tag_table_foreach ()

void                gtk_text_tag_table_foreach          (GtkTextTagTable *table,
                                                         GtkTextTagTableForeach func,
                                                         gpointer data);

Calls func on each tag in table, with user data data. Note that the table may not be modified while iterating over it (you can't add/remove tags).

table :

 a GtkTextTagTable

func :

 a function to call on each tag. [scope call]

data :

 user data

gtk_text_tag_table_get_size ()

gint                gtk_text_tag_table_get_size         (GtkTextTagTable *table);

Returns the size of the table (number of tags)

table :

 a GtkTextTagTable

Returns :

 number of tags in table

Signal Details

The "tag-added" signal

void                user_function                      (GtkTextTagTable *texttagtable,
                                                        GtkTextTag      *arg1,
                                                        gpointer         user_data)         : Run Last

texttagtable :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "tag-changed" signal

void                user_function                      (GtkTextTagTable *texttagtable,
                                                        GtkTextTag      *arg1,
                                                        gboolean         arg2,
                                                        gpointer         user_data)         : Run Last

texttagtable :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "tag-removed" signal

void                user_function                      (GtkTextTagTable *texttagtable,
                                                        GtkTextTag      *arg1,
                                                        gpointer         user_data)         : Run Last

texttagtable :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.19