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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
|
<?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-gtkscale">
<refnamediv>
<refname>gtk.Scale</refname>
<refpurpose>a base class for the scale widgets.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Scale</classname></ooclass>
<ooclass><classname><link
linkend="class-gtkrange">gtk.Range</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkscale--set-digits">set_digits</link></methodname>
<methodparam><parameter
role="keyword">digits</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkscale--get-digits">get_digits</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkscale--set-draw-value">set_draw_value</link></methodname>
<methodparam><parameter
role="keyword">draw_value</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkscale--get-draw-value">get_draw_value</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkscale--set-value-pos">set_value_pos</link></methodname>
<methodparam><parameter role="keyword">pos</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkscale--get-value-pos">get_value_pos</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkscale--get-layout">get_layout</link></methodname>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkscale--get-layout-offsets">get_layout_offsets</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkscale--add-mark">add_mark</link></methodname>
<methodparam><parameter role="keyword">value</parameter></methodparam>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">markup</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkscale--clear-marks">clear_marks</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-gtkrange">gtk.Range</link>
+-- <link linkend="class-gtkscale">gtk.Scale</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkscale"><classname>gtk.Scale</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkscale">
<title>gtk.Scale Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkrange">gtk.Range 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>"digits"</entry>
<entry>Read-Write</entry>
<entry>The number of decimal places that are displayed in the
value</entry>
</row>
<row valign="top">
<entry>"draw-value"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal> the current value is
displayed as a string next to the slider</entry>
</row>
<row valign="top">
<entry>"value-pos"</entry>
<entry>Read-Write</entry>
<entry>The position in which the current value is displayed:
<literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
<literal>gtk.POS_TOP</literal> or <literal>gtk.POS_BOTTOM</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkscale">
<title>gtk.Scale Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<para><link linkend="style-properties-gtkrange">gtk.Range Style 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>"slider-length"</entry>
<entry>Read</entry>
<entry>The length of scale's slider</entry>
</row>
<row valign="top">
<entry>"value-spacing"</entry>
<entry>Read</entry>
<entry>The space between value text and the slider or trough
area</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkscale">
<title>gtk.Scale 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>
<para><link linkend="signal-prototypes-gtkrange">gtk.Range Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link
linkend="signal-gtkscale--format-value">format-value</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>scale</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <link
linkend="class-gtkscale"><classname>gtk.Scale</classname></link> widget is
an abstract base class, used only for deriving the subclasses <link
linkend="class-gtkhscale"><classname>gtk.HScale</classname></link> and <link
linkend="class-gtkvscale"><classname>gtk.VScale</classname></link>. A <link
linkend="class-gtkscale"><classname>gtk.Scale</classname></link> is a slider
control used to select a numeric value. Since <link
linkend="class-gtkscale"><classname>gtk.Scale</classname></link> is a
subclass of <link
linkend="class-gtkrange"><classname>gtk.Range</classname></link>, see the
<link linkend="class-gtkrange"><classname>gtk.Range</classname></link>
methods for additional methods. To set the value of a scale, you would
normally use <link
linkend="method-gtkrange--set-value"><methodname>set_value</methodname>()</link>.
To detect changes to the value, you would normally use the "value_changed"
signal.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkscale--set-digits">
<title>gtk.Scale.set_digits</title>
<programlisting><methodsynopsis language="python">
<methodname>set_digits</methodname>
<methodparam><parameter
role="keyword">digits</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">digits</parameter> :</term>
<listitem><simpara>the number of decimal places to
display</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_digits</methodname>() method sets the
"digits" property to the value specified by <parameter>digits</parameter>.
The value of <parameter>digits</parameter> specifies the number of decimal
places that are displayed in the value. The value of the adjustment is also
rounded off to this number of digits if "draw-value" is
<literal>True</literal>, so the retrieved value matches the value the user
sees. If the "draw-value" property has been set to <literal>False</literal>
by using the <link
linkend="method-gtkscale--set-draw-value"><methodname>set_draw_value</methodname>()</link>
method, the adjustment value will not be rounded at all.</para>
</refsect2>
<refsect2 id="method-gtkscale--get-digits">
<title>gtk.Scale.get_digits</title>
<programlisting><methodsynopsis language="python">
<methodname>get_digits</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the number of decimal places that are
displayed.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_digits</methodname>() method returns the
value of the "digits" property that indicates the number of decimal places
that are displayed in the value.</para>
</refsect2>
<refsect2 id="method-gtkscale--set-draw-value">
<title>gtk.Scale.set_draw_value</title>
<programlisting><methodsynopsis language="python">
<methodname>set_draw_value</methodname>
<methodparam><parameter
role="keyword">draw_value</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">draw_value</parameter> :</term>
<listitem><simpara>If <literal>True</literal> draw the current
value next to the slider</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_draw_value</methodname>() method sets the
"draw-value" property to the value specified by
<parameter>draw_value</parameter>. If <parameter>draw_value</parameter> is
<parameter>True</parameter> the current value is displayed next to the
slider.</para>
</refsect2>
<refsect2 id="method-gtkscale--get-draw-value">
<title>gtk.Scale.get_draw_value</title>
<programlisting><methodsynopsis language="python">
<methodname>get_draw_value</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the current value is
to be drawn next to the slider</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_draw_value</methodname>() method returns the
value of the "draw-value" property. If "draw-value" is
<literal>True</literal> the current scale value is drawn next to the
slider.</para>
</refsect2>
<refsect2 id="method-gtkscale--set-value-pos">
<title>gtk.Scale.set_value_pos</title>
<programlisting><methodsynopsis language="python">
<methodname>set_value_pos</methodname>
<methodparam><parameter
role="keyword">pos</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">pos</parameter> :</term>
<listitem><simpara>the position where the current value is
displayed.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_value_pos</methodname>() method sets the
value of the "value-pos" property to the value specified by
<parameter>pos</parameter>. The value of <parameter>pos</parameter> must be
one of: <literal>gtk.POS_LEFT</literal>, <literal>gtk.POS_RIGHT</literal>,
<literal>gtk.POS_TOP</literal> or <literal>gtk.POS_BOTTOM</literal>.</para>
</refsect2>
<refsect2 id="method-gtkscale--get-value-pos">
<title>gtk.Scale.get_value_pos</title>
<programlisting><methodsynopsis language="python">
<methodname>get_value_pos</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the position where the current value is
displayed.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_value_pos</methodname>() method returns the
value of the "value-pos" property. See the <link
linkend="method-gtkscale--set-value-pos"><methodname>set_value_pos</methodname>()</link>
method.</para>
</refsect2>
<refsect2 id="method-gtkscale--get-layout">
<title>gtk.Scale.get_layout</title>
<programlisting><methodsynopsis language="python">
<methodname>get_layout</methodname>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the <link
linkend="class-pangolayout"><classname>pango.Layout</classname></link>
for this scale or <literal>None</literal> if the draw_value
property is <literal>False</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>get_layout</methodname>() method returns the
<link linkend="class-pangolayout"><classname>pango.Layout</classname></link>
used to display the scale.</para>
</refsect2>
<refsect2 id="method-gtkscale--get-layout-offsets">
<title>gtk.Scale.get_layout_offsets</title>
<programlisting><methodsynopsis language="python">
<methodname>get_layout_offsets</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a 2-tuple containing the coordinates where the
scale will draw the <link
linkend="class-pangolayout"><classname>pango.Layout</classname></link>
representing the text in the scale</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>get_layout_offsets</methodname>() method returns
a 2-tuple containing the coordinates where the scale will draw the <link
linkend="class-pangolayout"><classname>pango.Layout</classname></link>
representing the text in the scale. Remember when using the <link
linkend="class-pangolayout"><classname>pango.Layout</classname></link>
function you need to convert to and from pixels using the <link
linkend="function-pango--PIXELS"><function>pango.PIXELS</function>()</link>
function or <literal>pango.SCALE</literal>. If the "draw-value" property is
<literal>False</literal>, the return values are undefined.</para>
</refsect2>
<refsect2 id="method-gtkscale--add-mark">
<title>gtk.Scale.add_mark</title>
<programlisting><methodsynopsis language="python">
<methodname>add_mark</methodname>
<methodparam><parameter role="keyword">value</parameter></methodparam>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">markup</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">value</parameter> :</term>
<listitem><simpara>the value at which the mark is placed, must be between the lower and upper limits of the scales' adjustment.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>where to draw the mark. For a horizontal scale, <literal>gtk.POS_TOP</literal> is drawn above the scale,
anything else below. For a vertical scale, <literal>gtk.POS_LEFT</literal> is drawn to the left of the scale, anything else
to the right.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">markup</parameter> :</term>
<listitem><simpara>text to be shown at the mark, using <link linkend="pango-markup-language">Pango markup</link>, or <literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<para>The <methodname>add_mark</methodname>() method adds a mark at value.
A mark is indicated visually by drawing a tick mark next to the scale, and GTK+
makes it easy for the user to position the scale exactly at the marks value.
If markup is not <literal>None</literal>, text is shown next to the tick mark.
To remove marks from a scale, use <link linkend="method-gtkscale--clear-marks"><methodname>clear_marks</methodname></link>().</para>
</refsect2>
<refsect2 id="method-gtkscale--clear-marks">
<title>gtk.Scale.clear_marks</title>
<programlisting><methodsynopsis language="python">
<methodname>clear_marks</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<para>The <methodname>clear_marks</methodname>() method removes any marks that have been
added with <link linkend="method-gtkscale--add-mark"><methodname>add_mark</methodname></link>().</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkscale--format-value">
<title>The "format-value" gtk.Scale Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>scale</parameter></methodparam>
<methodparam><parameter>value</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>scale</parameter> :</term>
<listitem><simpara>the scale that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter> :</term>
<listitem><simpara>the value to be formatted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a string representing
<parameter>value</parameter> for display</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "format-value" signal is emitted when the scale is being
redrawn with a value displayed. The "format-value" signal handler should
return a formatted string containing <parameter>value</parameter>.</para>
</refsect2>
</refsect1>
</refentry>
|
