summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkscalebutton.xml
blob: c211b34418e4cf70630b2b4d99d92e8524500041 (plain)
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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
<?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-gtkscalebutton">
    <refnamediv>
        <refname>gtk.ScaleButton</refname>
        <refpurpose>A button which pops up a scale. (new in PyGTK 2.12)</refpurpose>
    </refnamediv>

    <refsect1>
        <title>Synopsis</title>

    <classsynopsis language="python">
        <ooclass><classname>gtk.ScaleButton</classname></ooclass>
        <ooclass><classname><link linkend="class-gtkbutton">gtk.Button</link></classname></ooclass>
    <constructorsynopsis language="python">
        <methodname><link linkend="constructor-gtkscalebutton">gtk.ScaleButton</link></methodname>
        <methodparam><parameter role="keyword">size</parameter></methodparam>
        <methodparam><parameter role="keyword">min</parameter></methodparam>
        <methodparam><parameter role="keyword">max</parameter></methodparam>
        <methodparam><parameter role="keyword">step</parameter></methodparam>
        <methodparam><parameter role="keyword">icons</parameter><initializer>None</initializer></methodparam>
    </constructorsynopsis>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--get-adjustment">get_adjustment</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--get-minus-button">get_minus_button</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--get-orientation">get_orientation</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--get-plus-button">get_plus_button</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--get-popup">get_popup</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--get-value">get_value</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--set-adjustment">set_adjustment</link></methodname>
        <methodparam><parameter role="keyword">adjustment</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--set-icons">set_icons</link></methodname>
        <methodparam><parameter role="keyword">icons</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--set-orientation">set_orientation</link></methodname>
        <methodparam><parameter role="keyword">icons</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtkscalebutton--set-value">set_value</link></methodname>
        <methodparam><parameter role="keyword">value</parameter></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-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbin">gtk.Bin</link>
          +-- <link linkend="class-gtkbutton">gtk.Button</link>
            +-- <link linkend="class-gtkbutton">gtk.ScaleButton</link>
