: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` :Constructors: :: Paned(**properties) new(orientation:Gtk.Orientation) -> Gtk.Widget 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 `_. 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 `_. 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 `_. 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 `_. 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 `_. :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 `_. The default binding is :kbd:`Tab`.