GtkPaned

GtkPaned — A widget with two adjustable panes

Properties

GtkWidget * end-child Read / Write
gint max-position Read
gint min-position Read
gint position Read / Write
gboolean position-set Read / Write
gboolean resize-end-child Read / Write
gboolean resize-start-child Read / Write
gboolean shrink-end-child Read / Write
gboolean shrink-start-child Read / Write
GtkWidget * start-child Read / Write
gboolean wide-handle Read / Write

Signals

gboolean accept-position Action
gboolean cancel-position Action
gboolean cycle-child-focus Action
gboolean cycle-handle-focus Action
gboolean move-handle Action
gboolean toggle-handle-focus Action

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkPaned

Implemented Interfaces

GtkPaned implements AtkImplementorIface, GtkBuildable, GtkConstraintTarget and GtkOrientable.

Includes

#include <gtk/gtk.h>

Description

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_set_start_child() and gtk_paned_set_end_child(). 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 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

1
2
3
4
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 are arranged based on the text direction, so in left-to-right mode, :first-child will select the leftmost child, while it will select the rightmost child in RTL layouts.

Creating a paned widget with minimum sizes.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
GtkWidget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL);
GtkWidget *frame1 = gtk_frame_new (NULL);
GtkWidget *frame2 = gtk_frame_new (NULL);

gtk_widget_set_size_request (hpaned, 200, -1);

gtk_paned_set_start_child (GTK_PANED (hpaned), frame1);
gtk_paned_set_start_child_resize (GTK_PANED (hpaned), TRUE);
gtk_paned_set_start_child_shrink (GTK_PANED (hpaned), FALSE);
gtk_widget_set_size_request (frame1, 50, -1);

gtk_paned_set_end_child (GTK_PANED (hpaned), frame2);
gtk_paned_set_end_child_resize (GTK_PANED (hpaned), FALSE);
gtk_paned_set_end_child_shrink (GTK_PANED (hpaned), FALSE);
gtk_widget_set_size_request (frame2, 50, -1);

Functions

gtk_paned_new ()

GtkWidget *
gtk_paned_new (GtkOrientation orientation);

Creates a new GtkPaned widget.

Parameters

orientation

the paned’s orientation.

 

Returns

a new GtkPaned.


gtk_paned_set_start_child ()

void
gtk_paned_set_start_child (GtkPaned *paned,
                           GtkWidget *child);

Sets the start child of paned to child .

Parameters

paned

a GtkPaned

 

child

the widget to add

 

gtk_paned_get_start_child ()

GtkWidget *
gtk_paned_get_start_child (GtkPaned *paned);

Retrieves the start child of the given GtkPaned.

See also: “start-child”

Parameters

paned

a GtkPaned

 

Returns

the start child widget.

[transfer none][nullable]


gtk_paned_set_end_child ()

void
gtk_paned_set_end_child (GtkPaned *paned,
                         GtkWidget *child);

Sets the end child of paned to child .

Parameters

paned

a GtkPaned

 

child

the widget to add

 

gtk_paned_get_end_child ()

GtkWidget *
gtk_paned_get_end_child (GtkPaned *paned);

Retrieves the end child of the given GtkPaned.

See also: “end-child”

Parameters

paned

a GtkPaned

 

Returns

the end child widget.

[transfer none][nullable]


gtk_paned_set_resize_start_child ()

void
gtk_paned_set_resize_start_child (GtkPaned *paned,
                                  gboolean resize);

Sets the “resize-start-child” property

Parameters

paned

a GtkPaned

 

resize

TRUE to let the start child be resized

 

gtk_paned_get_resize_start_child ()

gboolean
gtk_paned_get_resize_start_child (GtkPaned *paned);

Returns whether the start child can be resized.

Parameters

paned

a GtkPaned

 

Returns

TRUE if the start child is resizable


gtk_paned_set_resize_end_child ()

void
gtk_paned_set_resize_end_child (GtkPaned *paned,
                                gboolean resize);

Sets the “resize-end-child” property

Parameters

paned

a GtkPaned

 

resize

TRUE to let the end child be resized

 

gtk_paned_get_resize_end_child ()

gboolean
gtk_paned_get_resize_end_child (GtkPaned *paned);

Returns whether the end child can be resized.

Parameters

paned

a GtkPaned

 

Returns

TRUE if the end child is resizable


gtk_paned_set_shrink_start_child ()

void
gtk_paned_set_shrink_start_child (GtkPaned *paned,
                                  gboolean resize);

Sets the “shrink-start-child” property

Parameters

paned

a GtkPaned

 

resize

TRUE to let the start child be shrunk

 

gtk_paned_get_shrink_start_child ()

gboolean
gtk_paned_get_shrink_start_child (GtkPaned *paned);

Returns whether the start child can be shrunk.

Parameters

paned

a GtkPaned

 

Returns

TRUE if the start child is shrinkable


gtk_paned_set_shrink_end_child ()

void
gtk_paned_set_shrink_end_child (GtkPaned *paned,
                                gboolean resize);

Sets the “shrink-end-child” property

Parameters

