Class

GtkRange

Description [src] 

class Gtk.Range : Gtk.Widget
  implements Gtk.Accessible, Gtk.AccessibleRange, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
  /* No available fields */
}

GtkRange is the common base class for widgets which visualize an adjustment.

Widgets that are derived from GtkRange include GtkScale and GtkScrollbar.

Apart from signals for monitoring the parameters of the adjustment, GtkRange provides properties and methods for setting a “fill level” on range widgets. See gtk_range_set_fill_level().

Shortcuts and Gestures

The GtkRange slider is draggable. Holding the Shift key while dragging, or initiating the drag with a long-press will enable the fine-tuning mode.

Hierarchy

hierarchy this GtkRange implements_0 GtkAccessible this--implements_0 implements_1 GtkAccessibleRange this--implements_1 implements_2 GtkBuildable this--implements_2 implements_3 GtkConstraintTarget this--implements_3 implements_4 GtkOrientable this--implements_4 ancestor_0 GtkWidget ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Ancestors

Descendants

Implements

Instance methods

gtk_range_get_adjustment

Get the adjustment which is the “model” object for GtkRange.

gtk_range_get_fill_level

Gets the current position of the fill level indicator.

gtk_range_get_flippable

Gets whether the GtkRange respects text direction.

gtk_range_get_inverted

Gets whether the range is inverted.

gtk_range_get_range_rect

This function returns the area that contains the range’s trough, in coordinates relative to range‘s origin.

gtk_range_get_restrict_to_fill_level

Gets whether the range is restricted to the fill level.

gtk_range_get_round_digits

Gets the number of digits to round the value to when it changes.

gtk_range_get_show_fill_level

Gets whether the range displays the fill level graphically.

gtk_range_get_slider_range

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

gtk_range_get_slider_size_fixed

This function is useful mainly for GtkRange subclasses.

gtk_range_get_value

Gets the current value of the range.

gtk_range_set_adjustment

Sets the adjustment to be used as the “model” object for the GtkRange.

gtk_range_set_fill_level

Set the new position of the fill level indicator.

gtk_range_set_flippable

Sets whether the GtkRange respects text direction.

gtk_range_set_increments

Sets the step and page sizes for the range.

gtk_range_set_inverted

Sets whether to invert the range.

gtk_range_set_range

Sets the allowable values in the GtkRange.

gtk_range_set_restrict_to_fill_level

Sets whether the slider is restricted to the fill level.

gtk_range_set_round_digits

Sets the number of digits to round the value to when it changes.

gtk_range_set_show_fill_level

Sets whether a graphical fill level is show on the trough.

gtk_range_set_slider_size_fixed

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

gtk_range_set_value

Sets the current value of the range.

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (19)
gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

since: 4.14

gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

gtk_accessible_get_at_context

Retrieves the accessible implementation for the given GtkAccessible.

since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

gtk_accessible_get_platform_state

Query a platform state, such as focus.

since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of self.

since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkOrientable (2)
gtk_orientable_get_orientation

Retrieves the orientation of the orientable.

gtk_orientable_set_orientation

Sets the orientation of the orientable.

Properties

Gtk.Range:adjustment

The adjustment that is controlled by the range.

Gtk.Range:fill-level

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

Gtk.Range:inverted

If TRUE, the direction in which the slider moves is inverted.

Gtk.Range:restrict-to-fill-level

Controls whether slider movement is restricted to an upper boundary set by the fill level.

Gtk.Range:round-digits

The number of digits to round the value to when it changes.

Gtk.Range:show-fill-level

Controls whether fill level indicator graphics are displayed on the trough.

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the GtkWidget::query-tooltip signal on widget.

Gtk.Widget:height-request

Overrides for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Overrides for width request of the widget.

Properties inherited from GtkAccessible (1)
GtkAccessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkOrientable (1)
GtkOrientable:orientation

The orientation of the orientable.

Signals

Gtk.Range::adjust-bounds

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

Gtk.Range::change-value

Emitted when a scroll action is performed on a range.

Gtk.Range::move-slider

Virtual function that moves the slider.

Gtk.Range::value-changed

Emitted when the range value changes.

Signals inherited from GtkWidget (13)
GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

GtkWidget::hide

Emitted when widget is hidden.

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

GtkWidget::map

Emitted when widget is going to be mapped.

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

GtkWidget::move-focus

Emitted when the focus is moved.

GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

GtkWidget::show

Emitted when widget is shown.

GtkWidget::state-flags-changed

Emitted when the widget state changes.

GtkWidget::unmap

Emitted when widget is going to be unmapped.

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure 

struct GtkRangeClass {
  GtkWidgetClass parent_class;
  void (* value_changed) (
    GtkRange* range
  );
  void (* adjust_bounds) (
    GtkRange* range,
    double new_value
  );
  void (* move_slider) (
    GtkRange* range,
    GtkScrollType scroll
  );
  void (* get_range_border) (
    GtkRange* range,
    GtkBorder* border_
  );
  gboolean (* change_value) (
    GtkRange* range,
    GtkScrollType scroll,
    double new_value
  );
  
}

No description available.

Class members
parent_class: GtkWidgetClass

No description available.

value_changed: void (* value_changed) ( GtkRange* range )

No description available.

adjust_bounds: void (* adjust_bounds) ( GtkRange* range, double new_value )

No description available.

move_slider: void (* move_slider) ( GtkRange* range, GtkScrollType scroll )

No description available.

get_range_border: void (* get_range_border) ( GtkRange* range, GtkBorder* border_ )

No description available.

change_value: gboolean (* change_value) ( GtkRange* range, GtkScrollType scroll, double new_value )

No description available.

Virtual methods

Gtk.RangeClass.adjust_bounds
No description available.

Gtk.RangeClass.change_value
No description available.

Gtk.RangeClass.get_range_border
No description available.

Gtk.RangeClass.move_slider
No description available.

Gtk.RangeClass.value_changed
No description available.