W Wrapl, The Programming Language

Libraries:Gtk:Gtk:Paned

Types

T

Inherits from:

T is the base class for widgets with two panes, arranged either horizontally (Gtk.Gtk.HPaned.T) or vertically (Gtk.Gtk.VPaned.T). Child widgets are added to the panes of the widget with Pack1 and Pack2. The division beween 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.Gtk.Frame.T with the shadow type set to Gtk.Gtk.ShadowType.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 T is resized, that child will expand or shrink along with the paned widget. If shrink is true, then when 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 SetPosition.

Example 56. Creating a paned widget with minimum sizes.

1
2
3
4
5
6
7
8
9
10
GtkWidget *hpaned = gtk_hpaned_new ();
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 + GTK_PANED (hpaned)->gutter_size, -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);




Constants

Nil : T

Functions

GetType() : Gtk.GObject.Type.T



Methods

:Add1(self @ T, child @ Gtk.Gtk.Widget.T) : Std.Object.T

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

paned a paned widget
child the child to add


:Add2(self @ T, child @ Gtk.Gtk.Widget.T) : Std.Object.T

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

paned a paned widget
child the child to add


:ComputePosition(self @ T, allocation @ Std.Integer.SmallT, child1_req @ Std.Integer.SmallT, child2_req @ Std.Integer.SmallT) : Std.Object.T



:GetChild1(self @ T) : Gtk.Gtk.Widget.T

Obtains the first child of the paned widget.

paned a T widget
Returns first child, or NULL if it is not set. [transfer none]


:GetChild2(self @ T) : Gtk.Gtk.Widget.T

Obtains the second child of the paned widget.

paned a T widget
Returns second child, or NULL if it is not set. [transfer none]


:GetHandleWindow(self @ T) : Gtk.Gdk.Window.T

Returns the Gtk.Gdk.Window.T 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. [transfer none]


:GetPosition(self @ T) : Std.Integer.SmallT

Obtains the position of the divider between the two panes.

paned a T widget
Returns position of the divider


:Pack1(self @ T, child @ Gtk.Gtk.Widget.T, resize @ Std.Symbol.T, shrink @ Std.Symbol.T) : Std.Object.T

Adds a child to the top or left pane.

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


:Pack2(self @ T, child @ Gtk.Gtk.Widget.T, resize @ Std.Symbol.T, shrink @ Std.Symbol.T) : Std.Object.T

Adds a child to the bottom or right pane.

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


:SetPosition(self @ T, position @ Std.Integer.SmallT) : Std.Object.T

Sets the position of the divider between the two panes.

paned a T widget
position pixel position of divider, a negative value means that the position is unset.