Paned

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_paned_get_type ()" ) ]
public sealed class Paned : Widget, Accessible, AccessibleRange, Buildable, ConstraintTarget, Orientable

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

![An example GtkPaned](panes.png)

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 [method@Gtk.Paned.set_start_child] and [method@Gtk.Paned.set_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 [class@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 `GtkPaned` 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 [method@Gtk.Paned.set_position].

CSS nodes

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

`GtkPaned` 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, GtkPaned:first-child will select the leftmost child, while it will select the rightmost child in RTL layouts.

Creating a paned widget with minimum sizes.

```c GtkWidget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL); GtkWidget *frame1 = gtk_frame_new (NULL); GtkWidget *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_resize_start_child (GTK_PANED (hpaned), TRUE); gtk_paned_set_shrink_start_child (GTK_PANED (hpaned), FALSE); gtk_widget_set_size_request (frame1, 50, -1);

gtk_paned_set_end_child (GTK_PANED (hpaned), frame2); gtk_paned_set_resize_end_child (GTK_PANED (hpaned), FALSE); gtk_paned_set_shrink_end_child (GTK_PANED (hpaned), FALSE); gtk_widget_set_size_request (frame2, 50, -1); ```

Namespace: Gtk

Package: gtk4

Content:

Properties:

public Widget end_child { get; set; }
The second child.
public int max_position { get; }
The largest possible value for the [property@Gtk.
public int min_position { get; }
The smallest possible value for the [property@Gtk.
public int position { get; set; }
Position of the separator in pixels, from the left/top.
public bool position_set { get; set; }
Whether the [property@Gtk.
public bool resize_end_child { get; set; }
Determines whether the second child expands and shrinks along with the paned widget.
public bool resize_start_child { get; set; }
Determines whether the first child expands and shrinks along with the paned widget.
public bool shrink_end_child { get; set; }
Determines whether the second child can be made smaller than its requisition.
public bool shrink_start_child { get; set; }
Determines whether the first child can be made smaller than its requisition.
public Widget start_child { get; set; }
The first child.
public bool wide_handle { get; set; }
Whether the `GtkPaned` should provide a stronger visual separation.

Creation methods:

public Paned (Orientation orientation)
Creates a new `GtkPaned` widget.

Methods:

public unowned Widget? get_end_child ()
Retrieves the end child of the given `GtkPaned`.
public int get_position ()
Obtains the position of the divider between the two panes.
public bool get_resize_end_child ()
Returns whether the [property@Gtk.
public bool get_resize_start_child ()
Returns whether the [property@Gtk.
public bool get_shrink_end_child ()
Returns whether the [property@Gtk.
public bool get_shrink_start_child ()
Returns whether the [property@Gtk.
public unowned Widget? get_start_child ()
Retrieves the start child of the given `GtkPaned`.
public bool get_wide_handle ()
Gets whether the separator should be wide.
public void set_end_child (Widget? child)
Sets the end child of this to child.
public void set_position (int position)
Sets the position of the divider between the two panes.
public void set_resize_end_child (bool resize)
Sets whether the [property@Gtk.
public void set_resize_start_child (bool resize)
Sets whether the [property@Gtk.
public void set_shrink_end_child (bool resize)
Sets whether the [property@Gtk.
public void set_shrink_start_child (bool resize)
Sets whether the [property@Gtk.
public void set_start_child (Widget? child)
Sets the start child of this to child.
public void set_wide_handle (bool wide)
Sets whether the separator should be wide.

Signals:

public signal bool accept_position ()
Emitted to accept the current position of the handle when moving it using key bindings.
public signal bool cancel_position ()
Emitted to cancel moving the position of the handle using key bindings.
public signal bool cycle_child_focus (bool reversed)
Emitted to cycle the focus between the children of the paned.
public signal bool cycle_handle_focus (bool reversed)
Emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings.
public signal bool move_handle (ScrollType scroll_type)
Emitted to move the handle with key bindings.
public signal bool toggle_handle_focus ()
Emitted to accept the current position of the handle and then move focus to the next widget in the focus chain.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.AccessibleRange

set_current_value

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Orientable

get_orientation

orientation

set_orientation