Gtk.Paned
Description: Reference for Gtk.Paned

### Class

# GtkPaned

since: 4.0

#### Description [src]

    final class Gtk.Paned : Gtk.Widget
      implements Gtk.Accessible, Gtk.AccessibleRange, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
      /* No available fields */
    }

A widget with 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

    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.

    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_resize_start_child (GTK_PANED (hpaned), TRUE);
    gtk_paned_set_shrink_start_child (GTK_PANED (hpaned), FALSE);
    gtk_widget_set_size_request (frame1, 50, -1);

    gtk_paned_set_end_child (GTK_PANED (hpaned), frame2);
    gtk_paned_set_resize_end_child (GTK_PANED (hpaned), FALSE);
    gtk_paned_set_shrink_end_child (GTK_PANED (hpaned), FALSE);
    gtk_widget_set_size_request (frame2, 50, -1);

Available since: 4.0

#### Ancestors

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkAccessibleRange
- GtkBuildable
- GtkConstraintTarget
- GtkOrientable

#### Constructors

###### gtk_paned_new

Creates a new `GtkPaned` widget.

since: 4.0

#### Instance methods

###### gtk_paned_get_end_child

Retrieves the end child of the given `GtkPaned`.

since: 4.0

###### gtk_paned_get_position

Obtains the position of the divider between the two panes.

since: 4.0

###### gtk_paned_get_resize_end_child

Returns whether the `GtkPaned:end-child` can be resized.

since: 4.0

###### gtk_paned_get_resize_start_child

Returns whether the `GtkPaned:start-child` can be resized.

since: 4.0

###### gtk_paned_get_shrink_end_child

Returns whether the `GtkPaned:end-child` can shrink.

since: 4.0

###### gtk_paned_get_shrink_start_child

Returns whether the `GtkPaned:start-child` can shrink.

since: 4.0

###### gtk_paned_get_start_child

Retrieves the start child of the given `GtkPaned`.

since: 4.0

###### gtk_paned_get_wide_handle

Gets whether the separator should be wide.

since: 4.0

###### gtk_paned_set_end_child

Sets the end child of `paned` to `child`.

since: 4.0

###### gtk_paned_set_position

Sets the position of the divider between the two panes.

since: 4.0

###### gtk_paned_set_resize_end_child

Sets whether the `GtkPaned:end-child` can be resized.

since: 4.0

###### gtk_paned_set_resize_start_child

Sets whether the `GtkPaned:start-child` can be resized.

since: 4.0

###### gtk_paned_set_shrink_end_child

Sets whether the `GtkPaned:end-child` can shrink.

since: 4.0

###### gtk_paned_set_shrink_start_child

Sets whether the `GtkPaned:start-child` can shrink.

since: 4.0

###### gtk_paned_set_start_child

Sets the start child of `paned` to `child`.

since: 4.0

###### gtk_paned_set_wide_handle

Sets whether the separator should be wide.

since: 4.0

##### Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GtkAccessible (19)

###### gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

since: 4.14

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

since: 4.0

###### gtk_accessible_get_at_context

Retrieves the accessible implementation for the given `GtkAccessible`.

since: 4.10

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

###### gtk_accessible_get_platform_state

Query a platform state, such as focus.

since: 4.10

###### gtk_accessible_reset_property

Resets the accessible `property` to its default value.

since: 4.0

###### gtk_accessible_reset_relation

Resets the accessible `relation` to its default value.

since: 4.0

###### gtk_accessible_reset_state

Resets the accessible `state` to its default value.

since: 4.0

###### gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of `self`.

since: 4.10

###### gtk_accessible_update_property

Updates a list of accessible properties.

since: 4.0

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

since: 4.0

###### gtk_accessible_update_relation

Updates a list of accessible relations.

since: 4.0

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

since: 4.0

###### gtk_accessible_update_state

Updates a list of accessible states. See the `GtkAccessibleState` documentation for the value types of accessible states.

since: 4.0

###### gtk_accessible_update_state_value

Updates an array of accessible states.

since: 4.0

##### Methods inherited from GtkBuildable (1)

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

since: 4.0

##### Methods inherited from GtkOrientable (2)

###### gtk_orientable_get_orientation

Retrieves the orientation of the `orientable`.

since: 4.0

###### gtk_orientable_set_orientation

Sets the orientation of the `orientable`.

since: 4.0

#### Properties

###### Gtk.Paned:end-child

The second child.

since: 4.0

###### Gtk.Paned:max-position

The largest possible value for the `GtkPaned:position` property.

since: 4.0

###### Gtk.Paned:min-position

The smallest possible value for the `GtkPaned:position` property.

