GtkRange

gtk_range_get_fill_level ()

gdouble
gtk_range_get_fill_level (GtkRange *range);

Gets the current position of the fill level indicator.

Since: 2.12

gtk_range_get_restrict_to_fill_level ()

gboolean
gtk_range_get_restrict_to_fill_level (GtkRange *range);

Gets whether the range is restricted to the fill level.

Since: 2.12

gtk_range_get_show_fill_level ()

gboolean
gtk_range_get_show_fill_level (GtkRange *range);

Gets whether the range displays the fill level graphically.

Since: 2.12

gtk_range_set_fill_level ()

void
gtk_range_set_fill_level (GtkRange *range,
                          gdouble fill_level);

Set the new position of the fill level indicator.

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.

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 gtk_range_set_show_fill_level(). The range defaults to not showing the fill level.

Additionally, it’s possible to restrict the range’s slider position to values which are smaller than the fill level. This is controller by gtk_range_set_restrict_to_fill_level() and is by default enabled.

Since: 2.12

gtk_range_set_restrict_to_fill_level ()

void
gtk_range_set_restrict_to_fill_level (GtkRange *range,
                                      gboolean restrict_to_fill_level);

Sets whether the slider is restricted to the fill level. See gtk_range_set_fill_level() for a general description of the fill level concept.

Since: 2.12

gtk_range_set_show_fill_level ()

void
gtk_range_set_show_fill_level (GtkRange *range,
                               gboolean show_fill_level);

Sets whether a graphical fill level is show on the trough. See gtk_range_set_fill_level() for a general description of the fill level concept.

Since: 2.12

gtk_range_get_adjustment ()

GtkAdjustment *
gtk_range_get_adjustment (GtkRange *range);

Get the GtkAdjustment which is the “model” object for GtkRange. See gtk_range_set_adjustment() for details. The return value does not have a reference added, so should not be unreferenced.

gtk_range_set_adjustment ()

void
gtk_range_set_adjustment (GtkRange *range,
                          GtkAdjustment *adjustment);

Sets the adjustment to be used as the “model” object for this range widget. The adjustment indicates the current range value, the minimum and maximum range values, the step/page increments used for keybindings and scrolling, and the page size. The page size is normally 0 for GtkScale and nonzero for GtkScrollbar, and indicates the size of the visible area of the widget being scrolled. The page size affects the size of the scrollbar slider.

gtk_range_get_inverted ()

gboolean
gtk_range_get_inverted (GtkRange *range);

Gets the value set by gtk_range_set_inverted().

gtk_range_set_inverted ()

void
gtk_range_set_inverted (GtkRange *range,
                        gboolean setting);

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 on the right rather than on the bottom or left.

gtk_range_get_value ()

gdouble
gtk_range_get_value (GtkRange *range);

Gets the current value of the range.

gtk_range_set_value ()

void
gtk_range_set_value (GtkRange *range,
                     gdouble value);

Sets the current value of the range; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The range emits the “value-changed” signal if the value changes.

gtk_range_set_increments ()

void
gtk_range_set_increments (GtkRange *range,
                          gdouble step,
                          gdouble page);

Sets the step and page sizes for the range. The step size is used when the user clicks the GtkScrollbar arrows or moves GtkScale via arrow keys. The page size is used for example when moving via Page Up or Page Down keys.

gtk_range_set_range ()

void
gtk_range_set_range (GtkRange *range,
                     gdouble min,
                     gdouble max);

Sets the allowable values in the GtkRange, and clamps the range value to be between min and max . (If the range has a non-zero page size, it is clamped between min and max - page-size.)

gtk_range_get_round_digits ()

gint
gtk_range_get_round_digits (GtkRange *range);

Gets the number of digits to round the value to when it changes. See “change-value”.

Since: 2.24

gtk_range_set_round_digits ()

void
gtk_range_set_round_digits (GtkRange *range,
                            gint round_digits);

Sets the number of digits to round the value to when it changes. See “change-value”.

Since: 2.24

gtk_range_set_lower_stepper_sensitivity ()

