Paned

GtkPaned has 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_pack1() and gtk_paned_pack2(). 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 GtkFrame with the shadow type set to GTK_SHADOW_IN 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 gtk_paned_set_position().

CSS nodes

|[<!-- language="plain" --> 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 of the children are always arranged
from left to right. So :first-child will always select the leftmost child,
regardless of text direction.

## 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_frame_set_shadow_type (GTK_FRAME (frame1), GTK_SHADOW_IN);
gtk_frame_set_shadow_type (GTK_FRAME (frame2), GTK_SHADOW_IN);

gtk_widget_set_size_request (hpaned, 200, -1);

gtk_paned_pack1 (GTK_PANED (hpaned), frame1, TRUE, FALSE);
gtk_widget_set_size_request (frame1, 50, -1);

gtk_paned_pack2 (GTK_PANED (hpaned), frame2, FALSE, FALSE);
gtk_widget_set_size_request (frame2, 50, -1);

Constructors

this
this(GtkPaned* gtkPaned, bool ownedRef = false)

Sets our main struct and passes it to the parent class.

this
this(GtkOrientation orientation)

Creates a new GtkPaned widget.

Members

Functions

add
void add(Widget child1, Widget child2)
add1
void add1(Widget child)

Adds a child to the top or left pane with default parameters. This is equivalent to gtk_paned_pack1 (paned, child, FALSE, TRUE).

add2
void add2(Widget child)

Adds a child to the bottom or right pane with default parameters. This is equivalent to gtk_paned_pack2 (paned, child, TRUE, TRUE).

addOnAcceptPosition
gulong addOnAcceptPosition(bool delegate(Paned) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::accept-position signal is a [keybinding signal]GtkBindingSignal which gets emitted to accept the current position of the handle when moving it using key bindings.

addOnCancelPosition
gulong addOnCancelPosition(bool delegate(Paned) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::cancel-position signal is a [keybinding signal]GtkBindingSignal which gets 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.

addOnCycleChildFocus
gulong addOnCycleChildFocus(bool delegate(bool, Paned) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::cycle-child-focus signal is a [keybinding signal]GtkBindingSignal which gets emitted to cycle the focus between the children of the paned.

addOnCycleHandleFocus
gulong addOnCycleHandleFocus(bool delegate(bool, Paned) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::cycle-handle-focus signal is a [keybinding signal]GtkBindingSignal which gets emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings.

addOnMoveHandle
gulong addOnMoveHandle(bool delegate(GtkScrollType, Paned) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::move-handle signal is a [keybinding signal]GtkBindingSignal which gets emitted to move the handle when the user is using key bindings to move it.

addOnToggleHandleFocus
gulong addOnToggleHandleFocus(bool delegate(Paned) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::toggle-handle-focus is a [keybinding signal]GtkBindingSignal which gets emitted to accept the current position of the handle and then move focus to the next widget in the focus chain.

getChild1
Widget getChild1()

Obtains the first child of the paned widget.

getChild2
Widget getChild2()

Obtains the second child of the paned widget.

getHandleWindow
Window getHandleWindow()

Returns the GdkWindow of the handle. This function is useful when handling button or motion events because it enables the callback to distinguish between the window of the paned, a child and the handle.

getPanedStruct
GtkPaned* getPanedStruct(bool transferOwnership = false)

Get the main Gtk struct

getPosition
int getPosition()

Obtains the position of the divider between the two panes.

getStruct
void* getStruct()

the main Gtk struct as a void*

getWideHandle
bool getWideHandle()

Gets the wide-handle property.

pack1
void pack1(Widget child, bool resize, bool shrink)

Adds a child to the top or left pane.

pack2
void pack2(Widget child, bool resize, bool shrink)

Adds a child to the bottom or right pane.

setPosition
void setPosition(int position)

Sets the position of the divider between the two panes.

setWideHandle
void setWideHandle(bool wide)

Sets the wide-handle property.

Static functions

getType
GType getType()

Variables

gtkPaned
GtkPaned* gtkPaned;

the main Gtk struct