since: 4.0

###### Gtk.Paned:position

Position of the separator in pixels, from the left/top.

since: 4.0

###### Gtk.Paned:position-set

Whether the `GtkPaned:position` property has been set.

since: 4.0

###### Gtk.Paned:resize-end-child

Determines whether the second child expands and shrinks along with the paned widget.

since: 4.0

###### Gtk.Paned:resize-start-child

Determines whether the first child expands and shrinks along with the paned widget.

since: 4.0

###### Gtk.Paned:shrink-end-child

Determines whether the second child can be made smaller than its requisition.

since: 4.0

###### Gtk.Paned:shrink-start-child

Determines whether the first child can be made smaller than its requisition.

since: 4.0

###### Gtk.Paned:start-child

The first child.

since: 4.0

###### Gtk.Paned:wide-handle

Whether the `GtkPaned` should provide a stronger visual separation.

since: 4.0

##### Properties inherited from GtkWidget (34)

###### Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

since: 4.0

###### Gtk.Widget:can-target

Whether the widget can receive pointer events.

since: 4.0

###### Gtk.Widget:css-classes

A list of css classes applied to this widget.

since: 4.0

###### Gtk.Widget:css-name

The name of this widget in the CSS tree.

since: 4.0

###### Gtk.Widget:cursor

The cursor used by `widget`.

since: 4.0

###### Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

since: 4.0

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

since: 4.0

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

since: 4.0

###### Gtk.Widget:has-default

Whether the widget is the default widget.

since: 4.0

###### Gtk.Widget:has-focus

Whether the widget has the input focus.

since: 4.0

###### Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on `widget`.

since: 4.0

###### Gtk.Widget:height-request

Override for height request of the widget.

since: 4.0

###### Gtk.Widget:hexpand

Whether to expand horizontally.

since: 4.0

###### Gtk.Widget:hexpand-set

Whether to use the `hexpand` property.

since: 4.0

###### Gtk.Widget:layout-manager

The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children.

since: 4.0

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

since: 4.0

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally.

since: 4.0

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally.

since: 4.0

###### Gtk.Widget:margin-top

Margin on top side of widget.

since: 4.0

###### Gtk.Widget:name

The name of the widget.

since: 4.0

###### Gtk.Widget:opacity

The requested opacity of the widget.

since: 4.0

###### Gtk.Widget:overflow

How content outside the widget’s content area is treated.

since: 4.0

###### Gtk.Widget:parent

The parent widget of this widget.

since: 4.0

###### Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

since: 4.0

###### Gtk.Widget:root

The `GtkRoot` widget of the widget tree containing this widget.

since: 4.0

###### Gtk.Widget:scale-factor

The scale factor of the widget.

since: 4.0

###### Gtk.Widget:sensitive

Whether the widget responds to input.

since: 4.0

###### Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

since: 4.0

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

since: 4.0

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

since: 4.0

###### Gtk.Widget:vexpand

Whether to expand vertically.

since: 4.0

###### Gtk.Widget:vexpand-set

Whether to use the `vexpand` property.

since: 4.0

###### Gtk.Widget:visible

Whether the widget is visible.

since: 4.0

###### Gtk.Widget:width-request

Override for width request of the widget.

since: 4.0

##### Properties inherited from GtkAccessible (1)

###### GtkAccessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

since: 4.0

##### Properties inherited from GtkOrientable (1)

###### GtkOrientable:orientation

The orientation of the orientable.

since: 4.0

#### Signals

###### Gtk.Paned::accept-position

Emitted to accept the current position of the handle when moving it using key bindings.

since: 4.0

###### Gtk.Paned::cancel-position

Emitted to cancel moving the position of the handle using key bindings.

since: 4.0

###### Gtk.Paned::cycle-child-focus

Emitted to cycle the focus between the children of the paned.

since: 4.0

###### Gtk.Paned::cycle-handle-focus

Emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings.

since: 4.0

###### Gtk.Paned::move-handle

Emitted to move the handle with key bindings.

since: 4.0

###### Gtk.Paned::toggle-handle-focus

Emitted to accept the current position of the handle and then move focus to the next widget in the focus chain.

since: 4.0

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

since: 4.0

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

since: 4.0

###### GtkWidget::hide

Emitted when `widget` is hidden.

since: 4.0

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

since: 4.0

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

since: 4.0

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

since: 4.0

###### GtkWidget::move-focus

Emitted when the focus is moved.

since: 4.0

###### GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

since: 4.0

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

since: 4.0

###### GtkWidget::show

Emitted when `widget` is shown.

since: 4.0

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

since: 4.0

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

since: 4.0

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

since: 4.0

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

since: 2.0