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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkruler">
<refnamediv>
<refname>gtk.Ruler</refname>
<refpurpose>a base class for horizontal or vertical rulers</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Ruler</classname></ooclass>
<ooclass><classname><link
linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkruler--set-metric">set_metric</link></methodname>
<methodparam><parameter
role="keyword">metric</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkruler--set-range">set_range</link></methodname>
<methodparam><parameter
role="keyword">lower</parameter></methodparam>
<methodparam><parameter
role="keyword">upper</parameter></methodparam>
<methodparam><parameter
role="keyword">position</parameter></methodparam>
<methodparam><parameter
role="keyword">max_size</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkruler--draw-ticks">draw_ticks</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkruler--draw-pos">draw_pos</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkruler--get-metric">get_metric</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkruler--get-range">get_range</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkruler">gtk.Ruler</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkruler"><classname>gtk.Ruler</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkruler">
<title>gtk.Ruler Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"lower"</entry>
<entry>Read-Write</entry>
<entry>the lower limit of the ruler</entry>
</row>
<row valign="top">
<entry>"max-size"</entry>
<entry>Read-Write</entry>
<entry>the maximum size of the ruler</entry>
</row>
<row valign="top">
<entry>"metric"</entry>
<entry>Read-Write</entry>
<entry>The metric used for the ruler. This property is available
in GTK+ 2.8 and above.</entry>
</row>
<row valign="top">
<entry>"position"</entry>
<entry>Read-Write</entry>
<entry>the position of the mark on the ruler</entry>
</row>
<row valign="top">
<entry>"upper"</entry>
<entry>Read-Write</entry>
<entry>the upper limit of the ruler</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkruler">
<title>gtk.Ruler Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
</refsect1>
<refsect1 id="signal-prototypes-gtkruler">
<title>gtk.Ruler Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<note>
<para>This widget is considered too specialized or little-used for
PyGTK and GTK+, and will in the future be moved to some other package. If
your application needs this widget, feel free to use it, as the widget does
work and is useful in some applications; it's just not of general interest.
However, it will eventually move out of the PyGTK and GTK+
distribution.</para>
</note>
<para>The <link
linkend="class-gtkruler"><classname>gtk.Ruler</classname></link> widget is a
base class for horizontal and vertical rulers. Rulers are used to show the
mouse pointer's location in a window. Within the ruler a small triangle
indicates the location of the mouse relative to the horizontal or vertical
ruler. See <link
linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link> to learn
about horizontal rulers. See <link
linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link> to learn
about vertical rulers.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkruler--set-metric">
<title>gtk.Ruler.set_metric</title>
<programlisting><methodsynopsis language="python">
<methodname>set_metric</methodname>
<methodparam><parameter
role="keyword">metric</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">metric</parameter> :</term>
<listitem><simpara>the measurement units</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_metric</methodname>() method sets the
measurement units of the ruler to the value specified by
<parameter>metric</parameter>. Available units are
<literal>gtk.PIXELS</literal>, <literal>gtk.INCHES</literal>, or
<literal>gtk.CENTIMETERS</literal>. The default unit of measurement is
<literal>gtk.PIXELS</literal>.</para>
</refsect2>
<refsect2 id="method-gtkruler--set-range">
<title>gtk.Ruler.set_range</title>
<programlisting><methodsynopsis language="python">
<methodname>set_range</methodname>
<methodparam><parameter role="keyword">lower</parameter></methodparam>
<methodparam><parameter role="keyword">upper</parameter></methodparam>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">max_size</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">lower</parameter> :</term>
<listitem><simpara>the upper limit of the ruler</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">upper</parameter> :</term>
<listitem><simpara>the lower limit of the ruler</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>the position of the mark on the ruler</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">max_size</parameter> :</term>
<listitem><simpara>the maximum size of the rule</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_range</methodname>() method sets the range
of the ruler to the values specified by <parameter>lower</parameter>,
<parameter>upper</parameter>, <parameter>position</parameter> and
<parameter>max_size</parameter> (all values are floats).</para>
</refsect2>
<refsect2 id="method-gtkruler--draw-ticks">
<title>gtk.Ruler.draw_ticks</title>
<programlisting><methodsynopsis language="python">
<methodname>draw_ticks</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<para>The <methodname>draw_ticks</methodname>() method is overridden
by the <link
linkend="class-gtkruler"><classname>gtk.Ruler</classname></link> subclasses
(<link linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link>
and <link
linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>) to draw
the tick marks on the ruler. This method is not used by applications.</para>
</refsect2>
<refsect2 id="method-gtkruler--draw-pos">
<title>gtk.Ruler.draw_pos</title>
<programlisting><methodsynopsis language="python">
<methodname>draw_pos</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<para>The <methodname>draw_pos</methodname>() method is overridden by
the <link linkend="class-gtkruler"><classname>gtk.Ruler</classname></link>
subclasses (<link
linkend="class-gtkhruler"><classname>gtk.HRuler</classname></link> and <link
linkend="class-gtkvruler"><classname>gtk.VRuler</classname></link>) to draw
the position mark on the ruler. This method is not used by
applications.</para>
</refsect2>
<refsect2 id="method-gtkruler--get-metric">
<title>gtk.Ruler.get_metric</title>
<programlisting><methodsynopsis language="python">
<methodname>get_metric</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the measurement units currently used for the
ruler</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_metric</methodname>() method returns the
units used for a <link
linkend="class-gtkruler"><classname>gtk.Ruler</classname></link>. See the
<link
linkend="method-gtkruler--set-metric"><methodname>set_metric</methodname>()</link>
method.</para>
</refsect2>
<refsect2 id="method-gtkruler--get-range">
<title>gtk.Ruler.get_range</title>
<programlisting><methodsynopsis language="python">
<methodname>get_range</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis>> :</term>
<listitem><simpara>a tuple containing: the lower limit of the
ruler, the upper limit of the ruler, the current position of the mark on the
ruler and the maximum size of the ruler used when calculating the space to
leave for the text.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_range</methodname>() method returns a tuple
containing the values indicating the range and current position of a <link
linkend="class-gtkruler"><classname>gtk.Ruler</classname></link>. See the
<link
linkend="method-gtkruler--set-range"><methodname>set_range</methodname>()</link>
method.</para>
</refsect2>
</refsect1>
</refentry>
|
