ctk_range_get_fill_level ()

gdouble
ctk_range_get_fill_level (CtkRange *range);

Gets the current position of the fill level indicator.

Since: 2.12

ctk_range_get_restrict_to_fill_level ()

gboolean
ctk_range_get_restrict_to_fill_level (CtkRange *range);

Gets whether the range is restricted to the fill level.

Since: 2.12

ctk_range_get_show_fill_level ()

gboolean
ctk_range_get_show_fill_level (CtkRange *range);

Gets whether the range displays the fill level graphically.

Since: 2.12

ctk_range_set_fill_level ()

void
ctk_range_set_fill_level (CtkRange *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 ctk_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 ctk_range_set_restrict_to_fill_level() and is by default enabled.

Since: 2.12

ctk_range_set_restrict_to_fill_level ()

void
ctk_range_set_restrict_to_fill_level (CtkRange *range,
                                      gboolean restrict_to_fill_level);

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

Since: 2.12

ctk_range_set_show_fill_level ()

void
ctk_range_set_show_fill_level (CtkRange *range,
                               gboolean show_fill_level);

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

Since: 2.12

ctk_range_get_adjustment ()

CtkAdjustment *
ctk_range_get_adjustment (CtkRange *range);

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

ctk_range_set_adjustment ()

void
ctk_range_set_adjustment (CtkRange *range,
                          CtkAdjustment *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 CtkScale and nonzero for CtkScrollbar, and indicates the size of the visible area of the widget being scrolled. The page size affects the size of the scrollbar slider.

ctk_range_get_inverted ()

gboolean
ctk_range_get_inverted (CtkRange *range);

Gets the value set by ctk_range_set_inverted().

ctk_range_set_inverted ()

void
ctk_range_set_inverted (CtkRange *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.

ctk_range_get_value ()

gdouble
ctk_range_get_value (CtkRange *range);

Gets the current value of the range.

ctk_range_set_value ()

void
ctk_range_set_value (CtkRange *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.

ctk_range_set_increments ()

void
ctk_range_set_increments (CtkRange *range,
                          gdouble step,
                          gdouble page);

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

ctk_range_set_range ()

void
ctk_range_set_range (CtkRange *range,
                     gdouble min,
                     gdouble max);

Sets the allowable values in the CtkRange, 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.)

ctk_range_get_round_digits ()

gint
ctk_range_get_round_digits (CtkRange *range);

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

Since: 2.24

ctk_range_set_round_digits ()

void
ctk_range_set_round_digits (CtkRange *range,
                            gint round_digits);

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

Since: 2.24

ctk_range_set_lower_stepper_sensitivity ()

void
ctk_range_set_lower_stepper_sensitivity
                               (CtkRange *range,
                                CtkSensitivityType sensitivity);

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

Since: 2.10

ctk_range_get_lower_stepper_sensitivity ()

CtkSensitivityType
ctk_range_get_lower_stepper_sensitivity
                               (CtkRange *range);

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

Since: 2.10

ctk_range_set_upper_stepper_sensitivity ()

void
ctk_range_set_upper_stepper_sensitivity
                               (CtkRange *range,
                                CtkSensitivityType sensitivity);

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

Since: 2.10

ctk_range_get_upper_stepper_sensitivity ()

CtkSensitivityType
ctk_range_get_upper_stepper_sensitivity
                               (CtkRange *range);

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

Since: 2.10

ctk_range_get_flippable ()

gboolean
ctk_range_get_flippable (CtkRange *range);

Gets the value set by ctk_range_set_flippable().

Since: 2.18

ctk_range_set_flippable ()

void
ctk_range_set_flippable (CtkRange *range,
                         gboolean flippable);

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

See ctk_widget_get_direction().

Since: 2.18

ctk_range_get_min_slider_size ()

gint
ctk_range_get_min_slider_size (CtkRange *range);

This function is useful mainly for CtkRange subclasses.

See ctk_range_set_min_slider_size().

Since: 2.20

ctk_range_get_range_rect ()

void
ctk_range_get_range_rect (CtkRange *range,
                          CdkRectangle *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 CtkRange subclasses.

Since: 2.20

ctk_range_get_slider_range ()

void
ctk_range_get_slider_range (CtkRange *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 CtkRange subclasses.

Since: 2.20

ctk_range_get_slider_size_fixed ()

gboolean
ctk_range_get_slider_size_fixed (CtkRange *range);

This function is useful mainly for CtkRange subclasses.

See ctk_range_set_slider_size_fixed().

Since: 2.20

ctk_range_set_min_slider_size ()

void
ctk_range_set_min_slider_size (CtkRange *range,
                               gint min_size);

Sets the minimum size of the range’s slider.

This function is useful mainly for CtkRange subclasses.

Since: 2.20

ctk_range_set_slider_size_fixed ()

void
ctk_range_set_slider_size_fixed (CtkRange *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 CtkRange subclasses.

Since: 2.20

struct CtkRange

struct CtkRange;

enum CtkSensitivityType

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

The “adjustment” property

  “adjustment”               CtkAdjustment *

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

Owner: CtkRange

Flags: Read / Write / Construct

The “fill-level” property

  “fill-level”               double

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

Owner: CtkRange

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: CtkRange

Flags: Read / Write

Default value: FALSE

The “lower-stepper-sensitivity” property

  “lower-stepper-sensitivity” CtkSensitivityType

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

Owner: CtkRange

Flags: Read / Write

Default value: CTK_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 ctk_range_set_restrict_to_fill_level().

Owner: CtkRange

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: CtkRange

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 ctk_range_set_show_fill_level().

Owner: CtkRange

Flags: Read / Write

Default value: FALSE

Since: 2.12

The “upper-stepper-sensitivity” property

  “upper-stepper-sensitivity” CtkSensitivityType

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

Owner: CtkRange

Flags: Read / Write

Default value: CTK_SENSITIVITY_AUTO

The “adjust-bounds” signal

void
user_function (CtkRange *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 (CtkRange     *range,
               CtkScrollType 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 CTK+ handler is reached.

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

Flags: Run Last

Since: 2.6

The “move-slider” signal

void
user_function (CtkRange     *range,
               CtkScrollType step,
               gpointer      user_data)

Virtual function that moves the slider. Used for keybindings.

Flags: Action

The “value-changed” signal

void
user_function (CtkRange *range,
               gpointer  user_data)

Emitted when the range value changes.

Flags: Run Last