Class: Gtk::ScaleButton

Inherits:
Widget
  • Object
show all
Defined in:
lib/gtk4/scale-button.rb

Direct Known Subclasses

VolumeButton

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_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=, #children, #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, #error_bell, #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, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #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, #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=

Constructor Details

#initialize(options = {}) ⇒ Gtk::Widget

Creates a GtkScaleButton.

The new scale button has a range between min and max, with a stepping of step.

Parameters:

  • min (Float) —

    the minimum value of the scale (usually 0)

  • max (Float) —

    the maximum value of the scale (usually 100)

  • step (Float) —

    the stepping of value when a scroll-wheel event, or up/down arrow event occurs (usually 2)

  • icons (Array<String>) —

    a nil-terminated array of icon names, or nil if you want to set the list later with gtk_scale_button_set_icons()



20
21
22
23
24
25
26
 
# File 'lib/gtk4/scale-button.rb', line 20

def initialize(options={})
  min       = options[:min]   || 0
  max       = options[:max]   || 100
  step      = options[:step]  || 2
  icons     = options[:icons] || nil
  initialize_raw(min, max, step, icons)
end

Instance Method Details

#active ⇒ Boolean

Queries a GtkScaleButton and returns its current state.

Returns true if the scale button is pressed in and false if it is raised.

Returns:

  • (Boolean) —

    whether the button is pressed

#active=(active) ⇒ Boolean

If the scale button should be pressed in.

Parameters:

  • active (Boolean)

Returns:

  • (Boolean) —

    active

  • (Boolean) —

    active

#active? ⇒ Boolean

If the scale button should be pressed in.

Returns:

  • (Boolean) —

    active

#adjustment ⇒ Gtk::Adjustment

The GtkAdjustment that is used as the model.

Returns:

#adjustment=(adjustment) ⇒ Gtk::Adjustment

The GtkAdjustment that is used as the model.

Parameters:

Returns:

#has_frame ⇒ Boolean

Returns whether the button has a frame.

Returns:

  • (Boolean) —

    true if the button has a frame

#has_frame=(has_frame) ⇒ Boolean

If the scale button has a frame.

Parameters:

  • has_frame (Boolean)

Returns:

  • (Boolean) —

    has-frame

  • (Boolean) —

    has-frame

#has_frame? ⇒ Boolean

If the scale button has a frame.

Returns:

  • (Boolean) —

    has-frame

#icons ⇒ Gtk::

The names of the icons to be used by the scale button.

The first item in the array will be used in the button when the current value is the lowest value, the second item for the highest value. All the subsequent icons will be used for all the other values, spread evenly over the range of values.

If there's only one icon name in the icons array, it will be used for all the values. If only two icon names are in the icons array, the first one will be used for the bottom 50% of the scale, and the second one for the top 50%.

It is recommended to use at least 3 icons so that the GtkScaleButton reflects the current value of the scale better for the users.

Returns:

#icons=(icons) ⇒ Gtk::

The names of the icons to be used by the scale button.

The first item in the array will be used in the button when the current value is the lowest value, the second item for the highest value. All the subsequent icons will be used for all the other values, spread evenly over the range of values.

If there's only one icon name in the icons array, it will be used for all the values. If only two icon names are in the icons array, the first one will be used for the bottom 50% of the scale, and the second one for the top 50%.

It is recommended to use at least 3 icons so that the GtkScaleButton reflects the current value of the scale better for the users.

Parameters:

Returns:

#initialize_raw ⇒ Gtk::Widget

Creates a GtkScaleButton.

The new scale button has a range between min and max, with a stepping of step.

Parameters:

  • min (Float) —

    the minimum value of the scale (usually 0)

  • max (Float) —

    the maximum value of the scale (usually 100)

  • step (Float) —

    the stepping of value when a scroll-wheel event, or up/down arrow event occurs (usually 2)

  • icons (Array<String>) —

    a nil-terminated array of icon names, or nil if you want to set the list later with gtk_scale_button_set_icons()

Returns:




# File 'lib/gtk4/scale-button.rb', line 19

#minus_button ⇒ Gtk::Button

Retrieves the minus button of the GtkScaleButton.

Returns:

  • (Gtk::Button) —

    the minus button of the GtkScaleButton

#plus_button ⇒ Gtk::Button

Retrieves the plus button of the GtkScaleButton.

Returns:

  • (Gtk::Button) —

    the plus button of the GtkScaleButton

#popup ⇒ Gtk::Widget

Retrieves the popup of the GtkScaleButton.

Returns:

#value ⇒ Float

The value of the scale.

Returns:

  • (Float) —

    value

#value=(value) ⇒ Float

The value of the scale.

Parameters:

  • value (Float)

Returns:

  • (Float) —

    value

  • (Float) —

    value