/usr/share/gtk-doc/html/buzztard-edit/BtRuler.html is in libbuzztard-dev 0.6.0-1.1.
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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtRuler</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztard Bt-Edit Reference Manual">
<link rel="up" href="ch04.html" title="Widget Class Reference">
<link rel="prev" href="BtPatternEditor.html" title="BtPatternEditor">
<link rel="next" href="BtWaveformViewer.html" title="BtWaveformViewer">
<meta name="generator" content="GTK-Doc V1.19 (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="BtPatternEditor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.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">Buzztard Bt-Edit Reference Manual</th>
<td><a accesskey="n" href="BtWaveformViewer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#BtRuler.synopsis" class="shortcut">Top</a>
|
<a href="#BtRuler.description" class="shortcut">Description</a>
|
<a href="#BtRuler.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#BtRuler.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#BtRuler.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="BtRuler"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtRuler.top_of_page"></a>BtRuler</span></h2>
<p>BtRuler — A ruler widget</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="BtRuler.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include "bt-edit.h"
struct <a class="link" href="BtRuler.html#BtRuler-struct" title="struct BtRuler">BtRuler</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="BtRuler.html#gtk-vumeter-new" title="gtk_vumeter_new ()">gtk_vumeter_new</a> (<em class="parameter"><code><span class="type">gboolean</span> vertical</code></em>);
<span class="returnvalue">void</span> <a class="link" href="BtRuler.html#bt-ruler-set-metric" title="bt_ruler_set_metric ()">bt_ruler_set_metric</a> (<em class="parameter"><code><a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a> *ruler</code></em>,
<em class="parameter"><code><span class="type">GtkMetricType</span> metric</code></em>);
<span class="returnvalue">GtkMetricType</span> <a class="link" href="BtRuler.html#bt-ruler-get-metric" title="bt_ruler_get_metric ()">bt_ruler_get_metric</a> (<em class="parameter"><code><a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a> *ruler</code></em>);
<span class="returnvalue">void</span> <a class="link" href="BtRuler.html#bt-ruler-set-range" title="bt_ruler_set_range ()">bt_ruler_set_range</a> (<em class="parameter"><code><a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a> *ruler</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> lower</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> upper</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> position</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> max_size</code></em>);
<span class="returnvalue">void</span> <a class="link" href="BtRuler.html#bt-ruler-get-range" title="bt_ruler_get_range ()">bt_ruler_get_range</a> (<em class="parameter"><code><a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a> *ruler</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> *lower</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> *upper</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> *position</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> *max_size</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="BtRuler.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----BtRuler
</pre>
</div>
<div class="refsect1">
<a name="BtRuler.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
BtRuler implements
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
</div>
<div class="refsect1">
<a name="BtRuler.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="BtRuler.html#BtRuler--draw-pos" title='The "draw-pos" property'>draw-pos</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="BtRuler.html#BtRuler--lower" title='The "lower" property'>lower</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="BtRuler.html#BtRuler--max-size" title='The "max-size" property'>max-size</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="BtRuler.html#BtRuler--metric" title='The "metric" property'>metric</a>" <span class="type">GtkMetricType</span> : Read / Write
"<a class="link" href="BtRuler.html#BtRuler--position" title='The "position" property'>position</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="BtRuler.html#BtRuler--upper" title='The "upper" property'>upper</a>" <span class="type">gdouble</span> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="BtRuler.description"></a><h2>Description</h2>
<p>
The Ruler widget is utilized around other widgets such as a text widget or a
graph. The ruler is used to show the location of the mouse on the window and
to show the size of the window in specified units. The available units of
measurement are GTK_PIXELS, GTK_INCHES and GTK_CENTIMETERS.
GTK_PIXELS is the default unit of measurement. The ruler widget can be
oriented vertically or horizontally.
</p>
</div>
<div class="refsect1">
<a name="BtRuler.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BtRuler-struct"></a><h3>struct BtRuler</h3>
<pre class="programlisting">struct BtRuler;</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-vumeter-new"></a><h3>gtk_vumeter_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gtk_vumeter_new (<em class="parameter"><code><span class="type">gboolean</span> vertical</code></em>);</pre>
<p>
Creates a new VUMeter widget.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vertical</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> for a vertical VUMeter, <code class="literal">FALSE</code> for horizontal VUMeter.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <span class="type">GtkWidget</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-ruler-set-metric"></a><h3>bt_ruler_set_metric ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bt_ruler_set_metric (<em class="parameter"><code><a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a> *ruler</code></em>,
<em class="parameter"><code><span class="type">GtkMetricType</span> metric</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="bt-ruler-get-metric"></a><h3>bt_ruler_get_metric ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkMetricType</span> bt_ruler_get_metric (<em class="parameter"><code><a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a> *ruler</code></em>);</pre>
<p>
Gets the units used for a <a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a>. See <a class="link" href="BtRuler.html#bt-ruler-set-metric" title="bt_ruler_set_metric ()"><code class="function">bt_ruler_set_metric()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ruler</code></em> :</span></p></td>
<td>a <a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the units currently used for <em class="parameter"><code>ruler</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-ruler-set-range"></a><h3>bt_ruler_set_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bt_ruler_set_range (<em class="parameter"><code><a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a> *ruler</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> lower</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> upper</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> position</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> max_size</code></em>);</pre>
<p>
This sets the range of the ruler.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ruler</code></em> :</span></p></td>
<td>the gtkruler</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lower</code></em> :</span></p></td>
<td>the lower limit of the ruler</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>upper</code></em> :</span></p></td>
<td>the upper limit of the ruler</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>the mark on the ruler</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_size</code></em> :</span></p></td>
<td>the maximum size of the ruler used when calculating the space to
leave for the text</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bt-ruler-get-range"></a><h3>bt_ruler_get_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bt_ruler_get_range (<em class="parameter"><code><a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a> *ruler</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> *lower</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> *upper</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> *position</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> *max_size</code></em>);</pre>
<p>
Retrieves values indicating the range and current position of a <a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a>.
See <a class="link" href="BtRuler.html#bt-ruler-set-range" title="bt_ruler_set_range ()"><code class="function">bt_ruler_set_range()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ruler</code></em> :</span></p></td>
<td>a <a class="link" href="BtRuler.html" title="BtRuler"><span class="type">BtRuler</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lower</code></em> :</span></p></td>
<td>location to store lower limit of the ruler, or <code class="literal">NULL</code>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>upper</code></em> :</span></p></td>
<td>location to store upper limit of the ruler, or <code class="literal">NULL</code>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>location to store the current position of the mark on the ruler, or <code class="literal">NULL</code>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_size</code></em> :</span></p></td>
<td>location to store the maximum size of the ruler used when calculating
the space to leave for the text, or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="BtRuler.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtRuler--draw-pos"></a><h3>The <code class="literal">"draw-pos"</code> property</h3>
<pre class="programlisting"> "draw-pos" <span class="type">gboolean</span> : Read / Write</pre>
<p>Wheter the position should be marked at the ruler.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="BtRuler--lower"></a><h3>The <code class="literal">"lower"</code> property</h3>
<pre class="programlisting"> "lower" <span class="type">gdouble</span> : Read / Write</pre>
<p>Lower limit of ruler.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="BtRuler--max-size"></a><h3>The <code class="literal">"max-size"</code> property</h3>
<pre class="programlisting"> "max-size" <span class="type">gdouble</span> : Read / Write</pre>
<p>Maximum size of the ruler.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="BtRuler--metric"></a><h3>The <code class="literal">"metric"</code> property</h3>
<pre class="programlisting"> "metric" <span class="type">GtkMetricType</span> : Read / Write</pre>
<p>The metric used for the ruler.</p>
<p>Default value: GTK_PIXELS</p>
</div>
<hr>
<div class="refsect2">
<a name="BtRuler--position"></a><h3>The <code class="literal">"position"</code> property</h3>
<pre class="programlisting"> "position" <span class="type">gdouble</span> : Read / Write</pre>
<p>Position of mark on the ruler.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="BtRuler--upper"></a><h3>The <code class="literal">"upper"</code> property</h3>
<pre class="programlisting"> "upper" <span class="type">gdouble</span> : Read / Write</pre>
<p>Upper limit of ruler.</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|