File: //usr/share/gtk-doc/html/gtk/GtkTextTagTable.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkTextTagTable</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="prev" href="GtkTextTag.html" title="GtkTextTag">
<link rel="next" href="GtkTextView.html" title="GtkTextView">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkTextTag.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="TextWidgetObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkTextView.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3044834" class="shortcut">Top</a>
 | 
<a href="#id3045224" class="shortcut">Description</a>
 | 
<a href="#id3045053" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3045078" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkTextTagTable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3044834"></a><span class="refentrytitle">GtkTextTagTable</span>
</h2>
<p>GtkTextTagTable —
Collection of tags that can be used together</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkTextTagTable.html#GtkTextTagTable-struct">GtkTextTagTable</a>;
void (<a href="GtkTextTagTable.html#GtkTextTagTableForeach">*GtkTextTagTableForeach</a>) (<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *tag,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a>* <a href="GtkTextTagTable.html#gtk-text-tag-table-new">gtk_text_tag_table_new</a> (void);
void <a href="GtkTextTagTable.html#gtk-text-tag-table-add">gtk_text_tag_table_add</a> (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *tag);
void <a href="GtkTextTagTable.html#gtk-text-tag-table-remove">gtk_text_tag_table_remove</a> (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *tag);
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a>* <a href="GtkTextTagTable.html#gtk-text-tag-table-lookup">gtk_text_tag_table_lookup</a> (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
void <a href="GtkTextTagTable.html#gtk-text-tag-table-foreach">gtk_text_tag_table_foreach</a> (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table,
<a href="GtkTextTagTable.html#GtkTextTagTableForeach">GtkTextTagTableForeach</a> func,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkTextTagTable.html#gtk-text-tag-table-get-size">gtk_text_tag_table_get_size</a> (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3045053"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----GtkTextTagTable
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3045078"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkTextTagTable.html#GtkTextTagTable-tag-added">tag-added</a>" void user_function (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *texttagtable,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *arg1,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GtkTextTagTable.html#GtkTextTagTable-tag-changed">tag-changed</a>"
void user_function (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *texttagtable,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *arg1,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> arg2,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GtkTextTagTable.html#GtkTextTagTable-tag-removed">tag-removed</a>"
void user_function (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *texttagtable,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *arg1,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3045224"></a><h2>Description</h2>
<p>
You may wish to begin by reading the <a href="TextWidget.html" title="Text Widget Overview">text widget
conceptual overview</a> which gives an overview of all the objects and data
types related to the text widget and how they work together.
</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3045252"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3045262"></a><h3>
<a name="GtkTextTagTable-struct"></a>GtkTextTagTable</h3>
<a class="indexterm" name="id3045275"></a><pre class="programlisting">typedef struct _GtkTextTagTable GtkTextTagTable;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3045290"></a><h3>
<a name="GtkTextTagTableForeach"></a>GtkTextTagTableForeach ()</h3>
<a class="indexterm" name="id3045303"></a><pre class="programlisting">void (*GtkTextTagTableForeach) (<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *tag,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>tag</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3045370"></a><h3>
<a name="gtk-text-tag-table-new"></a>gtk_text_tag_table_new ()</h3>
<a class="indexterm" name="id3045383"></a><pre class="programlisting"><a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a>* gtk_text_tag_table_new (void);</pre>
<p>
Creates a new <a href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a>. The table contains no tags by
default.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3045440"></a><h3>
<a name="gtk-text-tag-table-add"></a>gtk_text_tag_table_add ()</h3>
<a class="indexterm" name="id3045453"></a><pre class="programlisting">void gtk_text_tag_table_add (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *tag);</pre>
<p>
Add a tag to the table. The tag is assigned the highest priority
in the table.
</p>
<p>
<em class="parameter"><code>tag</code></em> must not be in a tag table already, and may not have
the same name as an already-added tag.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>table</code></em> :</span></td>
<td> a <a href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>tag</code></em> :</span></td>
<td> a <a href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3045551"></a><h3>
<a name="gtk-text-tag-table-remove"></a>gtk_text_tag_table_remove ()</h3>
<a class="indexterm" name="id3045565"></a><pre class="programlisting">void gtk_text_tag_table_remove (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *tag);</pre>
<p>
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.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>table</code></em> :</span></td>
<td> a <a href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>tag</code></em> :</span></td>
<td> a <a href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3045653"></a><h3>
<a name="gtk-text-tag-table-lookup"></a>gtk_text_tag_table_lookup ()</h3>
<a class="indexterm" name="id3045667"></a><pre class="programlisting"><a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a>* gtk_text_tag_table_lookup (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Look up a named tag.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>table</code></em> :</span></td>
<td> a <a href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> name of a tag
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The tag, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if none by that name is in the table.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3045768"></a><h3>
<a name="gtk-text-tag-table-foreach"></a>gtk_text_tag_table_foreach ()</h3>
<a class="indexterm" name="id3045781"></a><pre class="programlisting">void gtk_text_tag_table_foreach (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table,
<a href="GtkTextTagTable.html#GtkTextTagTableForeach">GtkTextTagTableForeach</a> func,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
Calls <em class="parameter"><code>func</code></em> on each tag in <em class="parameter"><code>table</code></em>, with user data <em class="parameter"><code>data</code></em>.
Note that the table may not be modified while iterating
over it (you can't add/remove tags).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>table</code></em> :</span></td>
<td> a <a href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>func</code></em> :</span></td>
<td> a function to call on each tag
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td> user data
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3045903"></a><h3>
<a name="gtk-text-tag-table-get-size"></a>gtk_text_tag_table_get_size ()</h3>
<a class="indexterm" name="id3045917"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_text_tag_table_get_size (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *table);</pre>
<p>
Returns the size of the table (number of tags)</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>table</code></em> :</span></td>
<td> a <a href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> number of tags in <em class="parameter"><code>table</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3045992"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id3046003"></a><h3>
<a name="GtkTextTagTable-tag-added"></a>The "tag-added" signal</h3>
<a class="indexterm" name="id3046013"></a><pre class="programlisting">void user_function (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *texttagtable,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *arg1,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>texttagtable</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3046103"></a><h3>
<a name="GtkTextTagTable-tag-changed"></a>The "tag-changed" signal</h3>
<a class="indexterm" name="id3046114"></a><pre class="programlisting">void user_function (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *texttagtable,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *arg1,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> arg2,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>texttagtable</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg2</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3046225"></a><h3>
<a name="GtkTextTagTable-tag-removed"></a>The "tag-removed" signal</h3>
<a class="indexterm" name="id3046236"></a><pre class="programlisting">void user_function (<a href="GtkTextTagTable.html" title="GtkTextTagTable">GtkTextTagTable</a> *texttagtable,
<a href="GtkTextTag.html" title="GtkTextTag">GtkTextTag</a> *arg1,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>texttagtable</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>