void
gtk_range_set_lower_stepper_sensitivity
                               (GtkRange *range,
                                GtkSensitivityType sensitivity);

Sets the sensitivity policy for the stepper that points to the 'lower' end of the GtkRange’s adjustment.

Since: 2.10

gtk_range_get_lower_stepper_sensitivity ()

GtkSensitivityType
gtk_range_get_lower_stepper_sensitivity
                               (GtkRange *range);

Gets the sensitivity policy for the stepper that points to the 'lower' end of the GtkRange’s adjustment.

Since: 2.10

gtk_range_set_upper_stepper_sensitivity ()

void
gtk_range_set_upper_stepper_sensitivity
                               (GtkRange *range,
                                GtkSensitivityType sensitivity);

Sets the sensitivity policy for the stepper that points to the 'upper' end of the GtkRange’s adjustment.

Since: 2.10

gtk_range_get_upper_stepper_sensitivity ()

GtkSensitivityType
gtk_range_get_upper_stepper_sensitivity
                               (GtkRange *range);

Gets the sensitivity policy for the stepper that points to the 'upper' end of the GtkRange’s adjustment.

Since: 2.10

gtk_range_get_flippable ()

gboolean
gtk_range_get_flippable (GtkRange *range);

Gets the value set by gtk_range_set_flippable().

Since: 2.18

gtk_range_set_flippable ()

void
gtk_range_set_flippable (GtkRange *range,
                         gboolean flippable);

If a range is flippable, it will switch its direction if it is horizontal and its direction is GTK_TEXT_DIR_RTL.

See gtk_widget_get_direction().

Since: 2.18

gtk_range_get_min_slider_size ()

gint
gtk_range_get_min_slider_size (GtkRange *range);

This function is useful mainly for GtkRange subclasses.

See gtk_range_set_min_slider_size().

Since: 2.20

gtk_range_get_range_rect ()

void
gtk_range_get_range_rect (GtkRange *range,
                          GdkRectangle *range_rect);

This function returns the area that contains the range’s trough and its steppers, in widget->window coordinates.

This function is useful mainly for GtkRange subclasses.

Since: 2.20

gtk_range_get_slider_range ()

void
gtk_range_get_slider_range (GtkRange *range,
                            gint *slider_start,
                            gint *slider_end);

This function returns sliders range along the long dimension, in widget->window coordinates.

This function is useful mainly for GtkRange subclasses.

Since: 2.20

gtk_range_get_slider_size_fixed ()

gboolean
gtk_range_get_slider_size_fixed (GtkRange *range);

This function is useful mainly for GtkRange subclasses.

See gtk_range_set_slider_size_fixed().

Since: 2.20

gtk_range_set_min_slider_size ()

void
gtk_range_set_min_slider_size (GtkRange *range,
                               gint min_size);

Sets the minimum size of the range’s slider.

This function is useful mainly for GtkRange subclasses.

Since: 2.20

gtk_range_set_slider_size_fixed ()

void
gtk_range_set_slider_size_fixed (GtkRange *range,
                                 gboolean size_fixed);

Sets whether the range’s slider has a fixed size, or a size that depends on its adjustment’s page size.

This function is useful mainly for GtkRange subclasses.

Since: 2.20

struct GtkRange

struct GtkRange;

enum GtkSensitivityType

Determines how GTK+ handles the sensitivity of stepper arrows at the end of range widgets.

The “adjustment” property

  “adjustment”               GtkAdjustment *

The GtkAdjustment that contains the current value of this range object.

Owner: GtkRange

Flags: Read / Write / Construct

The “fill-level” property

  “fill-level”               double

The fill level (e.g. prebuffering of a network stream). See gtk_range_set_fill_level().

Owner: GtkRange

Flags: Read / Write

Default value: 1.79769e+308

Since: 2.12

The “inverted” property

  “inverted”                 gboolean

Invert direction slider moves to increase range value.

Owner: GtkRange

Flags: Read / Write

Default value: FALSE

The “lower-stepper-sensitivity” property

  “lower-stepper-sensitivity” GtkSensitivityType

