Paned#

class Paned(**properties: Any)#

Superclasses: Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, AccessibleRange, Buildable, ConstraintTarget, Orientable

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

Shortcuts and Gestures#

The following signals have default keybindings:

accept_position
cancel_position
cycle_child_focus
cycle_handle_focus
move_handle
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#

class Paned

classmethod new(orientation: Orientation) → Widget#

Creates a new GtkPaned widget.

Parameters:: orientation – the paned’s orientation.

Methods#

class Paned

get_end_child() → Widget | None#: Retrieves the end child of the given GtkPaned.

get_position() → int#: Obtains the position of the divider between the two panes.

get_resize_end_child() → bool#: Returns whether the end_child can be resized.

get_resize_start_child() → bool#: Returns whether the start_child can be resized.

get_shrink_end_child() → bool#: Returns whether the end_child can shrink.

get_shrink_start_child() → bool#: Returns whether the start_child can shrink.

get_start_child() → Widget | None#: Retrieves the start child of the given GtkPaned.

get_wide_handle() → bool#: Gets whether the separator should be wide.

set_end_child(child: Widget | None = 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(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(resize: bool) → None#

Sets whether the end_child can be resized.

Parameters:: resize – true to let the end child be resized

set_resize_start_child(resize: bool) → None#

Sets whether the start_child can be resized.

Parameters:: resize – true to let the start child be resized

set_shrink_end_child(resize: bool) → None#

Sets whether the end_child can shrink.

Parameters:: resize – true to let the end child be shrunk

set_shrink_start_child(resize: bool) → None#

Sets whether the start_child can shrink.

Parameters:: resize – true to let the start child be shrunk

set_start_child(child: Widget | None = 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(wide: bool) → None#

Sets whether the separator should be wide.

Parameters:: wide – the new value for the wide_handle property

Properties#

class Paned

props.end_child: Widget#: The type of the None singleton.

props.max_position: int#: The type of the None singleton.

props.min_position: int#: The type of the None singleton.

props.position: int#: The type of the None singleton.

props.position_set: bool#: The type of the None singleton.

props.resize_end_child: bool#: The type of the None singleton.

props.resize_start_child: bool#: The type of the None singleton.

props.shrink_end_child: bool#: The type of the None singleton.

props.shrink_start_child: bool#: The type of the None singleton.

props.start_child: Widget#: The type of the None singleton.

props.wide_handle: bool#: The type of the None singleton.

Signals#

class Paned.signals

accept_position() → bool#: The type of the None singleton.

cancel_position() → bool#: The type of the None singleton.

cycle_child_focus(reversed: bool) → bool#

The type of the None singleton.

Parameters:: reversed – whether cycling backward or forward

cycle_handle_focus(reversed: bool) → bool#

The type of the None singleton.

Parameters:: reversed – whether cycling backward or forward

move_handle(scroll_type: ScrollType) → bool#

The type of the None singleton.

Parameters:: scroll_type – a GtkScrollType

toggle_handle_focus() → bool#: The type of the None singleton.