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>GtkSourceTag: GtkSourceView 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual">
<link rel="up" href="ch09.html" title="Other">
<link rel="prev" href="GtkSourceSpaceDrawer.html" title="GtkSourceSpaceDrawer">
<link rel="next" href="GtkSourceUndoManager.html" title="GtkSourceUndoManager">
<meta name="generator" content="GTK-Doc V1.28.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="#GtkSourceTag.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkSourceTag.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GtkSourceTag.properties" class="shortcut">Properties</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="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkSourceSpaceDrawer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkSourceUndoManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSourceTag"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceTag.top_of_page"></a>GtkSourceTag</span></h2>
<p>GtkSourceTag — A tag that can be applied to text in a GtkSourceBuffer</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSourceTag.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">GtkTextTag</span> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceTag.html#gtk-source-tag-new" title="gtk_source_tag_new ()">gtk_source_tag_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceTag.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkSourceTag.html#GtkSourceTag--draw-spaces" title="The “draw-spaces” property">draw-spaces</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkSourceTag.html#GtkSourceTag--draw-spaces-set" title="The “draw-spaces-set” property">draw-spaces-set</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceTag.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="GtkSourceTag.html#GtkSourceTag-struct" title="GtkSourceTag">GtkSourceTag</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceTag.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GtkTextTag
        <span class="lineart">╰──</span> GtkSourceTag
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceTag.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtksourceview/gtksource.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceTag.description"></a><h2>Description</h2>
<p><a class="link" href="GtkSourceTag.html" title="GtkSourceTag"><span class="type">GtkSourceTag</span></a> is a subclass of <span class="type">GtkTextTag</span> that adds properties useful for
the GtkSourceView library.</p>
<p>If, for a certain tag, <span class="type">GtkTextTag</span> is sufficient, it's better that you create
a <span class="type">GtkTextTag</span>, not a <a class="link" href="GtkSourceTag.html" title="GtkSourceTag"><span class="type">GtkSourceTag</span></a>.</p>
</div>
<div class="refsect1">
<a name="GtkSourceTag.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-source-tag-new"></a><h3>gtk_source_tag_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkTextTag</span> *
gtk_source_tag_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Creates a <a class="link" href="GtkSourceTag.html" title="GtkSourceTag"><span class="type">GtkSourceTag</span></a>. Configure the tag using object arguments,
i.e. using <code class="function">g_object_set()</code>.</p>
<p>For usual cases, <a class="link" href="GtkSourceBuffer.html#gtk-source-buffer-create-source-tag" title="gtk_source_buffer_create_source_tag ()"><code class="function">gtk_source_buffer_create_source_tag()</code></a> is more convenient to
use.</p>
<div class="refsect3">
<a name="gtk-source-tag-new.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>name</p></td>
<td class="parameter_description"><p>tag name, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-source-tag-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkSourceTag.html" title="GtkSourceTag"><span class="type">GtkSourceTag</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-20.html#api-index-3.20">3.20</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceTag.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSourceTag-struct"></a><h3>GtkSourceTag</h3>
<pre class="programlisting">typedef struct _GtkSourceTag GtkSourceTag;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceTag.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSourceTag--draw-spaces"></a><h3>The <code class="literal">“draw-spaces”</code> property</h3>
<pre class="programlisting">  “draw-spaces”              <span class="type">gboolean</span></pre>
<p>Whether to draw white spaces. This property takes precedence over the value
defined by the GtkSourceSpaceDrawer's <a class="link" href="GtkSourceSpaceDrawer.html#GtkSourceSpaceDrawer--matrix" title="The “matrix” property"><span class="type">“matrix”</span></a> property
(only where the tag is applied).</p>
<p>Setting this property also changes <a class="link" href="GtkSourceTag.html#GtkSourceTag--draw-spaces-set" title="The “draw-spaces-set” property"><span class="type">“draw-spaces-set”</span></a> to
<code class="literal">TRUE</code>.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="api-index-3-20.html#api-index-3.20">3.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceTag--draw-spaces-set"></a><h3>The <code class="literal">“draw-spaces-set”</code> property</h3>
<pre class="programlisting">  “draw-spaces-set”          <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="GtkSourceTag.html#GtkSourceTag--draw-spaces" title="The “draw-spaces” property"><span class="type">“draw-spaces”</span></a> property is set and must be
taken into account.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="api-index-3-20.html#api-index-3.20">3.20</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceTag.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkSourceBuffer.html" title="GtkSourceBuffer"><span class="type">GtkSourceBuffer</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28.1</div>
</body>
</html>