Paned

gtk.Paned 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 Paned.pack1 and 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 gtk.Frame 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 gtk.Paned 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.setPosition.

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

class Paned : Container , OrientableIF {

protected

GtkPaned* gtkPaned;

GtkPaned* getPanedStruct(bool transferOwnership);

void* getStruct();

this(GtkPaned* gtkPaned, bool ownedRef);

void add(Widget child1, Widget child2);

static GType getType();

this(GtkOrientation orientation);

void add1(Widget child);

void add2(Widget child);

Widget getChild1();

Widget getChild2();

Window getHandleWindow();

int getPosition();

bool getWideHandle();

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

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

void setPosition(int position);

void setWideHandle(bool wide);

gulong addOnAcceptPosition(bool delegate(Paned) dlg, ConnectFlags connectFlags);

gulong addOnCancelPosition(bool delegate(Paned) dlg, ConnectFlags connectFlags);

gulong addOnCycleChildFocus(bool delegate(bool, Paned) dlg, ConnectFlags connectFlags);

gulong addOnCycleHandleFocus(bool delegate(bool, Paned) dlg, ConnectFlags connectFlags);

gulong addOnMoveHandle(bool delegate(GtkScrollType, Paned) dlg, ConnectFlags connectFlags);

gulong addOnToggleHandleFocus(bool delegate(Paned) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkPaned* gtkPaned, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(GtkOrientation orientation): Creates a new gtk.Paned 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): 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): 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): 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): 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): 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): 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 gdk.Window 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): 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

Inherited Members

From Container

gtkContainer GtkContainer* gtkContainer;: the main Gtk struct
getContainerStruct GtkContainer* getContainerStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
removeAll void removeAll(): Removes all widgets from the container
getType GType getType()
add void add(Widget widget): Adds widget to container. Typically used for simple containers such as gtk.Window, gtk.Frame, or gtk.Button; for more complicated layout containers such as gtk.Box or gtk.Grid, this function will pick default packing parameters that may not be correct. So consider functions such as Box.packStart and Grid.attach as an alternative to Container.add in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.
checkResize void checkResize()
childGetProperty void childGetProperty(Widget child, string propertyName, Value value): Gets the value of a child property for child and container.
childGetValist void childGetValist(Widget child, string firstPropertyName, void* varArgs): Gets the values of one or more child properties for child and container.
childNotify void childNotify(Widget child, string childProperty): Emits a child-notify signal for the [child property][child-properties] child_property on the child.
childNotifyByPspec void childNotifyByPspec(Widget child, ParamSpec pspec): Emits a child-notify signal for the [child property][child-properties] specified by pspec on the child.
childSetProperty void childSetProperty(Widget child, string propertyName, Value value): Sets a child property for child and container.
childSetValist void childSetValist(Widget child, string firstPropertyName, void* varArgs): Sets one or more child properties for child and container.
childType GType childType(): Returns the type of the children supported by the container.
forall void forall(GtkCallback callback, void* callbackData): Invokes callback on each direct child of container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.
foreach_ void foreach_(GtkCallback callback, void* callbackData): Invokes callback on each non-internal child of container. See Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.
getBorderWidth uint getBorderWidth(): Retrieves the border width of the container. See Container.setBorderWidth.
getChildren ListG getChildren(): Returns the container’s non-internal children. See Container.forall for details on what constitutes an "internal" child.
getFocusChain bool getFocusChain(ListG focusableWidgets): Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores NULL in focusable_widgets and returns FALSE.
getFocusChild Widget getFocusChild(): Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling Window.getFocus.
getFocusHadjustment Adjustment getFocusHadjustment(): Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
getFocusVadjustment Adjustment getFocusVadjustment(): Retrieves the vertical focus adjustment for the container. See Container.setFocusVadjustment.
getPathForChild WidgetPath getPathForChild(Widget child): Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.
getResizeMode GtkResizeMode getResizeMode(): Returns the resize mode for the container. See gtk_container_set_resize_mode ().
propagateDraw void propagateDraw(Widget child, Context cr): When a container receives a call to the draw function, it must send synthetic draw calls to all children that don’t have their own gdk.Windows This function provides a convenient way of doing this. A container, when it receives a call to its draw function, calls Container.propagateDraw once for each child, passing in the cr the container received.
remove void remove(Widget widget): Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it before removing it from a container, using g_object_ref(). If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using Widget.destroy since this will remove it from the container and help break any circular reference count cycles.
resizeChildren void resizeChildren()
setBorderWidth void setBorderWidth(uint borderWidth): Sets the border width of the container.
setFocusChain void setFocusChain(ListG focusableWidgets): Sets a focus chain, overriding the one computed automatically by GTK+.
setFocusChild void setFocusChild(Widget child): Sets, or unsets if child is NULL, the focused child of container.
setFocusHadjustment void setFocusHadjustment(Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and Container.setFocusVadjustment for setting the vertical adjustment.
setFocusVadjustment void setFocusVadjustment(Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and Container.setFocusHadjustment for setting the horizontal adjustment.
setReallocateRedraws void setReallocateRedraws(bool needsRedraws): Sets the reallocate_redraws flag of the container to the given value.
setResizeMode void setResizeMode(GtkResizeMode resizeMode): Sets the resize mode for the container.
unsetFocusChain void unsetFocusChain(): Removes a focus chain explicitly set with Container.setFocusChain.
addOnAdd gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnCheckResize gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
addOnRemove gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnSetFocusChild gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)

From OrientableIF

getOrientableStruct GtkOrientable* getOrientableStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
getOrientation GtkOrientation getOrientation(): Retrieves the orientation of the orientable.
setOrientation void setOrientation(GtkOrientation orientation): Sets the orientation of the orientable.

gtk Paned classes

Paned