Paned

class Paned(**properties: Any)

Superclasses: Widget, InitiallyUnowned, Object

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

Constructors:

Paned(**properties)
new(orientation:Gtk.Orientation) -> Gtk.Widget

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 second child.

props.max_position: int

The largest possible value for the position property.

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

props.min_position: int

The smallest possible value for the position property.

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

props.position: int: Position of the separator in pixels, from the left/top.

props.position_set: bool: Whether the position property has been set.

props.resize_end_child: bool: Determines whether the second child expands and shrinks along with the paned widget.

props.resize_start_child: bool: Determines whether the first child expands and shrinks along with the paned widget.

props.shrink_end_child: bool: Determines whether the second child can be made smaller than its requisition.

props.shrink_start_child: bool: Determines whether the first child can be made smaller than its requisition.

props.start_child: Widget: The first child.

props.wide_handle: bool

Whether the GtkPaned should provide a stronger visual separation.

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

Signals

class Paned.signals

accept_position() → 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 Return or Space.

cancel_position() → 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 Escape.

cycle_child_focus(reversed: bool) → bool

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

This is a keybinding signal.

The default binding is F6.

Parameters:: reversed – whether cycling backward or forward

cycle_handle_focus(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 F8.

Parameters:: reversed – whether cycling backward or forward

move_handle(scroll_type: ScrollType) → bool

Emitted to move the handle with key bindings.

This is a keybinding signal.

Parameters:: scroll_type – a GtkScrollType

toggle_handle_focus() → 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 Tab.