</synopsis>

    </refsect1>
    
    <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>


    <refsect1 id="properties-gtkscalebutton">
        <title>gtk.ScaleButton 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-gtkcontainer">gtk.Container Properties</link></para>
        <para><link linkend="properties-gtkbutton">gtk.Button 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="3.5in"/>
                    <tbody>
                        <row valign="top">
                            <entry>"adjustment"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                The <link linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
                                that contains the current value of this scale button object.
                            </entry>
                        </row>

                        <row valign="top">
                            <entry>"icons"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                The names of the icons to be used by the scale button. The first item in the array
                                will be used in the button when the current value is the lowest value, the second
                                item for the highest value. All the subsequent icons will be used for all the other
                                values, spread evenly over the range of values. If there's only one icon name in the
                                icons array, it will be used for all the values. If only two icon names are in the
                                icons array, the first one will be used for the bottom 50% of the scale, and the
                                second one for the top 50%.
                                It is recommended to use at least 3 icons so that the GtkScaleButton reflects the
                                current value of the scale better for the users.
                            </entry>
                        </row>

                        <row valign="top">
                            <entry>"orientation"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                The orientation of the
				<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
				popup window. Default value: gtk.ORIENTATION_VERTICAL.
				Available from GTK+ 2.14.
                            </entry>
                        </row>

                        <row valign="top">
                            <entry>"size"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                The icon size. Default value: gtk.ICON_SIZE_SMALL_TOOLBAR.
                            </entry>
                        </row>

                        <row valign="top">
                            <entry>"value"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                The value of the scale. Default value: 0.
                            </entry>
                        </row>
                    </tbody>
                </tgroup>
            </informaltable>
        </blockquote>
    </refsect1>

    <refsect1 id="style-properties-gtkscalebutton">
        <title>gtk.ScaleButton Style Properties</title>

        <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
        <para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>

    </refsect1>
    
    <refsect1 id="signal-prototypes-gtkscalebutton">
        <title>gtk.ScaleButton 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-gtkcontainer">gtk.Container Signal Prototypes</link></para>
        <para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>

        <variablelist>
            <varlistentry>
                <term>"<link linkend="signal-gtkscalebutton--popdown">popdown</link>"</term>
                <listitem>
                    <methodsynopsis language="python"><methodname>callback</methodname>
                        <methodparam><parameter>scalebutton</parameter></methodparam>
                        <methodparam><parameter>user_param1</parameter></methodparam>
                        <methodparam><parameter>...</parameter></methodparam>
                    </methodsynopsis>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>"<link linkend="signal-gtkscalebutton--popdown">popup</link>"</term>
                <listitem>
                    <methodsynopsis language="python"><methodname>callback</methodname>
                        <methodparam><parameter>scalebutton</parameter></methodparam>
                        <methodparam><parameter>user_param1</parameter></methodparam>
                        <methodparam><parameter>...</parameter></methodparam>
                    </methodsynopsis>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>"<link linkend="signal-gtkscalebutton--popdown">value-changed</link>"</term>
                <listitem>
                    <methodsynopsis language="python"><methodname>callback</methodname>
                        <methodparam><parameter>scalebutton</parameter></methodparam>
                        <methodparam><parameter>value</parameter></methodparam>
                        <methodparam><parameter>user_param1</parameter></methodparam>
                        <methodparam><parameter>...</parameter></methodparam>
                    </methodsynopsis>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

    <refsect1>
        <title>Description</title>
            <para>
                <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>
                provides a button which pops up a scale widget. This kind of widget is commonly
                used for volume controls in multimedia applications, and GTK+ provides a
                <link linkend="class-gtkvolumebutton"><classname>gtk.VolumeButton</classname></link>
                subclass that is tailored for this use case.
            </para>
    </refsect1>

    <refsect1 id="constructor-gtkscalebutton">
        <title>Constructor</title>

        <programlisting><constructorsynopsis language="python">
            <methodname>gtk.ScaleButton</methodname>
            <methodparam><parameter role="keyword">size</parameter></methodparam>
            <methodparam><parameter role="keyword">min</parameter></methodparam>
            <methodparam><parameter role="keyword">max</parameter></methodparam>
            <methodparam><parameter role="keyword">step</parameter></methodparam>
            <methodparam><parameter role="keyword">icons</parameter><initializer>None</initializer></methodparam>
        </constructorsynopsis></programlisting>

        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">size</parameter>&nbsp;:</term>
                <listitem><simpara>A stock icon size.</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">min</parameter>&nbsp;:</term>
                <listitem><simpara>The minimum value of the scale (usually 0).</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">max</parameter>&nbsp;:</term>
                <listitem><simpara>The maximum value of the scale (usually 100).</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">step</parameter>&nbsp;:</term>
                <listitem><simpara>The stepping of value when a scroll-wheel event, or
                up/down arrow event occurs (usually 2).</simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><parameter role="keyword">icons</parameter>&nbsp;:</term>
                <listitem><simpara>Optionally a list or tuple of icon names, you will be able to set the
                list later with <methodname><link linkend="method-gtkscalebutton--set-icons">set_icons</link></methodname>
                </simpara></listitem>
            </varlistentry>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara>a new
                <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>
                object.</simpara></listitem>
            </varlistentry>
        </variablelist>

        <note>
            <para>This constructor is available in PyGTK 2.12 and above.</para>
        </note>

        <para>
            Creates a <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>,
            with a range between <parameter>min</parameter> and <parameter>max</parameter>,
            with a stepping of <parameter>step</parameter>.
        </para>
    </refsect1>

    <refsect1>
        <title>Methods</title>

        <refsect2 id="method-gtkscalebutton--get-adjustment">
            <title>gtk.ScaleButton.get_adjustment</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_adjustment</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>The
                        <link linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
                        associated with the scale.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.12 and above.</para>
            </note>

            <para>
                The <methodname>get_adjustment</methodname>() method gets the
                <link linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
                associated with the
                <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
                scale. See
                <methodname><link linkend="method-gtkrange--get-adjustment">gtk.Range.get_adjustment</link></methodname>
                for details.
            </para>
        </refsect2>

        <refsect2 id="method-gtkscalebutton--get-minus-button">
            <title>gtk.ScaleButton.get_minus_button</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_minus_button</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>the minus button of the
			<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
			</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>get_minus_button</methodname>() method
		retrieves the minus button of the
		<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
            </para>
        </refsect2>

        <refsect2 id="method-gtkscalebutton--get-orientation">
            <title>gtk.ScaleButton.get_orientation</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_orientation</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>the
			<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
			orientation.
			</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>get_orientation</methodname>() method
		gets the orientation of the
		<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
		popup window.
            </para>
        </refsect2>

        <refsect2 id="method-gtkscalebutton--get-plus-button">
            <title>gtk.ScaleButton.get_plus_button</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_plus_button</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>the plus button of the
			<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
			</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>get_plus_button</methodname>() method
		retrieves the plus button of the
		<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
            </para>
        </refsect2>

        <refsect2 id="method-gtkscalebutton--get-popup">
            <title>gtk.ScaleButton.get_popup</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_popup</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>the popup of the
			<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
			</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>get_popup</methodname>() method
		gets the popup of the
		<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
            </para>
        </refsect2>

        <refsect2 id="method-gtkscalebutton--get-value">
            <title>gtk.ScaleButton.get_value</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_value</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>The current value of the scale button.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.12 and above.</para>
            </note>

            <para>
                The <methodname>get_value</methodname>() method gets the current value of the scale button.
            </para>
        </refsect2>

        <refsect2 id="method-gtkscalebutton--set-adjustment">
            <title>gtk.ScaleButton.set_adjustment</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_adjustment</methodname>
                <methodparam><parameter>adjustment</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter role="keyword">adjustment</parameter>&nbsp;:</term>
                        <listitem><simpara>The
                        <link linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
                        to set.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.12 and above.</para>
            </note>

            <para>
                The <methodname>set_adjustment</methodname>() method sets the
                <link linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
                to be used as a model for the
                <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
                scale. See
                <methodname><link linkend="method-gtkrange--set-adjustment">gtk.Range.set_adjustment</link></methodname>
                for details.
            </para>
        </refsect2>

        <refsect2 id="method-gtkscalebutton--set-icons">
            <title>gtk.ScaleButton.set_icons</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_icons</methodname>
                <methodparam><parameter>icons</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter role="keyword">icons</parameter>&nbsp;:</term>
                        <listitem><simpara>A list or tuple of icon names.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.12 and above.</para>
            </note>

            <para>
                The <methodname>set_icons</methodname>() method sets the icons to be used by the
                scale button. For details, see the <link linkend="properties-gtkbutton">gtk.ScaleButton:icons property</link>
                for details.
            </para>
        </refsect2>

        <refsect2 id="method-gtkscalebutton--set-orientation">
            <title>gtk.ScaleButton.set_orientation</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_orientation</methodname>
                <methodparam><parameter>icons</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter role="keyword">orientation</parameter>&nbsp;:</term>
                        <listitem><simpara>the new orientation.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>

            <para>
                The <methodname>set_orientation</methodname>() method sets the
		orientation of the
		<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
		popup window.
            </para>
        </refsect2>

        <refsect2 id="method-gtkscalebutton--set-value">
            <title>gtk.ScaleButton.set_value</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_value</methodname>
                <methodparam><parameter>value</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter role="keyword">value</parameter>&nbsp;:</term>
                        <listitem><simpara>The new value of the scale button.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.12 and above.</para>
            </note>

            <para>
                The <methodname>set_value</methodname>() method sets the current value of the scale;
                if the value is outside the minimum or maximum range values, it will be
                clamped to fit inside them. The scale button emits the
                <link linkend="signal-gtkscalebutton--popdown">value-changed</link> signal if the value changes.
            </para>
        </refsect2>
    </refsect1>
    
    <refsect1>
        <title>Signals</title>

        <refsect2 id="signal-gtkscalebutton--popdown">
            <title>The "popdown" gtk.ScaleButton Signal</title>

            <programlisting><methodsynopsis language="python">
                <methodname>callback</methodname>
                    <methodparam><parameter>scalebutton</parameter></methodparam>
                    <methodparam><parameter>user_param1</parameter></methodparam>
                    <methodparam><parameter>...</parameter></methodparam>
                </methodsynopsis></programlisting>

            <variablelist>
                <varlistentry>
                    <term><parameter>scalebutton</parameter>&nbsp;:</term>
                    <listitem><simpara>the scalebutton that received the "popdown" signal</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>user_param1</parameter>&nbsp;:</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>&nbsp;:</term>
                    <listitem><simpara>additional user parameters (if
                    any)</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This signal is available in PyGTK 2.12 and above.</para>
            </note>

            <para>
                The "popdown" signal is a keybinding signal which gets emitted to popdown the scale widget.
                The default binding for this signal is Escape.
            </para>
        </refsect2>

        <refsect2 id="signal-gtkscalebutton--popup">
            <title>The "popup" gtk.ScaleButton Signal</title>

            <programlisting><methodsynopsis language="python">
                <methodname>callback</methodname>
                    <methodparam><parameter>scalebutton</parameter></methodparam>
                    <methodparam><parameter>user_param1</parameter></methodparam>
                    <methodparam><parameter>...</parameter></methodparam>
                </methodsynopsis></programlisting>

            <variablelist>
                <varlistentry>
                    <term><parameter>scalebutton</parameter>&nbsp;:</term>
                    <listitem><simpara>the scalebutton that received the "popup" signal</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>user_param1</parameter>&nbsp;:</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>&nbsp;:</term>
                    <listitem><simpara>additional user parameters (if
                    any)</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This signal is available in PyGTK 2.12 and above.</para>
            </note>

            <para>
                The "popup" signal is a keybinding signal which gets emitted to popup the scale widget.
                The default bindings for this signal are Space, Enter and Return.
            </para>
        </refsect2>

        <refsect2 id="signal-gtkscalebutton--value-changed">
            <title>The "value-changed" gtk.ScaleButton Signal</title>

            <programlisting><methodsynopsis language="python">
                <methodname>callback</methodname>
                    <methodparam><parameter>scalebutton</parameter></methodparam>
                    <methodparam><parameter>value</parameter></methodparam>
                    <methodparam><parameter>user_param1</parameter></methodparam>
                    <methodparam><parameter>...</parameter></methodparam>
                </methodsynopsis></programlisting>

            <variablelist>
                <varlistentry>
                    <term><parameter>scalebutton</parameter>&nbsp;:</term>
                    <listitem><simpara>the scalebutton that received the "value-changed" signal</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>value</parameter>&nbsp;:</term>
                    <listitem><simpara>the new value</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>user_param1</parameter>&nbsp;:</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>&nbsp;:</term>
                    <listitem><simpara>additional user parameters (if
                    any)</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This signal is available in PyGTK 2.12 and above.</para>
            </note>

            <para>
                The "value-changed" signal is emitted when the value field has changed.
            </para>
        </refsect2>
    </refsect1>
</refentry>