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>GtkSourceGutterRendererText: 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="ch06.html" title="Gutter and Marks">
<link rel="prev" href="GtkSourceGutterRendererPixbuf.html" title="GtkSourceGutterRendererPixbuf">
<link rel="next" href="GtkSourceMark.html" title="GtkSourceMark">
<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="#GtkSourceGutterRendererText.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkSourceGutterRendererText.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GtkSourceGutterRendererText.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="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkSourceGutterRendererPixbuf.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkSourceMark.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSourceGutterRendererText"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceGutterRendererText.top_of_page"></a>GtkSourceGutterRendererText</span></h2>
<p>GtkSourceGutterRendererText — Renders text in the gutter</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.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">
<a class="link" href="GtkSourceGutterRenderer.html" title="GtkSourceGutterRenderer"><span class="returnvalue">GtkSourceGutterRenderer</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSourceGutterRendererText.html#gtk-source-gutter-renderer-text-new" title="gtk_source_gutter_renderer_text_new ()">gtk_source_gutter_renderer_text_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="GtkSourceGutterRendererText.html#gtk-source-gutter-renderer-text-set-markup" title="gtk_source_gutter_renderer_text_set_markup ()">gtk_source_gutter_renderer_text_set_markup</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="GtkSourceGutterRendererText.html#gtk-source-gutter-renderer-text-set-text" title="gtk_source_gutter_renderer_text_set_text ()">gtk_source_gutter_renderer_text_set_text</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="GtkSourceGutterRendererText.html#gtk-source-gutter-renderer-text-measure" title="gtk_source_gutter_renderer_text_measure ()">gtk_source_gutter_renderer_text_measure</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="GtkSourceGutterRendererText.html#gtk-source-gutter-renderer-text-measure-markup" title="gtk_source_gutter_renderer_text_measure_markup ()">gtk_source_gutter_renderer_text_measure_markup</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.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">gchar</span> *</td>
<td class="property_name"><a class="link" href="GtkSourceGutterRendererText.html#GtkSourceGutterRendererText--markup" title="The “markup” property">markup</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="GtkSourceGutterRendererText.html#GtkSourceGutterRendererText--text" title="The “text” property">text</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.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="GtkSourceGutterRendererText.html#GtkSourceGutterRendererText-struct" title="GtkSourceGutterRendererText">GtkSourceGutterRendererText</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="GtkSourceGutterRenderer.html" title="GtkSourceGutterRenderer">GtkSourceGutterRenderer</a>
            <span class="lineart">╰──</span> GtkSourceGutterRendererText
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtksourceview/gtksource.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.description"></a><h2>Description</h2>
<p>A <a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a> can be used to render text in a cell of
<a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a>.</p>
</div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-source-gutter-renderer-text-new"></a><h3>gtk_source_gutter_renderer_text_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceGutterRenderer.html" title="GtkSourceGutterRenderer"><span class="returnvalue">GtkSourceGutterRenderer</span></a> *
gtk_source_gutter_renderer_text_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new <a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a>.</p>
<div class="refsect3">
<a name="gtk-source-gutter-renderer-text-new.returns"></a><h4>Returns</h4>
<p>A <a class="link" href="GtkSourceGutterRenderer.html" title="GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-gutter-renderer-text-set-markup"></a><h3>gtk_source_gutter_renderer_text_set_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_gutter_renderer_text_set_markup
                               (<em class="parameter"><code><a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a> *renderer</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *markup</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> length</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-gutter-renderer-text-set-text"></a><h3>gtk_source_gutter_renderer_text_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_gutter_renderer_text_set_text
                               (<em class="parameter"><code><a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a> *renderer</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> length</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-gutter-renderer-text-measure"></a><h3>gtk_source_gutter_renderer_text_measure ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_gutter_renderer_text_measure
                               (<em class="parameter"><code><a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a> *renderer</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> *width</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> *height</code></em>);</pre>
<p>Measures the text provided using the pango layout used by the
<a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a>.</p>
<div class="refsect3">
<a name="gtk-source-gutter-renderer-text-measure.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>renderer</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>the text to measure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>location to store the width of the text in pixels,
or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>location to store the height of the text in
pixels, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-gutter-renderer-text-measure-markup"></a><h3>gtk_source_gutter_renderer_text_measure_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_source_gutter_renderer_text_measure_markup
                               (<em class="parameter"><code><a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a> *renderer</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *markup</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> *width</code></em>,
                                <em class="parameter"><code><span class="type">gint</span> *height</code></em>);</pre>
<p>Measures the pango markup provided using the pango layout used by the
<a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a>.</p>
<div class="refsect3">
<a name="gtk-source-gutter-renderer-text-measure-markup.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>renderer</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSourceGutterRendererText.html" title="GtkSourceGutterRendererText"><span class="type">GtkSourceGutterRendererText</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>markup</p></td>
<td class="parameter_description"><p>the pango markup to measure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>location to store the width of the text in pixels,
or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>location to store the height of the text in
pixels, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSourceGutterRendererText-struct"></a><h3>GtkSourceGutterRendererText</h3>
<pre class="programlisting">typedef struct _GtkSourceGutterRendererText GtkSourceGutterRendererText;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSourceGutterRendererText--markup"></a><h3>The <code class="literal">“markup”</code> property</h3>
<pre class="programlisting">  “markup”                   <span class="type">gchar</span> *</pre>
<p>The markup.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceGutterRendererText--text"></a><h3>The <code class="literal">“text”</code> property</h3>
<pre class="programlisting">  “text”                     <span class="type">gchar</span> *</pre>
<p>The text.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceGutterRendererText.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkSourceGutterRenderer.html" title="GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a>, <a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28.1</div>
</body>
</html>