The sensitivity policy for the stepper that points to the adjustment's lower side.

Owner: GtkRange

Flags: Read / Write

Default value: GTK_SENSITIVITY_AUTO

The “restrict-to-fill-level” property

  “restrict-to-fill-level”   gboolean

The restrict-to-fill-level property controls whether slider movement is restricted to an upper boundary set by the fill level. See gtk_range_set_restrict_to_fill_level().

Owner: GtkRange

Flags: Read / Write

Default value: TRUE

Since: 2.12

The “round-digits” property

  “round-digits”             int

The number of digits to round the value to when it changes, or -1. See “change-value”.

Owner: GtkRange

Flags: Read / Write

Allowed values: >= -1

Default value: -1

Since: 2.24

The “show-fill-level” property

  “show-fill-level”          gboolean

The show-fill-level property controls whether fill level indicator graphics are displayed on the trough. See gtk_range_set_show_fill_level().

Owner: GtkRange

Flags: Read / Write

Default value: FALSE

Since: 2.12

The “upper-stepper-sensitivity” property

  “upper-stepper-sensitivity” GtkSensitivityType

The sensitivity policy for the stepper that points to the adjustment's upper side.

Owner: GtkRange

Flags: Read / Write

Default value: GTK_SENSITIVITY_AUTO

The “arrow-displacement-x” style property

  “arrow-displacement-x”     int

How far in the x direction to move the arrow when the button is depressed.

Owner: GtkRange

Flags: Read

Default value: 0

The “arrow-displacement-y” style property

  “arrow-displacement-y”     int

How far in the y direction to move the arrow when the button is depressed.

Owner: GtkRange

Flags: Read

Default value: 0

The “arrow-scaling” style property

  “arrow-scaling”            float

The arrow size proportion relative to the scroll button size.

Owner: GtkRange

Flags: Read

Allowed values: [0,1]

Default value: 0.5

Since: 2.14

The “slider-width” style property

  “slider-width”             int

Width of scrollbar or scale thumb.

Owner: GtkRange

Flags: Read

Allowed values: >= 0

Default value: 14

The “stepper-size” style property

  “stepper-size”             int

Length of step buttons at ends.

Owner: GtkRange

Flags: Read

Allowed values: >= 0

Default value: 14

The “stepper-spacing” style property

  “stepper-spacing”          int

The spacing between the stepper buttons and thumb. Note that stepper-spacing won't have any effect if there are no steppers.

Owner: GtkRange

Flags: Read

Allowed values: >= 0

Default value: 0

The “trough-border” style property

  “trough-border”            int

Spacing between thumb/steppers and outer trough bevel.

Owner: GtkRange

Flags: Read

Allowed values: >= 0

Default value: 1

The “trough-under-steppers” style property

  “trough-under-steppers”    gboolean

Whether to draw the trough across the full length of the range or to exclude the steppers and their spacing.

Owner: GtkRange

Flags: Read

Default value: TRUE

Since: 2.10

The “adjust-bounds” signal

void
user_function (GtkRange *range,
               double    value,
               gpointer  user_data)

Emitted before clamping a value, to give the application a chance to adjust the bounds.

Flags: Run Last

The “change-value” signal

gboolean
user_function (GtkRange     *range,
               GtkScrollType scroll,
               double        value,
               gpointer      user_data)

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 TRUE to prevent further processing. Or, by returning FALSE, it can pass the event to other handlers until the default GTK+ handler is reached.

The value parameter is unrounded. An application that overrides the GtkRange::change-value signal is responsible for clamping the value to the desired number of decimal digits; the default GTK+ handler clamps the value based on “round-digits”.

Flags: Run Last

Since: 2.6

The “move-slider” signal

void
user_function (GtkRange     *range,
               GtkScrollType step,
               gpointer      user_data)

Virtual function that moves the slider. Used for keybindings.

Flags: Action

The “value-changed” signal

void
user_function (GtkRange *range,
               gpointer  user_data)

Emitted when the range value changes.

Flags: Run Last