Gtk.Paned

class — extends Widget, Accessible, AccessibleRange, Buildable, ConstraintTarget, Orientable

Arranges its children in two panes, horizontally or vertically.

<picture> <source srcset="panes-dark.png" media="(prefers-color-scheme: dark)"> <img alt="An example GtkPaned" src="panes.png"> </picture>

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 Paned.set_start_child and 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 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 Paned.set_position.

Shortcuts and Gestures

The following signals have default keybindings:

• Paned.accept-position
• Paned.cancel-position
• Paned.cycle-child-focus
• Paned.cycle-handle-focus
• Paned.move-handle
• Paned.toggle-handle-focus

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

Creating a paned widget with minimum sizes.

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);

Constructors

new

@classmethod
def new(cls, orientation: Orientation | int) -> Widget

Creates a new GtkPaned widget.

Parameters:

• orientation — the paned’s orientation.

Methods

get_end_child

def get_end_child(self) -> Widget | None

Retrieves the end child of the given GtkPaned.

get_position

def get_position(self) -> int

Obtains the position of the divider between the two panes.

get_resize_end_child

def get_resize_end_child(self) -> bool

Returns whether the Paned.end-child can be resized.

get_resize_start_child

def get_resize_start_child(self) -> bool

Returns whether the Paned.start-child can be resized.

get_shrink_end_child

def get_shrink_end_child(self) -> bool

Returns whether the Paned.end-child can shrink.

get_shrink_start_child

def get_shrink_start_child(self) -> bool

Returns whether the Paned.start-child can shrink.

get_start_child

def get_start_child(self) -> Widget | None

Retrieves the start child of the given GtkPaned.

get_wide_handle

def get_wide_handle(self) -> bool

Gets whether the separator should be wide.

set_end_child

def set_end_child(self, child: Widget | None = ...) -> None

Sets the end child of paned to child.

If child is NULL, the existing child will be removed.

Parameters:

• child — the widget to add

set_position

def set_position(self, position: int) -> None

Sets the position of the divider between the two panes.

Parameters:

• position — pixel position of divider, a negative value means that the position is unset

set_resize_end_child

def set_resize_end_child(self, resize: bool) -> None

Sets whether the Paned.end-child can be resized.

Parameters:

• resize — true to let the end child be resized

set_resize_start_child

def set_resize_start_child(self, resize: bool) -> None

Sets whether the Paned.start-child can be resized.

Parameters:

• resize — true to let the start child be resized

set_shrink_end_child

def set_shrink_end_child(self, resize: bool) -> None

Sets whether the Paned.end-child can shrink.

Parameters:

• resize — true to let the end child be shrunk

set_shrink_start_child

def set_shrink_start_child(self, resize: bool) -> None

Sets whether the Paned.start-child can shrink.

Parameters:

• resize — true to let the start child be shrunk

set_start_child

def set_start_child(self, child: Widget | None = ...) -> None

Sets the start child of paned to child.

If child is NULL, the existing child will be removed.

Parameters:

• child — the widget to add

set_wide_handle

def set_wide_handle(self, wide: bool) -> None

Sets whether the separator should be wide.

Parameters:

• wide — the new value for the Paned.wide-handle property

Properties

end_child

end_child: Widget  # read/write

The second child.

max_position

max_position: int  # read-only

The largest possible value for the Paned.position property.

This property is derived from the size and shrinkability of the widget's children.

min_position

min_position: int  # read-only

The smallest possible value for the Paned.position property.

This property is derived from the size and shrinkability of the widget's children.

position

position: int  # read/write

Position of the separator in pixels, from the left/top.

position_set

position_set: bool  # read/write

Whether the Paned.position property has been set.

resize_end_child

resize_end_child: bool  # read/write

Determines whether the second child expands and shrinks along with the paned widget.

resize_start_child

resize_start_child: bool  # read/write

Determines whether the first child expands and shrinks along with the paned widget.

shrink_end_child

shrink_end_child: bool  # read/write

Determines whether the second child can be made smaller than its requisition.

shrink_start_child

shrink_start_child: bool  # read/write

Determines whether the first child can be made smaller than its requisition.

start_child

start_child: Widget  # read/write

The first child.

wide_handle

wide_handle: bool  # read/write

Whether the GtkPaned should provide a stronger visual separation.

For example, this could be set when a paned contains two Notebooks, whose tab rows would otherwise merge visually.

Signals

accept-position

def on_accept_position(self) -> bool: ...

Emitted to accept the current position of the handle when moving it using key bindings.

This is a keybinding signal.

The default binding for this signal is <kbd>Return</kbd> or <kbd>Space</kbd>.

cancel-position

def on_cancel_position(self) -> bool: ...

Emitted to cancel moving the position of the handle using key bindings.

The position of the handle will be reset to the value prior to moving it.

This is a keybinding signal.

The default binding for this signal is <kbd>Escape</kbd>.

cycle-child-focus

def on_cycle_child_focus(self, reversed: bool) -> bool: ...

Emitted to cycle the focus between the children of the paned.

This is a keybinding signal.

The default binding is <kbd>F6</kbd>.

cycle-handle-focus

def on_cycle_handle_focus(self, reversed: bool) -> bool: ...

Emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings.

This is a keybinding signal.

The default binding for this signal is <kbd>F8</kbd>.

move-handle

def on_move_handle(self, scroll_type: ScrollType) -> bool: ...

Emitted to move the handle with key bindings.

This is a keybinding signal.

The default bindings for this signal are <kbd>Ctrl</kbd>+<kbd>←</kbd>, <kbd>←</kbd>, <kbd>Ctrl</kbd>+<kbd>→</kbd>, <kbd>→</kbd>, <kbd>Ctrl</kbd>+<kbd>↑</kbd>, <kbd>↑</kbd>, <kbd>Ctrl</kbd>+<kbd>↓</kbd>, <kbd>↓</kbd>, <kbd>PgUp</kbd>, <kbd>PgDn</kbd>, <kbd>Home</kbd>, <kbd>End</kbd>.

toggle-handle-focus

def on_toggle_handle_focus(self) -> bool: ...

Emitted to accept the current position of the handle and then move focus to the next widget in the focus chain.

This is a keybinding signal.

The default binding is <kbd>Tab</kbd>.