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
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
|
<?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-gtkrange">
<refnamediv>
<refname>gtk.Range</refname>
<refpurpose>a base class for widgets that allow a user to set a value in
a range.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Range</classname></ooclass>
<ooclass><classname><link
linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--set-update-policy">set_update_policy</link></methodname>
<methodparam><parameter
role="keyword">policy</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--get-update-policy">get_update_policy</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--set-adjustment">set_adjustment</link></methodname>
<methodparam><parameter
role="keyword">adjustment</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--get-adjustment">get_adjustment</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--set-inverted">set_inverted</link></methodname>
<methodparam><parameter
role="keyword">setting</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--get-inverted">get_inverted</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--set-increments">set_increments</link></methodname>
<methodparam><parameter
role="keyword">step</parameter></methodparam>
<methodparam><parameter
role="keyword">page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--set-range">set_range</link></methodname>
<methodparam><parameter role="keyword">min</parameter></methodparam>
<methodparam><parameter role="keyword">max</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--set-value">set_value</link></methodname>
<methodparam><parameter
role="keyword">value</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkrange--get-value">get_value</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkrange--get-fill-level">get_fill_level</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkrange--set-fill-level">set_fill_level</link></methodname>
<methodparam><parameter role="keyword">fill_level</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkrange--get-restrict-to-fill-level">get_restrict_to_fill_level</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkrange--set-restrict-to-fill-level">set_restrict_to_fill_level</link></methodname>
<methodparam><parameter role="keyword">restrict_to_fill_level</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkrange--get-show-fill-level">get_show_fill_level</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkrange--set-show-fill-level">set_show_fill_level</link></methodname>
<methodparam><parameter role="keyword">show_fill_level</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-gtkrange">gtk.Range</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkrange"><classname>gtk.Range</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkrange">
<title>gtk.Range 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>"adjustment"</entry>
<entry>Read-Write</entry>
<entry>The <link
linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
that contains the current value of this range object</entry>
</row>
<row valign="top">
<entry>"fill-level"</entry>
<entry>Read-Write</entry>
<entry>The fill level (e.g. prebuffering of a network stream).
See <methodname><link linkend="method-gtkrange--set-fill-level">gtk.Range.set_fill_level</link></methodname>().
Default value: 1.79769e+308. Available in GTK+ 2.12.</entry>
</row>
<row valign="top">
<entry>"inverted"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal>, the slider movement is
reversed e.g right-to-left instead of left-to-right</entry>
</row>
<row valign="top">
<entry>"lower-stepper-sensitivity"</entry>
<entry>Read-Write</entry>
<entry>The sensitivity policy for the stepper that points to the
adjustment's lower side</entry>
</row>
<row valign="top">
<entry>"restrict-to-fill-level"</entry>
<entry>Read-Write</entry>
<entry>The restrict-to-fill-level property controls whether slider movement is restricted to
an upper boundary set by the fill level. See
<methodname><link linkend="method-gtkrange--get-restrict-to-fill-level">gtk.Range.get_restrict_to_fill_level</link></methodname>().
Default value: True. Available in GTK+ 2.12.</entry>
</row>
<row valign="top">
<entry>"update-policy"</entry>
<entry>Read-Write</entry>
<entry>How the range should be updated on the screen:
<literal>gtk.UPDATE_CONTINUOUS</literal>,
<literal>gtk.UPDATE_DISCONTINUOUS</literal>,
<literal>gtk.UPDATE_DELAYED</literal>.</entry>
</row>
<row valign="top">
<entry>"show-fill-level"</entry>
<entry>Read-Write</entry>
<entry>The show-fill-level property controls whether fill level indicator graphics are displayed on the trough. See gtk_range_set_show_fill_level().
<methodname><link linkend="method-gtkrange--set-show-fill-level">gtk.Range.set_show_fill_level</link></methodname>().
Default value: False. Available in GTK+ 2.12.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkrange">
<title>gtk.Range Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget 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>"activate-slider"</entry>
<entry>Read</entry>
<entry>With this option set to <literal>True</literal>,
sliders will be drawn <literal>ACTIVE</literal> and with
shadow <literal>IN</literal> while they are dragged</entry>
</row>
<row valign="top">
<entry>"arrow-displacement-x"</entry>
<entry>Read</entry>
<entry>The distance horizontally to move the arrow when the
button is depressed</entry>
</row>
<row valign="top">
<entry>"arrow-displacement-y"</entry>
<entry>Read</entry>
<entry>The distance vertically to move the arrow when the
button is depressed</entry>
</row>
<row valign="top">
<entry>"arrow-scaling"</entry>
<entry>Read</entry>
<entry>The arrow size proportion relative to the scroll button size.
Allowed values: [0,1]. Default value: 0.5.
Available from GTK+ 2.14.</entry>
</row>
<row valign="top">
<entry>"slider-width"</entry>
<entry>Read</entry>
<entry>The width of scrollbar or scale thumb</entry>
</row>
<row valign="top">
<entry>"stepper-size"</entry>
<entry>Read</entry>
<entry>The length of step buttons at ends</entry>
</row>
<row valign="top">
<entry>"stepper-spacing"</entry>
<entry>Read</entry>
<entry>The spacing between step buttons and thumb</entry>
</row>
<row valign="top">
<entry>"trough-border"</entry>
<entry>Read</entry>
<entry>The spacing between thumb or steppers and outer trough
bevel</entry>
</row>
<row valign="top">
<entry>"trough-side-details"</entry>
<entry>Read</entry>
<entry>This property is available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"trough-under-steppers"</entry>
<entry>Read</entry>
<entry>if <literal>True</literal> draw the trough across the
full length of the range or to exclude the steppers and their
spacing. Note that setting the "stepper-spacing" style
property to any value > 0 will automatically enable
"trough-under-steppers" too. This property is available in
GTK+ 2.10 and above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkrange">
<title>gtk.Range 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>
<variablelist>
<varlistentry>
<term>"<link
linkend="signal-gtkrange--adjust-bounds">adjust-bounds</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>range</parameter></methodparam>
<methodparam><parameter>value</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkrange--change-value">change-value</link></term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>range</parameter></methodparam>
<methodparam><parameter>scroll</parameter></methodparam>
<methodparam><parameter>value</parameter></methodparam>
<methodparam><parameter>arg1</parameter></methodparam>
<methodparam><parameter>arg2</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link
linkend="signal-gtkrange--move-slider">move-slider</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>range</parameter></methodparam>
<methodparam><parameter>scrolltype</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link
linkend="signal-gtkrange--value-changed">value-changed</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>range</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-gtkrange"><classname>gtk.Range</classname></link> is the base
class for the <link
linkend="class-gtkscale"><classname>gtk.Scale</classname></link> and <link
linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
widgets. The <link
linkend="class-gtkrange"><classname>gtk.Range</classname></link> provides
the common functionality for these widgets that allow a user to set a value
in a range of values. The <link
linkend="class-gtkscale"><classname>gtk.Scale</classname></link> works in
conjunction with a <link
linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
which provides the range information.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkrange--set-update-policy">
<title>gtk.Range.set_update_policy</title>
<programlisting><methodsynopsis language="python">
<methodname>set_update_policy</methodname>
<methodparam><parameter
role="keyword">policy</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">policy</parameter> :</term>
<listitem><simpara>the update policy:
<literal>gtk.UPDATE_CONTINUOUS</literal>,
<literal>gtk.UPDATE_DISCONTINUOUS</literal>,
<literal>gtk.UPDATE_DELAYED</literal></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_update_policy</methodname>() method sets the
"update-policy" property to the value specified by
<parameter>policy</parameter>. The update policy has the following values
and effects:</para>
<variablelist>
<varlistentry>
<term><literal>gtk.UPDATE_CONTINUOUS</literal></term>
<listitem>
<simpara>anytime the range slider is moved, the range value will
change and the "value_changed" signal will be emitted.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>gtk.UPDATE_DELAYED</literal></term>
<listitem>
<simpara>the value will be updated after a brief timeout where
no slider motion occurs, so value changes are delayed slightly rather than
continuously updated.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>gtk.UPDATE_DISCONTINUOUS</literal></term>
<listitem>
<simpara>the value will only be updated when the user releases
the button and ends the slider drag operation.</simpara>
</listitem>
</varlistentry>
</variablelist>
<para></para>
</refsect2>
<refsect2 id="method-gtkrange--get-update-policy">
<title>gtk.Range.get_update_policy</title>
<programlisting><methodsynopsis language="python">
<methodname>get_update_policy</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the current update policy</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_update_policy</methodname>() method gets the
value of the "update-policy" property. The update policy is one of:
<literal>gtk.UPDATE_CONTINUOUS</literal>,
<literal>gtk.UPDATE_DISCONTINUOUS</literal> or
<literal>gtk.UPDATE_DELAYED</literal>. See the <link
linkend="method-gtkrange--set-update-policy"><methodname>set_update_policy</methodname>()</link>
method for details.</para>
</refsect2>
<refsect2 id="method-gtkrange--set-adjustment">
<title>gtk.Range.set_adjustment</title>
<programlisting><methodsynopsis language="python">
<methodname>set_adjustment</methodname>
<methodparam><parameter
role="keyword">adjustment</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">adjustment</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_adjustment</methodname>() method sets the
"adjustment" property to the value specified by
<parameter>adjustment</parameter>. The <link
linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>
is used as the "model" object for this range widget.
<parameter>adjustment</parameter> indicates the current range value, the
minimum and maximum range values, the step and page increments used for
keybindings and scrolling, and the page size. The page size is normally 0
for <link linkend="class-gtkscale"><classname>gtk.Scale</classname></link>
and nonzero for <link
linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>,
and indicates the size of the visible area of the widget being scrolled. The
page size affects the size of the scrollbar slider.</para>
</refsect2>
<refsect2 id="method-gtkrange--get-adjustment">
<title>gtk.Range.get_adjustment</title>
<programlisting><methodsynopsis language="python">
<methodname>get_adjustment</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_adjustment</methodname>() method returns the
value of the "adjustment" property. See the <link
linkend="method-gtkrange--set-adjustment"><methodname>set_adjustment</methodname>()</link>
method for details.</para>
</refsect2>
<refsect2 id="method-gtkrange--set-inverted">
<title>gtk.Range.set_inverted</title>
<programlisting><methodsynopsis language="python">
<methodname>set_inverted</methodname>
<methodparam><parameter
role="keyword">setting</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">setting</parameter> :</term>
<listitem><simpara>if <literal>True</literal> invert the
range</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_inverted</methodname>() method sets the
"inverted" property to the value specified by
<parameter>setting</parameter>. If <parameter>setting</parameter> is
<literal>True</literal> the normal motion of the range widget is reversed.
Ranges normally move from lower to higher values as the slider moves from
top to bottom or left to right. Inverted ranges have higher values at the
top or left rather than on the bottom or right.</para>
</refsect2>
<refsect2 id="method-gtkrange--get-inverted">
<title>gtk.Range.get_inverted</title>
<programlisting><methodsynopsis language="python">
<methodname>get_inverted</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the range is
inverted</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_inverted</methodname>() method returns the
value of the "inverted" property that was set by the <link
linkend="method-gtkrange--set-inverted"><methodname>set_inverted</methodname>()</link>
method.</para>
</refsect2>
<refsect2 id="method-gtkrange--set-increments">
<title>gtk.Range.set_increments</title>
<programlisting><methodsynopsis language="python">
<methodname>set_increments</methodname>
<methodparam><parameter
role="keyword">step</parameter></methodparam>
<methodparam><parameter
role="keyword">page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">step</parameter> :</term>
<listitem><simpara>the step size</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">page</parameter> :</term>
<listitem><simpara>the page size</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_increments</methodname>() method sets the
step and page sizes for the range to the values specified by
<parameter>step</parameter> and <parameter>page</parameter> respectively.
The step size is used when the user clicks the <link
linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
arrows or moves <link
linkend="class-gtkscale"><classname>gtk.Scale</classname></link> via the
arrow keys. The page size is used for example when moving via <keycap>Page
Up</keycap> or <keycap>Page Down</keycap> keys.</para>
</refsect2>
<refsect2 id="method-gtkrange--set-range">
<title>gtk.Range.set_range</title>
<programlisting><methodsynopsis language="python">
<methodname>set_range</methodname>
<methodparam><parameter
role="keyword">min</parameter></methodparam>
<methodparam><parameter
role="keyword">max</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">min</parameter> :</term>
<listitem><simpara>the minimum range value</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">max</parameter> :</term>
<listitem><simpara>the maximum range value</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_range</methodname>() method sets the minimum
and maximum allowable values for the <link
linkend="class-gtkrange"><classname>gtk.Range</classname></link> to that
values specified by <parameter>min</parameter> and
<parameter>max</parameter> respectively. If the range has a non-zero page
size, it is also forced to be between <parameter>min</parameter> and
<parameter>max</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkrange--set-value">
<title>gtk.Range.set_value</title>
<programlisting><methodsynopsis language="python">
<methodname>set_value</methodname>
<methodparam><parameter
role="keyword">value</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">value</parameter> :</term>
<listitem><simpara>the new value of the range</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_value</methodname>() method sets the current
value of the range to the value specified by <parameter>value</parameter>.
<parameter>value</parameter> will be forced inside the minimum or maximum
range values. The range emits the "value_changed" signal if the value
changes.</para>
</refsect2>
<refsect2 id="method-gtkrange--get-value">
<title>gtk.Range.get_value</title>
<programlisting><methodsynopsis language="python">
<methodname>get_value</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the current value of the
range.</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_value</methodname>() method gets the current
value of the range.</para>
<refsect2 id="method-gtkrange--set-fill-level">
<title>gtk.Range.set_fill_level</title>
<programlisting><methodsynopsis language="python">
<methodname>set_fill_level</methodname>
<methodparam><parameter role="keyword">fill_level</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">fill_level</parameter> :</term>
<listitem><simpara>the new position of the fill level indicator.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>set_fill_level</methodname>() method sets
the new position of the fill level indicator.
</para>
<para>
The "fill level" is probably best described by its most prominent use case,
which is an indicator for the amount of pre-buffering in a streaming media
player. In that use case, the value of the range would indicate the current
play position, and the fill level would be the position up to which the
file/stream has been downloaded.
</para>
<para>
This amount of prebuffering can be displayed on the range's trough and is
themeable separately from the trough. To enable fill level display, use
<methodname><link linkend="method-gtkrange--set-show-fill-level">gtk.Range.set_show_fill_level</link></methodname>().
The range defaults to not showing the fill level.
</para>
<para>
Additionally, it's possible to restrict the range's slider position to values
which are smaller than the fill level. This is controller by
<methodname><link linkend="method-gtkrange--set-restrict-to-fill-level">gtk.Range.set_restrict_to_fill_level</link></methodname>()
and is by default enabled.
</para>
</refsect2>
<refsect2 id="method-gtkrange--get-fill-level">
<title>gtk.Range.get_fill_level</title>
<programlisting><methodsynopsis language="python">
<methodname>get_fill_level</methodname>
<methodparam></methodparam></methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The current fill level.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_fill_level</methodname>() method gets the current
position of the fill level indicator.
</para>
</refsect2></refsect2>
<refsect2 id="method-gtkrange--set-restrict-to-fill-level">
<title>gtk.Range.set_restrict_to_fill_level</title>
<programlisting><methodsynopsis language="python">
<methodname>set_restrict_to_fill_level</methodname>
<methodparam><parameter role="keyword">restrict_to_fill_level</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">restrict_to_fill_level</parameter> :</term>
<listitem><simpara>Whether the fill level restricts slider movement.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>set_restrict_to_fill_level</methodname>() method sets
whether the slider is restricted to the fill level. See
<methodname><link linkend="method-gtkrange--set-fill-level">gtk.Range.set_fill_level</link></methodname>()
for a general description of the fill level concept.
</para>
</refsect2>
<refsect2 id="method-gtkrange--get-restrict-to-fill-level">
<title>gtk.Range.get_restrict_to_fill_level</title>
<programlisting><methodsynopsis language="python">
<methodname>get_restrict_to_fill_level</methodname>
<methodparam></methodparam></methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if range is
restricted to the fill level.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_restrict_to_fill_level</methodname>() method gets
whether the range is restricted to the fill level.
</para>
</refsect2>
<refsect2 id="method-gtkrange--set-show-fill-level">
<title>gtk.Range.set_show_fill_level</title>
<programlisting><methodsynopsis language="python">
<methodname>set_show_fill_level</methodname>
<methodparam><parameter role="keyword">show_fill_level</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">show_fill_level</parameter> :</term>
<listitem><simpara>Whether a fill level indicator graphics is shown.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>set_show_fill_level</methodname>() method sets
whether a graphical fill level is show on the trough. See
<methodname><link linkend="method-gtkrange--set-fill-level">gtk.Range.set_fill_level</link></methodname>()
for a general description of the fill level concept.
</para>
</refsect2>
<refsect2 id="method-gtkrange--get-show-fill-level">
<title>gtk.Range.get_show_fill_level</title>
<programlisting><methodsynopsis language="python">
<methodname>get_show_fill_level</methodname>
<methodparam></methodparam></methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if range shows the
fill level.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_show_fill_level</methodname>() method gets
whether the range displays the fill level graphically.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkrange--adjust-bounds">
<title>The "adjust-bounds" gtk.Range Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>range</parameter></methodparam>
<methodparam><parameter>value</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>range</parameter> :</term>
<listitem><simpara>the range that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter> :</term>
<listitem><simpara>the value</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>
</variablelist>
<para>The "adjust-bounds" signal is emitted when the range is adjusted
by user action. Note the value can be more or less than the range since it
depends on the mouse position.</para>
</refsect2>
<refsect2 id="signal-gtkrange--change-value">
<title>The "change-value" gtk.Range Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>range</parameter></methodparam>
<methodparam><parameter>scroll</parameter></methodparam>
<methodparam><parameter>value</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>range</parameter> :</term>
<listitem><simpara>the range that received the signal. the object
which received the signal.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>scroll</parameter> :</term>
<listitem><simpara>the type of scroll action that was performed -
one of the <xref linkend="gtk-scroll-type-constants"
endterm="gtk-scroll-type-constants-title"></xref>..</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter> :</term>
<listitem><simpara>the new value resulting from the scroll
action.</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><literal>True</literal> to prevent other
handlers from being invoked for the signal or
<literal>False</literal> to propagate the signal
further.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.6 and above.</para>
</note>
<para>The "change-value" signal is emitted when a scroll action is
performed on a range. It allows an application to determine the type
of scroll event that occurred and the resultant new value. The
application can handle the event itself and return
<literal>True</literal> to prevent further processing. Or, by
returning <literal>False</literal>, it can pass the event to other
handlers until the default GTK+ handler is reached.</para>
<para>The value parameter is unrounded. An application that overrides
the "change-value" signal is responsible for clamping the value to the
desired number of decimal digits.</para>
<para>It is not possible to use delayed update policies in an
overridden "change-value" handler.</para>
</refsect2>
<refsect2 id="signal-gtkrange--move-slider">
<title>The "move-slider" gtk.Range Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>range</parameter></methodparam>
<methodparam><parameter>scrolltype</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>range</parameter> :</term>
<listitem><simpara>the range that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>scrolltype</parameter> :</term>
<listitem><simpara>the scroll type issued because a key was
pressed by the user; one of the <xref
linkend="gtk-scroll-type-constants"
endterm="gtk-scroll-type-constants-title"></xref>.</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>
</variablelist>
<para>The "move-slider" signal is emitted when the user presses a key
(e.g. <keycap>Page Up</keycap>, <keycap>Home</keycap>, <keycap>Right
Arrow</keycap>) to move the slider.</para>
</refsect2>
<refsect2 id="signal-gtkrange--value-changed">
<title>The "value-changed" gtk.Range Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>range</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>range</parameter> :</term>
<listitem><simpara>the range that received the
signal</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>
</variablelist>
<para>The "value-changed" signal is emitted when the range value is
changed either programmatically or by user action.</para>
</refsect2>
</refsect1>
</refentry>
|
