Class: Gtk::ToggleButton

Inherits:
Button
  • Object
show all
Extended by:
GLib::Deprecatable
Defined in:
lib/gtk3/deprecated.rb,
lib/gtk3/toggle-button.rb

Instance Method Summary collapse

Methods inherited from Button

#can_shrink, #can_shrink=, #can_shrink?, #child, #child=, #has_frame, #has_frame=, #has_frame?, #icon_name, #icon_name=, #label, #label=, #use_underline, #use_underline=, #use_underline?

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=

Constructor Details

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

Creates a new GtkToggleButton containing a label.

The label will be created using [ctorGtk.Label.new_with_mnemonic], so underscores in label indicate the mnemonic for the button.

Parameters:

  • label (String) —

    the text of the button, with an underscore in front of the mnemonic character



20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/gtk3/toggle-button.rb', line 20

def initialize(options={})
  label = options[:label]
  use_underline = options[:use_underline]

  if label
    if use_underline
      initialize_new_with_mnemonic(label)
    else
      initialize_new_with_label(label)
    end
  else
    initialize_raw
  end
end

Instance Method Details

#active ⇒ Boolean

Queries a GtkToggleButton and returns its current state.

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

Returns:

  • (Boolean) —

    whether the button is pressed

#active=(active) ⇒ Boolean

If the toggle button should be pressed in.

Parameters:

  • active (Boolean)

Returns:

  • (Boolean) —

    active

  • (Boolean) —

    active

#active? ⇒ Boolean

If the toggle button should be pressed in.

Returns:

  • (Boolean) —

    active

#group=(group) ⇒ Gtk::ToggleButton

The toggle button whose group this widget belongs to.

Parameters:

Returns:

#initialize_raw ⇒ Gtk::Widget

Creates a new GtkToggleButton containing a label.

The label will be created using [ctorGtk.Label.new_with_mnemonic], so underscores in label indicate the mnemonic for the button.

Parameters:

  • label (String) —

    the text of the button, with an underscore in front of the mnemonic character

Returns:




# File 'lib/gtk3/toggle-button.rb', line 19

#toggled ⇒ nil

Emits the ::toggled signal on the GtkToggleButton.

Returns:

  • (nil)