source-git / gtk2

Clone
Source Code
GIT

Files

  1.   fb6fa58b748a34153c4df27ffd89fdf451542d3a
  2.   docs
  3.   reference
  4.   gtk
  5.   html
  6.   GtkTextTagTable.html
Blob Blame History Raw 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkTextTagTable: GTK+ 2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 2 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.26.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkTextTagTable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkTextTagTable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkTextTagTable.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GtkTextTagTable.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="TextWidgetObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkTextTag.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkTextView.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkTextTagTable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkTextTagTable.top_of_page"></a>GtkTextTagTable</span></h2>
<p>GtkTextTagTable — Collection of tags that can be used together</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkTextTagTable.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="GtkTextTagTable.html#GtkTextTagTableForeach" title="GtkTextTagTableForeach ()">*GtkTextTagTableForeach</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="returnvalue">GtkTextTagTable</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkTextTagTable.html#gtk-text-tag-table-new" title="gtk_text_tag_table_new ()">gtk_text_tag_table_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkTextTagTable.html#gtk-text-tag-table-add" title="gtk_text_tag_table_add ()">gtk_text_tag_table_add</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkTextTagTable.html#gtk-text-tag-table-remove" title="gtk_text_tag_table_remove ()">gtk_text_tag_table_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="returnvalue">GtkTextTag</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkTextTagTable.html#gtk-text-tag-table-lookup" title="gtk_text_tag_table_lookup ()">gtk_text_tag_table_lookup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkTextTagTable.html#gtk-text-tag-table-foreach" title="gtk_text_tag_table_foreach ()">gtk_text_tag_table_foreach</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkTextTagTable.html#gtk-text-tag-table-get-size" title="gtk_text_tag_table_get_size ()">gtk_text_tag_table_get_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkTextTagTable.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkTextTagTable.html#GtkTextTagTable-tag-added" title="The “tag-added” signal">tag-added</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkTextTagTable.html#GtkTextTagTable-tag-changed" title="The “tag-changed” signal">tag-changed</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkTextTagTable.html#GtkTextTagTable-tag-removed" title="The “tag-removed” signal">tag-removed</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkTextTagTable.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GtkTextTagTable.html#GtkTextTagTable-struct" title="GtkTextTagTable">GtkTextTagTable</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkTextTagTable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> GtkTextTagTable
</pre>
</div>
<div class="refsect1">
<a name="GtkTextTagTable.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkTextTagTable implements
 <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkTextTagTable.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkTextTagTable.description"></a><h2>Description</h2>
<p>You may wish to begin by reading the <a class="link" 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>
<div class="refsect2">
<a name="GtkTextTagTable-BUILDER-UI"></a><h3>GtkTextTagTables as GtkBuildable</h3>
<p>
The GtkTextTagTable implementation of the GtkBuildable interface
supports adding tags by specifying "tag" as the "type"
attribute of a &lt;child&gt; element.
</p>
<div class="example">
<a name="id-1.4.8.7.9.3.3"></a><p class="title"><b>Example 7. A UI definition fragment specifying tags</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">&lt;</span>object <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">=</span><span class="string">&quot;GtkTextTagTable&quot;</span><span class="gtkdoc opt">&gt;</span>
 <span class="gtkdoc opt">&lt;</span>child type<span class="gtkdoc opt">=</span><span class="string">&quot;tag&quot;</span><span class="gtkdoc opt">&gt;</span>
   <span class="gtkdoc opt">&lt;</span>object <span class="gtkdoc kwc">class</span><span class="gtkdoc opt">=</span><span class="string">&quot;GtkTextTag&quot;</span><span class="gtkdoc opt">/&gt;</span>
 <span class="gtkdoc opt">&lt;/</span>child<span class="gtkdoc opt">&gt;</span>
<span class="gtkdoc opt">&lt;/</span>object<span class="gtkdoc opt">&gt;</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<br class="example-break">
</div>
</div>
<div class="refsect1">
<a name="GtkTextTagTable.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GtkTextTagTableForeach"></a><h3>GtkTextTagTableForeach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GtkTextTagTableForeach<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a> *tag</code></em>,
                           <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-text-tag-table-new"></a><h3>gtk_text_tag_table_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="returnvalue">GtkTextTagTable</span></a> *
gtk_text_tag_table_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a>. The table contains no tags by
default.</p>
<div class="refsect3">
<a name="gtk-text-tag-table-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-text-tag-table-add"></a><h3>gtk_text_tag_table_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_text_tag_table_add (<em class="parameter"><code><a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a> *table</code></em>,
                        <em class="parameter"><code><a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a> *tag</code></em>);</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>
<div class="refsect3">
<a name="gtk-text-tag-table-add.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>table</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tag</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-text-tag-table-remove"></a><h3>gtk_text_tag_table_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_text_tag_table_remove (<em class="parameter"><code><a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a> *table</code></em>,
                           <em class="parameter"><code><a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a> *tag</code></em>);</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>
<div class="refsect3">
<a name="gtk-text-tag-table-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>table</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tag</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-text-tag-table-lookup"></a><h3>gtk_text_tag_table_lookup ()</h3>
<pre class="programlisting"><a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="returnvalue">GtkTextTag</span></a> *
gtk_text_tag_table_lookup (<em class="parameter"><code><a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a> *table</code></em>,
                           <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Look up a named tag.</p>
<div class="refsect3">
<a name="gtk-text-tag-table-lookup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>table</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a> </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>name of a tag</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-text-tag-table-lookup.returns"></a><h4>Returns</h4>
<p>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. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-text-tag-table-foreach"></a><h3>gtk_text_tag_table_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_text_tag_table_foreach (<em class="parameter"><code><a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a> *table</code></em>,
                            <em class="parameter"><code><a class="link" href="GtkTextTagTable.html#GtkTextTagTableForeach" title="GtkTextTagTableForeach ()"><span class="type">GtkTextTagTableForeach</span></a> func</code></em>,
                            <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</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>
<div class="refsect3">
<a name="gtk-text-tag-table-foreach.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>table</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>a function to call on each tag. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-text-tag-table-get-size"></a><h3>gtk_text_tag_table_get_size ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gtk_text_tag_table_get_size (<em class="parameter"><code><a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a> *table</code></em>);</pre>
<p>Returns the size of the table (number of tags)</p>
<div class="refsect3">
<a name="gtk-text-tag-table-get-size.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>table</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-text-tag-table-get-size.returns"></a><h4>Returns</h4>
<p> number of tags in <em class="parameter"><code>table</code></em>
</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkTextTagTable.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkTextTagTable-struct"></a><h3>GtkTextTagTable</h3>
<pre class="programlisting">typedef struct _GtkTextTagTable GtkTextTagTable;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkTextTagTable.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkTextTagTable-tag-added"></a><h3>The <code class="literal">“tag-added”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a> *texttagtable,
               <a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a>      *arg1,
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)</pre>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkTextTagTable-tag-changed"></a><h3>The <code class="literal">“tag-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a> *texttagtable,
               <a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a>      *arg1,
               <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>         arg2,
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)</pre>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkTextTagTable-tag-removed"></a><h3>The <code class="literal">“tag-removed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkTextTagTable.html" title="GtkTextTagTable"><span class="type">GtkTextTagTable</span></a> *texttagtable,
               <a class="link" href="GtkTextTag.html" title="GtkTextTag"><span class="type">GtkTextTag</span></a>      *arg1,
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>         user_data)</pre>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>

Powered by Pagure 5.13.3

SSH Hostkey/Fingerprint | Documentation