From 26ba954b7162094a31ca7378bfc19dcd92e9c303 Mon Sep 17 00:00:00 2001 From: Dieter Verfaillie Date: Wed, 2 Mar 2011 12:03:59 +0100 Subject: reference: pygtk-gtkrange.xml: add missing methods and properties --- docs/reference/pygtk-gtkrange.xml | 446 ++++++++++++++++++++++++++++++++++---- 1 file changed, 407 insertions(+), 39 deletions(-) diff --git a/docs/reference/pygtk-gtkrange.xml b/docs/reference/pygtk-gtkrange.xml index 5ea81180..c307b52a 100644 --- a/docs/reference/pygtk-gtkrange.xml +++ b/docs/reference/pygtk-gtkrange.xml @@ -95,6 +95,59 @@ linkend="method-gtkrange--get-value">get_value set_show_fill_level show_fill_level + + + set_round_digits + round_digits + + + get_round_digits + + + + set_min_slider_size + min_size + + + get_min_slider_size + + + + get_range_rect + + + + set_slider_size_fixed + size_fixed + + + get_slider_size_fixed + + + + set_flippable + flippable + + + get_flippable + + + + set_lower_stepper_sensitivity + sensitivity + + + get_lower_stepper_sensitivity + + + + set_upper_stepper_sensitivity + sensitivity + + + get_upper_stepper_sensitivity + + @@ -142,7 +195,7 @@ linkend="method-gtkrange--get-value">get_value that contains the current value of this range object - + "fill-level" Read-Write The fill level (e.g. prebuffering of a network stream). @@ -157,14 +210,15 @@ linkend="method-gtkrange--get-value">get_value reversed e.g right-to-left instead of left-to-right - - "lower-stepper-sensitivity" - Read-Write - The sensitivity policy for the stepper that points to the - adjustment's lower side - + + "lower-stepper-sensitivity" + Read-Write + The sensitivity policy for the stepper that points to the + adjustment's lower side. + Default value: gtk.SENSITIVITY_AUTO + - + "restrict-to-fill-level" Read-Write The restrict-to-fill-level property controls whether slider movement is restricted to @@ -173,6 +227,24 @@ linkend="method-gtkrange--get-value">get_value Default value: True. Available in GTK+ 2.12. + + "round-digits" + Read-Write + The number of digits to round the value to when it changes, or -1. + Default value: -1. + This property is available in GTK+ 2.24 and above. + + + + + "show-fill-level" + Read-Write + The show-fill-level property controls whether fill level indicator graphics are displayed on the trough. See gtk_range_set_show_fill_level(). + gtk.Range.set_show_fill_level(). + Default value: False. + Available in GTK+ 2.12. + + "update-policy" Read-Write @@ -182,13 +254,13 @@ linkend="method-gtkrange--get-value">get_value gtk.UPDATE_DELAYED. - - "show-fill-level" - Read-Write - The show-fill-level property controls whether fill level indicator graphics are displayed on the trough. See gtk_range_set_show_fill_level(). - gtk.Range.set_show_fill_level(). - Default value: False. Available in GTK+ 2.12. - + + "upper-stepper-sensitivity" + Read-Write + The sensitivity policy for the stepper that points to the + adjustment's upper side. + Default value: gtk.SENSITIVITY_AUTO + @@ -210,13 +282,13 @@ linkend="method-gtkrange--get-value">get_value - - "activate-slider" - Read - With this option set to True, - sliders will be drawn ACTIVE and with - shadow IN while they are dragged - + + "activate-slider" + Read + With this option set to True, + sliders will be drawn ACTIVE and with + shadow IN while they are dragged + "arrow-displacement-x" @@ -265,22 +337,22 @@ linkend="method-gtkrange--get-value">get_value bevel - - "trough-side-details" - Read - This property is available in GTK+ 2.10 and above. - - - - "trough-under-steppers" - Read - if True 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. - + + "trough-side-details" + Read + This property is available in GTK+ 2.10 and above. + + + + "trough-under-steppers" + Read + if True 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. + @@ -311,7 +383,7 @@ linkend="signal-gtkrange--adjust-bounds">adjust-bounds" - "change-value + "change-value" callback range @@ -808,6 +880,302 @@ value of the range. + + gtk.Range.set_round_digits + + + set_round_digits + round_digits + + + + round_digits : + the precision in digits, or -1. + + + + + This method is available in PyGTK 2.24 and above. + + + The set_round_digits() method sets the number of digits + to round the value to when it changes. See "change-value". + + + + + gtk.Range.get_round_digits + + + get_round_digits + + + + + Returns : + the number of digits to round to. + + + + + This method is available in PyGTK 2.24 and above. + + + The get_round_digits() method gets the number of digits + to round the value to when it changes. See "change-value". + + + + + gtk.Range.set_min_slider_size + + + set_min_slider_size + min_size + + + + min_size : + The slider's minimum size. + + + + + This method is available in PyGTK 2.22 and above. + + + The set_min_slider_size() method sets the minimum size of the range's slider. + + This method is useful mainly for GtkRange subclasses. + + + + + gtk.Range.get_min_slider_size + + + get_min_slider_size + + + + + Returns : + The minimum size of the range's slider. + + + + + This method is available in PyGTK 2.22 and above. + + + The get_min_slider_size() method gets the minimum size of the range's slider. + + This method is useful mainly for GtkRange subclasses. + + + + + gtk.Range.get_range_rect + + + get_range_rect + + + + + Returns : + the range rectangle. + + + + + This method is available in PyGTK 2.22 and above. + + + The get_range_rect() method returns the area + that contains the range's trough and its steppers. + + This method is useful mainly for GtkRange subclasses. + + + + + gtk.Range.set_slider_size_fixed + + + set_slider_size_fixed + size_fixed + + + + size_fixed : + True to make the slider size constant. + + + + + This method is available in PyGTK 2.22 and above. + + + The set_slider_size_fixed() method sets whether the + range's slider has a fixed size, or a size that depends on it's adjustment's page + size. + + This method is useful mainly for GtkRange subclasses. + + + + + gtk.Range.get_slider_size_fixed + + + get_slider_size_fixed + + + + + Returns : + True when the range's slider has a fixed size. + + + + + This method is available in PyGTK 2.22 and above. + + + The get_slider_size_fixed() method returns whether the + range's slider has a fixed size, or a size that depends on it's adjustment's page + size. + + + + + gtk.Range.set_flippable + + + set_flippable + flippable + + + + flippable : + True to make the range flippable. + + + + + This method is available in PyGTK 2.22 and above. + + + The set_flippable() method sets whether the + range is flippable. If a range is flippable, it will switch its direction if + it is horizontal and its direction is gtk.TEXT_DIR_RTL. + + + + + gtk.Range.get_flippable + + + get_flippable + + + + + Returns : + >True if the range is flippable. + + + + + This method is available in PyGTK 2.22 and above. + + + The get_flippable() method returns whether the + range is flippable. + + + + + gtk.Range.set_lower_stepper_sensitivity + + + set_lower_stepper_sensitivity + sensitivity + + + + sensitivity : + the lower stepper's sensitivity policy.. + + + + The set_lower_stepper_sensitivity() method sets the + sensitivity policy for the stepper that points to the 'lower' end of the range's + adjustment. + + + + + gtk.Range.get_lower_stepper_sensitivity + + + get_lower_stepper_sensitivity + + + + + Returns : + The lower stepper's sensitivity policy. + + + + The get_lower_stepper_sensitivity() method gets the + sensitivity policy for the stepper that points to the 'lower' end of the range's + adjustment. + + + + + gtk.Range.set_upper_stepper_sensitivity + + + set_upper_stepper_sensitivity + sensitivity + + + + sensitivity : + The upper stepper's sensitivity policy. + + + + The set_upper_stepper_sensitivity() method sets the + sensitivity policy for the stepper that points to the 'upper' end of the range's + adjustment. + + + + + gtk.Range.get_upper_stepper_sensitivity + + + get_upper_stepper_sensitivity + + + + + Returns : + The upper stepper's sensitivity policy. + + + + The get_upper_stepper_sensitivity() method gets the + sensitivity policy for the stepper that points to the 'upper' end of the range's + adjustment. + + + -- cgit v1.2.1