class Gtk::Paned

• Gtk::Paned
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

A widget with two panes, arranged either horizontally or vertically.

The division between the two panes is adjustable by the user by dragging a handle.

Child widgets are added to the panes of the widget with Gtk::Paned#start_child= and Gtk::Paned#end_child=. The division between the two children is set by default from the size requests of the children, but it can be adjusted by the user.

A paned widget draws a separator between the two child widgets and a small handle that the user can drag to adjust the division. It does not draw any relief around the children or around the separator. (The space in which the separator is called the gutter.) Often, it is useful to put each child inside a Gtk::Frame so that the gutter appears as a ridge. No separator is drawn if one of the children is missing.

Each child has two options that can be set, "resize" and "shrink". If "resize" is true then, when the Gtk::Paned is resized, that child will expand or shrink along with the paned widget. If "shrink" is true, then that child can be made smaller than its requisition by the user. Setting "shrink" to false allows the application to set a minimum size. If "resize" is false for both children, then this is treated as if "resize" is true for both children.

The application can set the position of the slider as if it were set by the user, by calling Gtk::Paned#position=.

CSS nodes

paned
├── <child>
├── separator[.wide]
╰── <child>

Gtk::Paned has a main CSS node with name paned, and a subnode for the separator with name separator. The subnode gets a .wide style class when the paned is supposed to be wide.

In horizontal orientation, the nodes are arranged based on the text direction, so in left-to-right mode, :first-child will select the leftmost child, while it will select the rightmost child in RTL layouts.

Creating a paned widget with minimum sizes.

WARNING ⚠️ The following code is in c ⚠️

Gtk::Widget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL);
Gtk::Widget *frame1 = gtk_frame_new (NULL);
Gtk::Widget *frame2 = gtk_frame_new (NULL);

gtk_widget_set_size_request (hpaned, 200, -1);

gtk_paned_set_start_child (GTK_PANED (hpaned), frame1);
gtk_paned_set_start_child_resize (GTK_PANED (hpaned), TRUE);
gtk_paned_set_start_child_shrink (GTK_PANED (hpaned), FALSE);
gtk_widget_set_size_request (frame1, 50, -1);

gtk_paned_set_end_child (GTK_PANED (hpaned), frame2);
gtk_paned_set_end_child_resize (GTK_PANED (hpaned), FALSE);
gtk_paned_set_end_child_shrink (GTK_PANED (hpaned), FALSE);
gtk_widget_set_size_request (frame2, 50, -1);

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget
• Gtk::Orientable

Defined in:

Constructors

• .new(orientation : Gtk::Orientation) : self

  Creates a new Gtk::Paned widget.

• .new

  Initialize a new Paned.

• .new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, cursor : Gdk::Cursor | Nil = nil, end_child : Gtk::Widget | Nil = nil, focus_on_click : Bool | Nil = nil, focusable : Bool | Nil = nil, halign : Gtk::Align | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, max_position : Int32 | Nil = nil, min_position : Int32 | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, orientation : Gtk::Orientation | Nil = nil, overflow : Gtk::Overflow | Nil = nil, parent : Gtk::Widget | Nil = nil, position : Int32 | Nil = nil, position_set : Bool | Nil = nil, receives_default : Bool | Nil = nil, resize_end_child : Bool | Nil = nil, resize_start_child : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, shrink_end_child : Bool | Nil = nil, shrink_start_child : Bool | Nil = nil, start_child : Gtk::Widget | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, valign : Gtk::Align | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, wide_handle : Bool | Nil = nil, width_request : Int32 | Nil = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #accept_position_signal
• #cancel_position_signal
• #cycle_child_focus_signal
• #cycle_handle_focus_signal
• #end_child : Gtk::Widget | Nil

  Retrieves the end child of the given Gtk::Paned.

• #end_child=(child : Gtk::Widget | Nil) : Nil

  Sets the end child of paned to child.

• #hash(hasher)

  See Object#hash(hasher)

• #max_position : Int32
• #min_position : Int32
• #move_handle_signal
• #position : Int32

  Obtains the position of the divider between the two panes.

• #position=(position : Int32) : Nil

  Sets the position of the divider between the two panes.

• #position_set=(value : Bool) : Bool
• #position_set? : Bool
• #resize_end_child : Bool

  Returns whether the [property@Gtk.Paned:end-child] can be resized.

• #resize_end_child=(resize : Bool) : Nil

  Sets whether the [property@Gtk.Paned:end-child] can be resized.

• #resize_end_child? : Bool
• #resize_start_child : Bool

  Returns whether the [property@Gtk.Paned:start-child] can be resized.

• #resize_start_child=(resize : Bool) : Nil

  Sets whether the [property@Gtk.Paned:start-child] can be resized.

• #resize_start_child? : Bool
• #shrink_end_child : Bool

  Returns whether the [property@Gtk.Paned:end-child] can shrink.

• #shrink_end_child=(resize : Bool) : Nil

  Sets whether the [property@Gtk.Paned:end-child] can shrink.

• #shrink_end_child? : Bool
• #shrink_start_child : Bool

  Returns whether the [property@Gtk.Paned:start-child] can shrink.

• #shrink_start_child=(resize : Bool) : Nil

  Sets whether the [property@Gtk.Paned:start-child] can shrink.

• #shrink_start_child? : Bool
• #start_child : Gtk::Widget | Nil

  Retrieves the start child of the given Gtk::Paned.

• #start_child=(child : Gtk::Widget | Nil) : Nil

  Sets the start child of paned to child.

• #toggle_handle_focus_signal
• #wide_handle : Bool

  Gets whether the separator should be wide.

• #wide_handle=(wide : Bool) : Nil

  Sets whether the separator should be wide.

• #wide_handle? : Bool

Constructor Detail

Class Method Detail

Instance Method Detail