/usr/share/gtk-doc/html/gtksourceview-3.0/GtkSourceGutter.html is in libgtksourceview-3.0-doc 3.4.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceGutter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual">
<link rel="up" href="rn01.html" title="API reference">
<link rel="prev" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider">
<link rel="next" href="gtksourceview-3.0-GtkSourceGutterRenderer.html" title="GtkSourceGutterRenderer">
<meta name="generator" content="GTK-Doc V1.18.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="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkSourceCompletionProvider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="rn01.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">GtkSourceView 3 Reference Manual</th>
<td><a accesskey="n" href="gtksourceview-3.0-GtkSourceGutterRenderer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkSourceGutter.synopsis" class="shortcut">Top</a>
|
<a href="#GtkSourceGutter.description" class="shortcut">Description</a>
|
<a href="#GtkSourceGutter.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkSourceGutter.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkSourceGutter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceGutter.top_of_page"></a>GtkSourceGutter</span></h2>
<p>GtkSourceGutter — Gutter object for <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a></p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkSourceGutter.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtksourceview/gtksourcegutter.h>
struct <a class="link" href="GtkSourceGutter.html#GtkSourceGutter-struct" title="struct GtkSourceGutter">GtkSourceGutter</a>;
<span class="returnvalue">GdkWindow</span> * <a class="link" href="GtkSourceGutter.html#gtk-source-gutter-get-window" title="gtk_source_gutter_get_window ()">gtk_source_gutter_get_window</a> (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GtkSourceGutter.html#gtk-source-gutter-insert" title="gtk_source_gutter_insert ()">gtk_source_gutter_insert</a> (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>,
<em class="parameter"><code><a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkSourceGutter.html#gtk-source-gutter-reorder" title="gtk_source_gutter_reorder ()">gtk_source_gutter_reorder</a> (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>,
<em class="parameter"><code><a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkSourceGutter.html#gtk-source-gutter-remove" title="gtk_source_gutter_remove ()">gtk_source_gutter_remove</a> (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>,
<em class="parameter"><code><a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a> *renderer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkSourceGutter.html#gtk-source-gutter-queue-draw" title="gtk_source_gutter_queue_draw ()">gtk_source_gutter_queue_draw</a> (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceGutter.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GtkSourceGutter
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceGutter.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GtkSourceGutter.html#GtkSourceGutter--view" title='The "view" property'>view</a>" <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a>* : Read / Write / Construct Only
"<a class="link" href="GtkSourceGutter.html#GtkSourceGutter--window-type" title='The "window-type" property'>window-type</a>" <span class="type">GtkTextWindowType</span> : Read / Write / Construct Only
"<a class="link" href="GtkSourceGutter.html#GtkSourceGutter--xpad" title='The "xpad" property'>xpad</a>" <span class="type">gint</span> : Read / Write / Construct
"<a class="link" href="GtkSourceGutter.html#GtkSourceGutter--ypad" title='The "ypad" property'>ypad</a>" <span class="type">gint</span> : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceGutter.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> object represents the left and right gutters of the text
view. It is used by <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> to draw the line numbers and category
marks that might be present on a line. By packing additional <a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a>
objects in the gutter, you can extend the gutter with your own custom
drawings.
</p>
<p>
The gutter works very much the same way as cells rendered in a <span class="type">GtkTreeView</span>.
The concept is similar, with the exception that the gutter does not have an
underlying <span class="type">GtkTreeModel</span>. The builtin line number renderer is at position
<a class="link" href="GtkSourceView.html#GTK-SOURCE-VIEW-GUTTER-POSITION-LINES:CAPS"><span class="type">GTK_SOURCE_VIEW_GUTTER_POSITION_LINES</span></a> (-30) and the marks renderer is at
<a class="link" href="GtkSourceView.html#GTK-SOURCE-VIEW-GUTTER-POSITION-MARKS:CAPS"><span class="type">GTK_SOURCE_VIEW_GUTTER_POSITION_MARKS</span></a> (-20). You can use these values to
position custom renderers accordingly.
</p>
</div>
<div class="refsect1">
<a name="GtkSourceGutter.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkSourceGutter-struct"></a><h3>struct GtkSourceGutter</h3>
<pre class="programlisting">struct GtkSourceGutter;</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-gutter-get-window"></a><h3>gtk_source_gutter_get_window ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkWindow</span> * gtk_source_gutter_get_window (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>);</pre>
<p>
Get the <span class="type">GdkWindow</span> of the gutter. The window will only be available when the
gutter has at least one, non-zero width, cell renderer packed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gutter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">GdkWindow</span> of the gutter, or <code class="literal">NULL</code>
if the gutter has no window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-gutter-insert"></a><h3>gtk_source_gutter_insert ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_source_gutter_insert (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>,
<em class="parameter"><code><a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre>
<p>
Insert <em class="parameter"><code>renderer</code></em> into the gutter. If <em class="parameter"><code>renderer</code></em> is yet unowned then gutter
claims its ownership. Otherwise just increases renderer's reference count.
<em class="parameter"><code>renderer</code></em> cannot be already inserted to another gutter.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gutter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>renderer</code></em> :</span></p></td>
<td>a gutter renderer (must inherit from <a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a>).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the renderer position.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if operation succeeded. Otherwise <code class="literal">FALSE</code>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-gutter-reorder"></a><h3>gtk_source_gutter_reorder ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_gutter_reorder (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>,
<em class="parameter"><code><a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a> *renderer</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre>
<p>
Reorders <em class="parameter"><code>renderer</code></em> in <em class="parameter"><code>gutter</code></em> to new <em class="parameter"><code>position</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gutter</code></em> :</span></p></td>
<td>a <a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>renderer</code></em> :</span></p></td>
<td>a <span class="type">GtkCellRenderer</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the new renderer position.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-gutter-remove"></a><h3>gtk_source_gutter_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_gutter_remove (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>,
<em class="parameter"><code><a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a> *renderer</code></em>);</pre>
<p>
Removes <em class="parameter"><code>renderer</code></em> from <em class="parameter"><code>gutter</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gutter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>renderer</code></em> :</span></p></td>
<td>a <a class="link" href="gtksourceview-3.0-GtkSourceGutterRenderer.html#GtkSourceGutterRenderer" title="struct GtkSourceGutterRenderer"><span class="type">GtkSourceGutterRenderer</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-gutter-queue-draw"></a><h3>gtk_source_gutter_queue_draw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_gutter_queue_draw (<em class="parameter"><code><a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a> *gutter</code></em>);</pre>
<p>
Invalidates the drawable area of the gutter. You can use this to force a
redraw of the gutter if something has changed and needs to be redrawn.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>gutter</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceGutter.html" title="GtkSourceGutter"><span class="type">GtkSourceGutter</span></a>.</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.8</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceGutter.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSourceGutter--view"></a><h3>The <code class="literal">"view"</code> property</h3>
<pre class="programlisting"> "view" <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a>* : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> of the gutter
</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceGutter--window-type"></a><h3>The <code class="literal">"window-type"</code> property</h3>
<pre class="programlisting"> "window-type" <span class="type">GtkTextWindowType</span> : Read / Write / Construct Only</pre>
<p>
The text window type on which the window is placed
</p>
<p>Default value: GTK_TEXT_WINDOW_PRIVATE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceGutter--xpad"></a><h3>The <code class="literal">"xpad"</code> property</h3>
<pre class="programlisting"> "xpad" <span class="type">gint</span> : Read / Write / Construct</pre>
<p>The x-padding.</p>
<p>Allowed values: >= G_MAXULONG</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceGutter--ypad"></a><h3>The <code class="literal">"ypad"</code> property</h3>
<pre class="programlisting"> "ypad" <span class="type">gint</span> : Read / Write / Construct</pre>
<p>The y-padding.</p>
<p>Allowed values: >= G_MAXULONG</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceGutter.see-also"></a><h2>See Also</h2>
<a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|