paned

a GtkPaned

 

resize

TRUE to let the end child be shrunk

 

gtk_paned_get_shrink_end_child ()

gboolean
gtk_paned_get_shrink_end_child (GtkPaned *paned);

Returns whether the end child can be shrunk.

Parameters

paned

a GtkPaned

 

Returns

TRUE if the end child is shrinkable


gtk_paned_set_position ()

void
gtk_paned_set_position (GtkPaned *paned,
                        gint position);

Sets the position of the divider between the two panes.

Parameters

paned

a GtkPaned widget

 

position

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

 

gtk_paned_get_position ()

gint
gtk_paned_get_position (GtkPaned *paned);

Obtains the position of the divider between the two panes.

Parameters

paned

a GtkPaned widget

 

Returns

position of the divider


gtk_paned_set_wide_handle ()

void
gtk_paned_set_wide_handle (GtkPaned *paned,
                           gboolean wide);

Sets the “wide-handle” property.

Parameters

paned

a GtkPaned

 

wide

the new value for the “wide-handle” property

 

gtk_paned_get_wide_handle ()

gboolean
gtk_paned_get_wide_handle (GtkPaned *paned);

Gets the “wide-handle” property.

Parameters

paned

a GtkPaned

 

Returns

TRUE if the paned should have a wide handle

Types and Values

GtkPaned

typedef struct _GtkPaned GtkPaned;

Property Details

The “end-child” property

  “end-child”                GtkWidget *

The second child.

Owner: GtkPaned

Flags: Read / Write


The “max-position” property

  “max-position”             gint

The largest possible value for the position property. This property is derived from the size and shrinkability of the widget's children.

Owner: GtkPaned

Flags: Read

Allowed values: >= 0

Default value: 2147483647


The “min-position” property

  “min-position”             gint

The smallest possible value for the position property. This property is derived from the size and shrinkability of the widget's children.

Owner: GtkPaned

Flags: Read

Allowed values: >= 0

Default value: 0


The “position” property

  “position”                 gint

Position of paned separator in pixels (0 means all the way to the left/top).

Owner: GtkPaned

Flags: Read / Write

Allowed values: >= 0

Default value: 0


The “position-set” property

  “position-set”             gboolean

TRUE if the Position property should be used.

Owner: GtkPaned

Flags: Read / Write

Default value: FALSE


The “resize-end-child” property

  “resize-end-child”         gboolean

The "resize-end-child" property determines whether the second child expands and shrinks along with the paned widget.

Owner: GtkPaned

Flags: Read / Write

Default value: TRUE


The “resize-start-child” property

  “resize-start-child”       gboolean

The "resize-start-child" property determines whether the first child expands and shrinks along with the paned widget.

Owner: GtkPaned

Flags: Read / Write

Default value: TRUE


The “shrink-end-child” property

  “shrink-end-child”         gboolean

The "shrink-end-child" property determines whether the second child can be made smaller than its requisition.

Owner: GtkPaned

Flags: Read / Write

Default value: TRUE


The “shrink-start-child” property

  “shrink-start-child”       gboolean

The "shrink-start-child" property determines whether the first child can be made smaller than its requisition.

Owner: GtkPaned

Flags: Read / Write

Default value: TRUE


The “start-child” property

  “start-child”              GtkWidget *

The first child.

Owner: GtkPaned

Flags: Read / Write


The “wide-handle” property

  “wide-handle”              gboolean

Setting this property to TRUE indicates that the paned needs to provide stronger visual separation (e.g. because it separates between two notebooks, whose tab rows would otherwise merge visually).

Owner: GtkPaned

Flags: Read / Write

Default value: FALSE

Signal Details

The “accept-position” signal

gboolean
user_function (GtkPaned *widget,
               gpointer  user_data)

The ::accept-position signal is a keybinding signal 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.

Parameters

widget

the object that received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “cancel-position” signal

gboolean
user_function (GtkPaned *widget,
               gpointer  user_data)

The ::cancel-position signal is a keybinding signal 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.

Parameters

widget

the object that received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “cycle-child-focus” signal

gboolean
user_function (GtkPaned *widget,
               gboolean  reversed,
               gpointer  user_data)

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

The default binding is f6.

Parameters

widget

the object that received the signal

 

reversed

whether cycling backward or forward

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “cycle-handle-focus” signal

gboolean
user_function (GtkPaned *widget,
               gboolean  reversed,
               gpointer  user_data)

The ::cycle-handle-focus signal is a keybinding signal 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.

Parameters

widget

the object that received the signal

 

reversed

whether cycling backward or forward

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “move-handle” signal

gboolean
user_function (GtkPaned     *widget,
               GtkScrollType scroll_type,
               gpointer      user_data)

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

Parameters

widget

the object that received the signal

 

scroll_type

a GtkScrollType

 

user_data

user data set when the signal handler was connected.

 

Flags: Action


The “toggle-handle-focus” signal

gboolean
user_function (GtkPaned *widget,
               gpointer  user_data)

The ::toggle-handle-focus is a keybinding signal 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.

Parameters

widget

the object that received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Action