Class: Gtk::Range

Inherits:
Widget
  • Object
show all
Extended by:
GLib::Deprecatable
Defined in:
lib/gtk3/deprecated.rb

Direct Known Subclasses

Scale

Instance Method Summary collapse

Methods inherited from Widget

#accessible_role, #accessible_role=, #action_set_enabled, #activate, #activate_action, #activate_action_variant, #activate_default, #activate_signal, #activate_signal=, #activate_signal_from_name=, #add_binding, #add_binding_action, #add_binding_signal, #add_controller, #add_css_class, #add_events, #add_events_raw, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child, #bind_template_child_full, #can_focus, #can_focus=, #can_focus?, #can_target, #can_target=, #can_target?, #child_focus, #child_visible, #child_visible=, #clipboard, #compute_bounds, #compute_expand, #compute_point, #compute_transform, #contains, #create_pango_context, #create_pango_layout, #css_classes, #css_classes=, #css_name, #css_name=, #cursor, #cursor=, #cursor_from_name=, default_direction, default_direction=, #direction, #direction=, #display, #dispose_template, #drag_check_threshold, #drag_dest_set, #drag_dest_set_raw, #drag_source_set, #drag_source_set_raw, #error_bell, #events, #events_raw, #first_child, #focus_child, #focus_child=, #focus_on_click, #focus_on_click=, #focus_on_click?, #focusable, #focusable=, #focusable?, #font_map, #font_map=, #font_options, #font_options=, #frame_clock, #get_allocation, #get_ancestor, #get_color, #get_preferred_size, #get_size, #get_size_request, #get_template_child, #grab_focus, #halign, #halign=, #has_css_class, #has_default, #has_default=, #has_default?, #has_focus, #has_focus=, #has_focus?, #has_tooltip, #has_tooltip=, #has_tooltip?, #has_visible_focus, have_template?, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_action_group_raw, #insert_after, #insert_before, #install_action, #install_property_action, #is_ancestor, #is_drawable, #is_focus, #is_sensitive, #is_visible, #keynav_failed, #last_child, #layout_manager, #layout_manager=, #layout_manager_type, #layout_manager_type=, #list_mnemonic_labels, #map, #mapped, #margin_bottom, #margin_bottom=, #margin_end, #margin_end=, #margin_start, #margin_start=, #margin_top, #margin_top=, #measure, #mnemonic_activate, #name, #name=, #native, #next_sibling, #observe_children, #observe_controllers, #opacity, #opacity=, #overflow, #overflow=, #pango_context, #parent, #parent=, #pick, #prev_sibling, #primary_clipboard, #query_action, #queue_allocate, #queue_draw, #queue_resize, #realize, #realized, #receives_default, #receives_default=, #receives_default?, #remove_controller, #remove_css_class, #remove_mnemonic_label, #remove_tick_callback, #render_icon_pixbuf, #render_icon_pixbuf_raw, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_allocation, set_connect_func, set_connect_func_raw, #set_events, #set_events_raw, #set_size_request, #set_size_request_raw, #set_state_flags, #set_template, #set_template_raw, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #style_context_raw, #style_get_property, #style_get_property_raw, #template=, template_children, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #translate_coordinates_raw, #trigger_tooltip_query, #unmap, #unparent, #unrealize, #unset_state_flags, #valign, #valign=, #vexpand, #vexpand=, #vexpand?, #vexpand_set, #vexpand_set=, #vexpand_set?, #visible, #visible=, #visible?, #width, #width_request, #width_request=

Instance Method Details

#adjustment ⇒ Gtk::Adjustment

The adjustment that is controlled by the range.

Returns:

#adjustment=(adjustment) ⇒ Gtk::Adjustment

The adjustment that is controlled by the range.

Parameters:

Returns:

#fill_level ⇒ Float

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

Returns:

  • (Float) —

    fill-level

#fill_level=(fill_level) ⇒ Float

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

Parameters:

  • fill_level (Float)

Returns:

  • (Float) —

    fill-level

  • (Float) —

    fill-level

#flippable ⇒ Boolean

