Class: Gtk::Box

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

Direct Known Subclasses

ShortcutsGroup, ShortcutsSection

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=

Constructor Details

#initialize(orientation, spacing = 0) ⇒ Gtk::Widget

Creates a new GtkBox.

Parameters:

  • orientation (Gtk::Orientation) —

    the box’s orientation

  • spacing (Integer) (defaults to: 0) —

    the number of pixels to place by default between children



20
21
22
 
# File 'lib/gtk3/box.rb', line 20

def initialize(orientation, spacing=0)
  initialize_raw(orientation, spacing || 0)
end

Instance Method Details

#append(child) ⇒ nil

Adds child as the last child to box.

Parameters:

Returns:

  • (nil)

#baseline_child ⇒ Integer

The child that determines the baseline, in vertical orientation.

Returns:

  • (Integer) —

    baseline-child

#baseline_child=(baseline_child) ⇒ Integer

The child that determines the baseline, in vertical orientation.

Parameters:

  • baseline_child (Integer)

Returns:

  • (Integer) —

    baseline-child

  • (Integer) —

    baseline-child

#baseline_position ⇒ Gtk::BaselinePosition

The position of the baseline aligned widgets if extra space is available.

Returns:

#baseline_position=(baseline_position) ⇒ Gtk::BaselinePosition

The position of the baseline aligned widgets if extra space is available.

Parameters:

Returns:

#homogeneous ⇒ Boolean

Returns whether the box is homogeneous (all children are the same size).

Returns:

  • (Boolean) —

    true if the box is homogeneous.

#homogeneous=(homogeneous) ⇒ Boolean

Whether the children should all be the same size.

Parameters:

  • homogeneous (Boolean)

Returns:

  • (Boolean) —

    homogeneous

  • (Boolean) —

    homogeneous

#homogeneous? ⇒ Boolean

Whether the children should all be the same size.

Returns:

  • (Boolean) —

    homogeneous

#initialize_raw ⇒ Gtk::Widget

Creates a new GtkBox.

Parameters:

  • orientation (Gtk::Orientation) —

    the box’s orientation

  • spacing (Integer) —

    the number of pixels to place by default between children

Returns:




# File 'lib/gtk3/box.rb', line 19

#insert_child_after(child, sibling) ⇒ nil

Inserts child in the position after sibling in the list of box children.

If sibling is nil, insert child at the first position.

Parameters:

  • child (Gtk::Widget) —

    the GtkWidget to insert

  • sibling (Gtk::Widget) —

    the sibling after which to insert child

Returns:

  • (nil)

#pack_end(child, options = {}) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/gtk3/box.rb', line 33

def pack_end(child, options={})
  expand  = options[:expand]  || false
  fill    = options[:fill]    || false
  padding = options[:padding] || 0
  pack_end_raw(child, expand, fill, padding)
end

#pack_end_raw ⇒ Object 



32
 
# File 'lib/gtk3/box.rb', line 32

alias_method :pack_end_raw, :pack_end

#pack_start(child, options = {}) ⇒ Object 



25
26
27
28
29
30
 
# File 'lib/gtk3/box.rb', line 25

def pack_start(child, options={})
  expand  = options[:expand]  || false
  fill    = options[:fill]    || false
  padding = options[:padding] || 0
  pack_start_raw(child, expand, fill, padding)
end

#pack_start_raw ⇒ Object 



24
 
# File 'lib/gtk3/box.rb', line 24

alias_method :pack_start_raw, :pack_start

#prepend(child) ⇒ nil

Adds child as the first child to box.

Parameters:

Returns:

  • (nil)

#remove(child) ⇒ nil

Removes a child widget from box.

The child must have been added before with [methodGtk.Box.append], [methodGtk.Box.prepend], or [methodGtk.Box.insert_child_after].

Parameters:

Returns:

  • (nil)

#reorder_child_after(child, sibling) ⇒ nil

Moves child to the position after sibling in the list of box children.

If sibling is nil, move child to the first position.

Parameters:

  • child (Gtk::Widget) —

    the GtkWidget to move, must be a child of box

  • sibling (Gtk::Widget) —

    the sibling to move child after

Returns:

  • (nil)

#set_child_packing(child, options = {}) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/gtk3/box.rb', line 41

def set_child_packing(child, options={})
  expand    = options[:expand]
  fill      = options[:fill]
  padding   = options[:padding]
  pack_type = options[:pack_type]

  old_expand, old_fill, old_padding, old_pack_type =
    query_child_packing(child)

  expand    = old_expand    if expand.nil?
  fill      = old_fill      if fill.nil?
  padding   = old_padding   if padding.nil?
  pack_type = old_pack_type if pack_type.nil?

  set_child_packing_raw(child,
                        expand,
                        fill,
                        padding,
                        pack_type)
end

#set_child_packing_raw ⇒ Object 



40
 
# File 'lib/gtk3/box.rb', line 40

alias_method :set_child_packing_raw, :set_child_packing

#spacing ⇒ Integer

The amount of space between children.

Returns:

  • (Integer) —

    spacing

#spacing=(spacing) ⇒ Integer

The amount of space between children.

Parameters:

  • spacing (Integer)

Returns:

  • (Integer) —

    spacing

  • (Integer) —

    spacing