4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpRuler</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
8
8
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
9
9
<link rel="prev" href="GimpPreview.html" title="GimpPreview">
10
10
<link rel="next" href="GimpScrolledPreview.html" title="GimpScrolledPreview">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
14
14
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
34
34
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
35
35
<td><a accesskey="n" href="GimpScrolledPreview.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
37
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpRuler.synopsis" class="shortcut">Top</a>
39
<a href="#GimpRuler.description" class="shortcut">Description</a>
41
<a href="#GimpRuler.object-hierarchy" class="shortcut">Object Hierarchy</a>
43
<a href="#GimpRuler.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
45
<a href="#GimpRuler.properties" class="shortcut">Properties</a>
47
<a href="#GimpRuler.style-properties" class="shortcut">Style Properties</a></nobr></td></tr>
37
<tr><td colspan="5" class="shortcuts">
38
<a href="#GimpRuler.synopsis" class="shortcut">Top</a>
40
<a href="#GimpRuler.description" class="shortcut">Description</a>
42
<a href="#GimpRuler.object-hierarchy" class="shortcut">Object Hierarchy</a>
44
<a href="#GimpRuler.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
46
<a href="#GimpRuler.properties" class="shortcut">Properties</a>
48
<a href="#GimpRuler.style-properties" class="shortcut">Style Properties</a>
49
<div class="refentry" lang="en">
51
<div class="refentry" title="GimpRuler">
50
52
<a name="GimpRuler"></a><div class="titlepage"></div>
51
53
<div class="refnamediv"><table width="100%"><tr>
56
58
<td valign="top" align="right"></td>
57
59
</tr></table></div>
58
<div class="refsynopsisdiv">
60
<div class="refsynopsisdiv" title="Synopsis">
59
61
<a name="GimpRuler.synopsis"></a><h2>Synopsis</h2>
60
62
<pre class="synopsis">
61
63
<a class="link" href="GimpRuler.html#GimpRuler-struct" title="GimpRuler">GimpRuler</a>;
63
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
64
>GtkWidget</a>* <a class="link" href="GimpRuler.html#gimp-ruler-new" title="gimp_ruler_new ()">gimp_ruler_new</a> (<a
65
href="/usr/share/gtk-doc/html/gtk/gtk-Standard-Enumerations.html#GtkOrientation"
65
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
66
>GtkWidget</a> * <a class="link" href="GimpRuler.html#gimp-ruler-new" title="gimp_ruler_new ()">gimp_ruler_new</a> (<a
67
href="http://library.gnome.org/devel/gtk/unstable/gtk-Standard-Enumerations.html#GtkOrientation"
66
68
>GtkOrientation</a> orientation);
67
69
void <a class="link" href="GimpRuler.html#gimp-ruler-set-unit" title="gimp_ruler_set_unit ()">gimp_ruler_set_unit</a> (<a class="link" href="GimpRuler.html" title="GimpRuler">GimpRuler</a> *ruler,
110
112
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
111
113
>GInitiallyUnowned</a>
113
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
115
href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html"
116
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
118
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
121
<div class="refsect1" lang="en">
123
<div class="refsect1" title="Implemented Interfaces">
122
124
<a name="GimpRuler.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
124
126
GimpRuler implements
125
AtkImplementorIface and <a
126
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
127
>GtkBuildable</a>.</p>
128
href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable"
129
>GtkBuildable</a> and AtkImplementorIface.</p>
129
<div class="refsect1" lang="en">
131
<div class="refsect1" title="Properties">
130
132
<a name="GimpRuler.properties"></a><h2>Properties</h2>
131
133
<pre class="synopsis">
132
134
"<a class="link" href="GimpRuler.html#GimpRuler--lower" title='The "lower" property'>lower</a>" <a
136
138
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
137
139
>gdouble</a> : Read / Write
138
140
"<a class="link" href="GimpRuler.html#GimpRuler--orientation" title='The "orientation" property'>orientation</a>" <a
139
href="/usr/share/gtk-doc/html/gtk/gtk-Standard-Enumerations.html#GtkOrientation"
141
href="http://library.gnome.org/devel/gtk/unstable/gtk-Standard-Enumerations.html#GtkOrientation"
140
142
>GtkOrientation</a> : Read / Write
141
143
"<a class="link" href="GimpRuler.html#GimpRuler--position" title='The "position" property'>position</a>" <a
142
144
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
149
151
>gdouble</a> : Read / Write
152
<div class="refsect1" lang="en">
154
<div class="refsect1" title="Style Properties">
153
155
<a name="GimpRuler.style-properties"></a><h2>Style Properties</h2>
154
156
<pre class="synopsis">
155
"<a class="link" href="GimpRuler.html#GimpRuler--font-scale" title='The "font-scale" style property'>font-scale</a>" <a
157
"<a class="link" href="GimpRuler.html#GimpRuler--s-font-scale" title='The "font-scale" style property'>font-scale</a>" <a
156
158
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
157
159
>gdouble</a> : Read
160
<div class="refsect1" lang="en">
162
<div class="refsect1" title="Description">
161
163
<a name="GimpRuler.description"></a><h2>Description</h2>
166
<div class="refsect1" lang="en">
167
<div class="refsect1" title="Details">
167
168
<a name="GimpRuler.details"></a><h2>Details</h2>
168
<div class="refsect2" lang="en">
169
<div class="refsect2" title="GimpRuler">
169
170
<a name="GimpRuler-struct"></a><h3>GimpRuler</h3>
170
171
<pre class="programlisting">typedef struct _GimpRuler GimpRuler;</pre>
176
<div class="refsect2" lang="en">
176
<div class="refsect2" title="gimp_ruler_new ()">
177
177
<a name="gimp-ruler-new"></a><h3>gimp_ruler_new ()</h3>
178
178
<pre class="programlisting"><a
179
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
180
>GtkWidget</a>* gimp_ruler_new (<a
181
href="/usr/share/gtk-doc/html/gtk/gtk-Standard-Enumerations.html#GtkOrientation"
179
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
180
>GtkWidget</a> * gimp_ruler_new (<a
181
href="http://library.gnome.org/devel/gtk/unstable/gtk-Standard-Enumerations.html#GtkOrientation"
182
182
>GtkOrientation</a> orientation);</pre>
184
184
Creates a new ruler.</p>
188
187
<div class="variablelist"><table border="0">
189
188
<col align="left" valign="top">
204
<p class="since">Since GIMP 2.8
203
<p class="since">Since GIMP 2.8</p>
208
<div class="refsect2" lang="en">
206
<div class="refsect2" title="gimp_ruler_set_unit ()">
209
207
<a name="gimp-ruler-set-unit"></a><h3>gimp_ruler_set_unit ()</h3>
210
208
<pre class="programlisting">void gimp_ruler_set_unit (<a class="link" href="GimpRuler.html" title="GimpRuler">GimpRuler</a> *ruler,
212
210
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
213
211
>GimpUnit</a> unit);</pre>
217
214
<div class="variablelist"><table border="0">
218
215
<col align="left" valign="top">
226
223
<td><p><span class="term"><em class="parameter"><code>unit</code></em> :</span></p></td>
236
<div class="refsect2" lang="en">
231
<div class="refsect2" title="gimp_ruler_get_unit ()">
237
232
<a name="gimp-ruler-get-unit"></a><h3>gimp_ruler_get_unit ()</h3>
238
233
<pre class="programlisting"><a
239
234
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
262
<p class="since">Since GIMP 2.8
256
<p class="since">Since GIMP 2.8</p>
266
<div class="refsect2" lang="en">
259
<div class="refsect2" title="gimp_ruler_set_position ()">
267
260
<a name="gimp-ruler-set-position"></a><h3>gimp_ruler_set_position ()</h3>
268
261
<pre class="programlisting">void gimp_ruler_set_position (<a class="link" href="GimpRuler.html" title="GimpRuler">GimpRuler</a> *ruler,
292
<p class="since">Since GIMP 2.8
284
<p class="since">Since GIMP 2.8</p>
296
<div class="refsect2" lang="en">
287
<div class="refsect2" title="gimp_ruler_get_position ()">
297
288
<a name="gimp-ruler-get-position"></a><h3>gimp_ruler_get_position ()</h3>
298
289
<pre class="programlisting"><a
299
290
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
322
<p class="since">Since GIMP 2.8
312
<p class="since">Since GIMP 2.8</p>
326
<div class="refsect2" lang="en">
315
<div class="refsect2" title="gimp_ruler_set_range ()">
327
316
<a name="gimp-ruler-set-range"></a><h3>gimp_ruler_set_range ()</h3>
328
317
<pre class="programlisting">void gimp_ruler_set_range (<a class="link" href="GimpRuler.html" title="GimpRuler">GimpRuler</a> *ruler,
369
<p class="since">Since GIMP 2.8
357
<p class="since">Since GIMP 2.8</p>
373
<div class="refsect2" lang="en">
360
<div class="refsect2" title="gimp_ruler_get_range ()">
374
361
<a name="gimp-ruler-get-range"></a><h3>gimp_ruler_get_range ()</h3>
375
362
<pre class="programlisting">void gimp_ruler_get_range (<a class="link" href="GimpRuler.html" title="GimpRuler">GimpRuler</a> *ruler,
386
373
Retrieves values indicating the range and current position of a <a class="link" href="GimpRuler.html" title="GimpRuler"><span class="type">GimpRuler</span></a>.
387
374
See <a class="link" href="GimpRuler.html#gimp-ruler-set-range" title="gimp_ruler_set_range ()"><code class="function">gimp_ruler_set_range()</code></a>.</p>
391
377
<div class="variablelist"><table border="0">
392
378
<col align="left" valign="top">
400
386
<td><p><span class="term"><em class="parameter"><code>lower</code></em> :</span></p></td>
401
387
<td> location to store lower limit of the ruler, or <a
402
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
388
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
403
389
><code class="literal">NULL</code></a>
407
393
<td><p><span class="term"><em class="parameter"><code>upper</code></em> :</span></p></td>
408
394
<td> location to store upper limit of the ruler, or <a
409
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
395
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
410
396
><code class="literal">NULL</code></a>
414
400
<td><p><span class="term"><em class="parameter"><code>max_size</code></em> :</span></p></td>
415
401
<td> location to store the maximum size of the ruler used when
416
402
calculating the space to leave for the text, or <a
417
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
403
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
418
404
><code class="literal">NULL</code></a>.
423
<p class="since">Since GIMP 2.8
427
<div class="refsect1" lang="en">
409
<p class="since">Since GIMP 2.8</p>
412
<div class="refsect1" title="Property Details">
428
413
<a name="GimpRuler.property-details"></a><h2>Property Details</h2>
429
<div class="refsect2" lang="en">
414
<div class="refsect2" title='The "lower" property'>
430
415
<a name="GimpRuler--lower"></a><h3>The <code class="literal">"lower"</code> property</h3>
431
416
<pre class="programlisting"> "lower" <a
432
417
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
435
420
<p>Default value: 0</p>
438
<div class="refsect2" lang="en">
423
<div class="refsect2" title='The "max-size" property'>
439
424
<a name="GimpRuler--max-size"></a><h3>The <code class="literal">"max-size"</code> property</h3>
440
425
<pre class="programlisting"> "max-size" <a
441
426
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
444
429
<p>Default value: 0</p>
447
<div class="refsect2" lang="en">
432
<div class="refsect2" title='The "orientation" property'>
448
433
<a name="GimpRuler--orientation"></a><h3>The <code class="literal">"orientation"</code> property</h3>
449
434
<pre class="programlisting"> "orientation" <a
450
href="/usr/share/gtk-doc/html/gtk/gtk-Standard-Enumerations.html#GtkOrientation"
435
href="http://library.gnome.org/devel/gtk/unstable/gtk-Standard-Enumerations.html#GtkOrientation"
451
436
>GtkOrientation</a> : Read / Write</pre>
452
437
<p>The orientation of the ruler.</p>
453
438
<p>Default value: GTK_ORIENTATION_HORIZONTAL</p>
456
<div class="refsect2" lang="en">
441
<div class="refsect2" title='The "position" property'>
457
442
<a name="GimpRuler--position"></a><h3>The <code class="literal">"position"</code> property</h3>
458
443
<pre class="programlisting"> "position" <a
459
444
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
462
447
<p>Default value: 0</p>
465
<div class="refsect2" lang="en">
450
<div class="refsect2" title='The "unit" property'>
466
451
<a name="GimpRuler--unit"></a><h3>The <code class="literal">"unit"</code> property</h3>
467
452
<pre class="programlisting"> "unit" <a
468
453
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
472
457
<p>Default value: 0</p>
475
<div class="refsect2" lang="en">
460
<div class="refsect2" title='The "upper" property'>
476
461
<a name="GimpRuler--upper"></a><h3>The <code class="literal">"upper"</code> property</h3>
477
462
<pre class="programlisting"> "upper" <a
478
463
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
481
466
<p>Default value: 0</p>
484
<div class="refsect1" lang="en">
469
<div class="refsect1" title="Style Property Details">
485
470
<a name="GimpRuler.style-property-details"></a><h2>Style Property Details</h2>
486
<div class="refsect2" lang="en">
487
<a name="GimpRuler--font-scale"></a><h3>The <code class="literal">"font-scale"</code> style property</h3>
471
<div class="refsect2" title='The "font-scale" style property'>
472
<a name="GimpRuler--s-font-scale"></a><h3>The <code class="literal">"font-scale"</code> style property</h3>
488
473
<pre class="programlisting"> "font-scale" <a
489
474
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
490
475
>gdouble</a> : Read</pre>