Gets whether the GtkRange respects text direction.

See [methodGtk.Range.set_flippable].

Returns:

  • (Boolean) —

    true if the range is flippable

#flippable=(flippable) ⇒ nil

Sets whether the GtkRange respects text direction.

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

See [methodGtk.Widget.get_direction].

Parameters:

  • flippable (Boolean) —

    true to make the range flippable

Returns:

  • (nil)

#get_range_rect(range_rect) ⇒ nil

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

This function is useful mainly for GtkRange subclasses.

Parameters:

  • range_rect (Gdk::Rectangle) —

    return location for the range rectangle

Returns:

  • (nil)

#get_slider_range(slider_start, slider_end) ⇒ nil

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

This function is useful mainly for GtkRange subclasses.

Parameters:

  • slider_start (Integer) —

    return location for the slider's start

  • slider_end (Integer) —

    return location for the slider's end

Returns:

  • (nil)

#inverted ⇒ Boolean

Gets whether the range is inverted.

See [methodGtk.Range.set_inverted].

Returns:

  • (Boolean) —

    true if the range is inverted

#inverted=(inverted) ⇒ Boolean

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

Parameters:

  • inverted (Boolean)

Returns:

  • (Boolean) —

    inverted

  • (Boolean) —

    inverted

#inverted? ⇒ Boolean

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

Returns:

  • (Boolean) —

    inverted

#restrict_to_fill_level ⇒ Boolean

Gets whether the range is restricted to the fill level.

Returns:

  • (Boolean) —

    true if range is restricted to the fill level.

#restrict_to_fill_level=(restrict_to_fill_level) ⇒ Boolean

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

Parameters:

  • restrict_to_fill_level (Boolean)

Returns:

  • (Boolean) —

    restrict-to-fill-level

  • (Boolean) —

    restrict-to-fill-level

#restrict_to_fill_level? ⇒ Boolean

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

Returns:

  • (Boolean) —

    restrict-to-fill-level

#round_digits ⇒ Integer

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

See [signalGtk.Range::change-value].

Returns:

  • (Integer) —

    round-digits

#round_digits=(round_digits) ⇒ Integer

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

See [signalGtk.Range::change-value].

Parameters:

  • round_digits (Integer)

Returns:

  • (Integer) —

    round-digits

  • (Integer) —

    round-digits

#set_increments(step, page) ⇒ nil

Sets the step and page sizes for the range.

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

Parameters:

  • step (Float) —

    step size

  • page (Float) —

    page size

Returns:

  • (nil)

#set_range(min, max) ⇒ nil

Sets the allowable values in the GtkRange.

The range value is clamped to be between min and max. (If the range has a non-zero page size, it is clamped between min and max - page-size.)

Parameters:

  • min (Float) —

    minimum range value

  • max (Float) —

    maximum range value

Returns:

  • (nil)

#show_fill_level ⇒ Boolean

Gets whether the range displays the fill level graphically.

Returns:

  • (Boolean) —

    true if range shows the fill level.

#show_fill_level=(show_fill_level) ⇒ Boolean

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

Parameters:

  • show_fill_level (Boolean)

Returns:

  • (Boolean) —

    show-fill-level

  • (Boolean) —

    show-fill-level

#show_fill_level? ⇒ Boolean

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

Returns:

  • (Boolean) —

    show-fill-level

#slider_size_fixed ⇒ Boolean

This function is useful mainly for GtkRange subclasses.

See [methodGtk.Range.set_slider_size_fixed].

Returns:

  • (Boolean) —

    whether the range’s slider has a fixed size.

#slider_size_fixed=(size_fixed) ⇒ nil

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.

Parameters:

  • size_fixed (Boolean) —

    true to make the slider size constant

Returns:

  • (nil)

#value ⇒ Float

Gets the current value of the range.

Returns:

  • (Float) —

    current value of the range.

#value=(value) ⇒ nil

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 [signalGtk.Range::value-changed] signal if the value changes.

Parameters:

  • value (Float) —

    new value of the range

Returns:

  • (nil)