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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::Ruler Class Reference</h1>A GtkRuler C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ruler_8hh-source.html">gfc/gtk/ruler.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::Ruler:
<p><center><img src="classGFC_1_1Gtk_1_1Ruler.png" usemap="#GFC::Gtk::Ruler_map" border="0" alt=""></center>
<map name="GFC::Gtk::Ruler_map">
<area href="classGFC_1_1Gtk_1_1Widget.html" alt="GFC::Gtk::Widget" shape="rect" coords="73,224,210,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,137,192">
<area href="classGFC_1_1Atk_1_1Implementor.html" alt="GFC::Atk::Implementor" shape="rect" coords="147,168,284,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,137,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="147,112,284,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,137,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="147,56,284,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,137,24">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="147,0,284,24">
<area href="classGFC_1_1Gtk_1_1HRuler.html" alt="GFC::Gtk::HRuler" shape="rect" coords="0,336,137,360">
<area href="classGFC_1_1Gtk_1_1VRuler.html" alt="GFC::Gtk::VRuler" shape="rect" coords="147,336,284,360">
</map>
<a href="classGFC_1_1Gtk_1_1Ruler-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z748_0" doxytag="GFC::Gtk::Ruler::gtk_ruler" ></a>
GtkRuler * <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z748_0">gtk_ruler</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkRuler structure. <br></dl><li><a class="anchor" name="z748_1" doxytag="GFC::Gtk::Ruler::operator GtkRuler *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z748_1">operator GtkRuler *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html">Ruler</a> to a GtkRuler pointer. <br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a327">MetricType</a> <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z748_2">get_metric</a> () const
<dl class="el"><dd class="mdescRight">Gets the units used for a <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html">Ruler</a> (see gtk_ruler_set_metric()). <a href="#z748_2"></a><br></dl><li><a class="anchor" name="z748_3" doxytag="GFC::Gtk::Ruler::get_lower" ></a>
double <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z748_3">get_lower</a> () const
<dl class="el"><dd class="mdescRight">Gets the lower limit of the ruler. <br></dl><li><a class="anchor" name="z748_4" doxytag="GFC::Gtk::Ruler::get_upper" ></a>
double <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z748_4">get_upper</a> () const
<dl class="el"><dd class="mdescRight">Gets the upper limit of the ruler. <br></dl><li><a class="anchor" name="z748_5" doxytag="GFC::Gtk::Ruler::get_position" ></a>
double <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z748_5">get_position</a> () const
<dl class="el"><dd class="mdescRight">Gets the current position of the mark on the ruler. <br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z748_6">get_range</a> (double *lower, double *upper, double *position, double *max_size=0)
<dl class="el"><dd class="mdescRight">Retrieves values indicating the range and current position of the ruler (see <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z749_1">set_range()</a>). <a href="#z748_6"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z749_0">set_metric</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a327">MetricType</a> metric=PIXELS)
<dl class="el"><dd class="mdescRight">Sets the ruler to the units defined. <a href="#z749_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z749_1">set_range</a> (double lower, double upper, double position, double max_size)
<dl class="el"><dd class="mdescRight">Sets the range of the ruler using <em>lower</em>, <em>upper</em>, <em>position</em>, and <em>max_size</em>. <a href="#z749_1"></a><br></dl><li><a class="anchor" name="z749_2" doxytag="GFC::Gtk::Ruler::draw_ticks" ></a>
void <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z749_2">draw_ticks</a> ()
<dl class="el"><dd class="mdescRight">Draws the tick marks on the ruler. <br></dl><li><a class="anchor" name="z749_3" doxytag="GFC::Gtk::Ruler::draw_pos" ></a>
void <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z749_3">draw_pos</a> ()
<dl class="el"><dd class="mdescRight">Draws the position mark on the ruler. <br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z747_0" doxytag="GFC::Gtk::Ruler::Ruler" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z747_0">Ruler</a> ()
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html">Ruler</a>. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z747_1">Ruler</a> (GtkRuler *ruler, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html">Ruler</a> from an existing GtkRuler. <a href="#z747_1"></a><br></dl><li><a class="anchor" name="z747_2" doxytag="GFC::Gtk::Ruler::~Ruler" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z747_2">~Ruler</a> ()=0
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkRuler C++ wrapper class.
<p>
The <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html">Ruler</a> widget is a base class for horizontal and vertical rulers. Rulers are used to show the mouse pointer's location in a window. The ruler can either be horizontal or vertical on the window. Within the ruler a small triangle indicates the location of the mouse relative to the horizontal or vertical ruler. See <a class="el" href="classGFC_1_1Gtk_1_1HRuler.html">HRuler</a> to learn how to create a new horizontal ruler. See <a class="el" href="classGFC_1_1Gtk_1_1VRuler.html">VRuler</a> to learn how to create a new vertical ruler.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z747_1" doxytag="GFC::Gtk::Ruler::Ruler" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::Ruler::Ruler </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkRuler * </td>
<td class="mdname" nowrap> <em>ruler</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html">Ruler</a> from an existing GtkRuler.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>ruler</em> </td><td>A pointer to a GtkRuler. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>ruler</em> can be a newly created GtkRuler or an existing GtkRuler (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z748_2" doxytag="GFC::Gtk::Ruler::get_metric" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceGFC_1_1Gtk.html#a327">MetricType</a> GFC::Gtk::Ruler::get_metric </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the units used for a <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html">Ruler</a> (see gtk_ruler_set_metric()).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The units currently used for the ruler. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z748_6" doxytag="GFC::Gtk::Ruler::get_range" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Ruler::get_range </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double * </td>
<td class="mdname" nowrap> <em>lower</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double * </td>
<td class="mdname" nowrap> <em>upper</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double * </td>
<td class="mdname" nowrap> <em>position</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double * </td>
<td class="mdname" nowrap> <em>max_size</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves values indicating the range and current position of the ruler (see <a class="el" href="classGFC_1_1Gtk_1_1Ruler.html#z749_1">set_range()</a>).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>lower</em> </td><td>The location to store lower limit of the ruler, or null. </td></tr>
<tr><td></td><td valign=top><em>upper</em> </td><td>The location to store upper limit of the ruler, or null. </td></tr>
<tr><td></td><td valign=top><em>position</em> </td><td>The location to store the current position of the mark on the ruler, or null. </td></tr>
<tr><td></td><td valign=top><em>max_size</em> </td><td>The location to store the maximum size of the ruler used when calculating the space to leave for the text, or null. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z749_0" doxytag="GFC::Gtk::Ruler::set_metric" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Ruler::set_metric </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a327">MetricType</a> </td>
<td class="mdname1" valign="top" nowrap> <em>metric</em> = <code>PIXELS</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the ruler to the units defined.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>metric</em> </td><td>The unit of measurement.</td></tr>
</table>
</dl>
<br>
Available units are PIXELS, INCHES, or CENTIMETERS. The default unit of measurement is PIXELS. </td>
</tr>
</table>
<a class="anchor" name="z749_1" doxytag="GFC::Gtk::Ruler::set_range" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Ruler::set_range </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname" nowrap> <em>lower</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>upper</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>position</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>max_size</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the range of the ruler using <em>lower</em>, <em>upper</em>, <em>position</em>, and <em>max_size</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>lower</em> </td><td>The upper limit of the ruler. </td></tr>
<tr><td></td><td valign=top><em>upper</em> </td><td>The lower limit of the ruler. </td></tr>
<tr><td></td><td valign=top><em>position</em> </td><td>The mark on the ruler. </td></tr>
<tr><td></td><td valign=top><em>max_size</em> </td><td>The maximum size of the ruler. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ruler_8hh-source.html">ruler.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:41 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
