gtk.Paned

class Paned : gtk.Container.Container, gtk.OrientableIF.OrientableIF;
#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

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

GtkPaned has a main CSS node with name paned, and a subnode for the separator with name separator. The subnodes 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.

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

protected GtkPaned* gtkPaned ;
the main Gtk struct

GtkPaned* getPanedStruct ();
Get the main Gtk struct

protected void* getStruct ();
the main Gtk struct as a void*

this(GtkPaned* gtkPaned, bool ownedRef = false);
Sets our main struct and passes it to the parent class.

void add (Widget child1, Widget child2);
static GType getType ();
this(GtkOrientation orientation);
Creates a new #GtkPaned widget.

Params:
GtkOrientation orientation the paned’s orientation.

Returns:
a new #GtkPaned.

Since:
3.0

Throws:
ConstructionException GTK+ fails to create the object.

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

Params:
Widget child the child to add

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

Params:
Widget child the child to add

Widget getChild1 ();
Obtains the first child of the paned widget.

Returns:
first child, or %NULL if it is not set.

Since:
2.4

Widget getChild2 ();
Obtains the second child of the paned widget.

Returns:
second child, or %NULL if it is not set.

Since:
2.4

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.

Returns:
the paned’s handle window.

Since:
2.20

int getPosition ();
Obtains the position of the divider between the two panes.

Returns:
position of the divider

bool getWideHandle ();
Gets the #GtkPaned:wide-handle property.

Returns:
%TRUE if the paned should have a wide handle

Since:
3.16

void pack1 (Widget child, bool resize, bool shrink);
Adds a child to the top or left pane.

Params:
Widget child the child to add
bool resize should this child expand when the paned widget is resized.
bool shrink can this child be made smaller than its requisition.

void pack2 (Widget child, bool resize, bool shrink);
Adds a child to the bottom or right pane.

Params:
Widget child the child to add
bool resize should this child expand when the paned widget is resized.
bool shrink can this child be made smaller than its requisition.

void setPosition (int position);
Sets the position of the divider between the two panes.

Params:
int position pixel position of divider, a negative value means that the position is unset.

void setWideHandle (bool wide);
Sets the #GtkPaned:wide-handle property.

Params:
bool wide the new value for the #GtkPaned:wide-handle property

Since:
3.16

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.

The default binding for this signal is Return or Space.

Since:
2.0

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.

The default binding for this signal is Escape.

Since:
2.0

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.

The default binding is f6.

Params:
reversed whether cycling backward or forward

Since:
2.0

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.

The default binding for this signal is f8.

Params:
reversed whether cycling backward or forward

Since:
2.0

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.

Params:
scrollType a #GtkScrollType

Since:
2.0

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.

The default binding is Tab.

Since:
2.0

Page was generated with on Sun Apr 23 22:52:56 2017