:right-sidebar: True

Paned
===================================================================

.. currentmodule:: gi.repository.Gtk





.. class:: Paned(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.AccessibleRange`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`, :class:`~gi.repository.Gtk.Orientable`



A widget with two panes, arranged either horizontally or vertically.


.. image:: https://docs.gtk.org/gtk4/panes.png


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
:obj:`~gi.repository.Gtk.Paned.set_start_child` and :obj:`~gi.repository.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 :obj:`~gi.repository.Gtk.Frame` 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 :obj:`~gi.repository.Gtk.Paned.set_position`.

CSS nodes
---------


.. code-block::
   :dedent:

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


.. code-block::
   :dedent:

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




Constructors
------------

.. rst-class:: interim-class

.. class:: Paned
   :no-index:


   .. classmethod:: new(orientation: ~gi.repository.Gtk.Orientation) -> ~gi.repository.Gtk.Widget

      Creates a new ``GtkPaned`` widget.







      :param orientation: the paned’s orientation.









Methods
-------

.. rst-class:: interim-class

.. class:: Paned
   :no-index:


   .. method:: get_end_child() -> ~gi.repository.Gtk.Widget | None

      Retrieves the end child of the given ``GtkPaned``.










   .. method:: get_position() -> int

      Obtains the position of the divider between the two panes.










   .. method:: get_resize_end_child() -> bool

      Returns whether the :obj:`~gi.repository.Gtk.Paned.props.end_child` can be resized.










   .. method:: get_resize_start_child() -> bool

      Returns whether the :obj:`~gi.repository.Gtk.Paned.props.start_child` can be resized.










   .. method:: get_shrink_end_child() -> bool

      Returns whether the :obj:`~gi.repository.Gtk.Paned.props.end_child` can shrink.










   .. method:: get_shrink_start_child() -> bool

      Returns whether the :obj:`~gi.repository.Gtk.Paned.props.start_child` can shrink.










   .. method:: get_start_child() -> ~gi.repository.Gtk.Widget | None

      Retrieves the start child of the given ``GtkPaned``.










   .. method:: get_wide_handle() -> bool

      Gets whether the separator should be wide.










   .. method:: set_end_child(child: ~gi.repository.Gtk.Widget | None = None) -> None

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

      If ``child`` is ``NULL``, the existing child will be removed.







      :param child: the widget to add





   .. method:: set_position(position: int) -> None

      Sets the position of the divider between the two panes.







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





   .. method:: set_resize_end_child(resize: bool) -> None

      Sets whether the :obj:`~gi.repository.Gtk.Paned.props.end_child` can be resized.







      :param resize: true to let the end child be resized





   .. method:: set_resize_start_child(resize: bool) -> None

      Sets whether the :obj:`~gi.repository.Gtk.Paned.props.start_child` can be resized.







      :param resize: true to let the start child be resized





   .. method:: set_shrink_end_child(resize: bool) -> None

      Sets whether the :obj:`~gi.repository.Gtk.Paned.props.end_child` can shrink.







      :param resize: true to let the end child be shrunk





   .. method:: set_shrink_start_child(resize: bool) -> None

      Sets whether the :obj:`~gi.repository.Gtk.Paned.props.start_child` can shrink.







      :param resize: true to let the start child be shrunk





   .. method:: set_start_child(child: ~gi.repository.Gtk.Widget | None = None) -> None

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

      If ``child`` is ``NULL``, the existing child will be removed.







      :param child: the widget to add





   .. method:: set_wide_handle(wide: bool) -> None

      Sets whether the separator should be wide.







      :param wide: the new value for the :obj:`~gi.repository.Gtk.Paned.props.wide_handle` property









Properties
----------

.. rst-class:: interim-class

.. class:: Paned
   :no-index:
   

   .. attribute:: props.end_child
      :type: ~gi.repository.Gtk.Widget

      The second child.







   .. attribute:: props.max_position
      :type: int

      The largest possible value for the :obj:`~gi.repository.Gtk.Paned.props.position`
      property.

      This property is derived from the size and shrinkability
      of the widget's children.







   .. attribute:: props.min_position
      :type: int

      The smallest possible value for the :obj:`~gi.repository.Gtk.Paned.props.position`
      property.

      This property is derived from the size and shrinkability
      of the widget's children.







   .. attribute:: props.position
      :type: int

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







   .. attribute:: props.position_set
      :type: bool

      Whether the :obj:`~gi.repository.Gtk.Paned.props.position` property has been set.







   .. attribute:: props.resize_end_child
      :type: bool

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







   .. attribute:: props.resize_start_child
      :type: bool

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







   .. attribute:: props.shrink_end_child
      :type: bool

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







   .. attribute:: props.shrink_start_child
      :type: bool

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







   .. attribute:: props.start_child
      :type: ~gi.repository.Gtk.Widget

      The first child.







   .. attribute:: props.wide_handle
      :type: bool

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

      For example, this could be set when a paned contains two
      :obj:`~gi.repository.Gtk.Notebook`'s, whose tab rows would otherwise merge visually.











Signals
-------

.. rst-class:: interim-class

.. class:: Paned.signals
   :no-index:
   

   .. method:: accept_position() -> bool

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

      This is a `keybinding signal <class.SignalAction.html>`_.

      The default binding for this signal is :kbd:`Return` or
      :kbd:`Space`.










   .. method:: cancel_position() -> bool

      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.

      This is a `keybinding signal <class.SignalAction.html>`_.

      The default binding for this signal is :kbd:`Escape`.










   .. method:: cycle_child_focus(reversed: bool) -> bool

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

      This is a `keybinding signal <class.SignalAction.html>`_.

      The default binding is :kbd:`F6`.







      :param reversed: whether cycling backward or forward





   .. method:: cycle_handle_focus(reversed: bool) -> bool

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

      This is a `keybinding signal <class.SignalAction.html>`_.

      The default binding for this signal is :kbd:`F8`.







      :param reversed: whether cycling backward or forward





   .. method:: move_handle(scroll_type: ~gi.repository.Gtk.ScrollType) -> bool

      Emitted to move the handle with key bindings.

      This is a `keybinding signal <class.SignalAction.html>`_.







      :param scroll_type: a ``GtkScrollType``





   .. method:: toggle_handle_focus() -> bool

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

      This is a `keybinding signal <class.SignalAction.html>`_.

      The default binding is :kbd:`Tab`.