Struct gtk4::Paned

#[repr(transparent)]
pub struct Paned { /* private 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 set_start_child() and 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 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 Paned 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 set_position().

CSS nodes

paned
├── <child>
├── separator[.wide]
╰── <child>

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

⚠️ The following code is in c ⚠️

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

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, AccessibleRangeExt, OrientableExt, WidgetExtManual, AccessibleExtManual

Implementations

impl Paned

pub fn new(orientation: Orientation) -> Paned

Creates a new Paned widget.

orientation

the paned’s orientation.

Returns

the newly created paned widget

pub fn builder() -> PanedBuilder

Creates a new builder-pattern struct instance to construct Paned objects.

This method returns an instance of PanedBuilder which can be used to create Paned objects.

pub fn end_child(&self) -> Option<Widget>

Retrieves the end child of the given Paned.

Returns

the end child widget

pub fn position(&self) -> i32

Obtains the position of the divider between the two panes.

Returns

the position of the divider, in pixels

pub fn resizes_end_child(&self) -> bool

Returns whether the property::Paned::end-child can be resized.

Returns

true if the end child is resizable

pub fn resizes_start_child(&self) -> bool

Returns whether the property::Paned::start-child can be resized.

Returns

true if the start child is resizable

pub fn shrinks_end_child(&self) -> bool

Returns whether the property::Paned::end-child can shrink.

Returns

true if the end child is shrinkable

pub fn shrinks_start_child(&self) -> bool

Returns whether the property::Paned::start-child can shrink.

Returns

true if the start child is shrinkable

pub fn start_child(&self) -> Option<Widget>

Retrieves the start child of the given Paned.

Returns

the start child widget

pub fn is_wide_handle(&self) -> bool

Gets whether the separator should be wide.

Returns

true if the paned should have a wide handle

pub fn set_end_child(&self, child: Option<&impl IsA<Widget>>)

Sets the end child of @self to @child.

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

child

the widget to add

pub fn set_position(&self, position: i32)

Sets the position of the divider between the two panes.

position

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

pub fn set_resize_end_child(&self, resize: bool)

Sets whether the property::Paned::end-child can be resized.

resize

true to let the end child be resized

pub fn set_resize_start_child(&self, resize: bool)

Sets whether the property::Paned::start-child can be resized.

resize

true to let the start child be resized

pub fn set_shrink_end_child(&self, resize: bool)

Sets whether the property::Paned::end-child can shrink.

resize

true to let the end child be shrunk

pub fn set_shrink_start_child(&self, resize: bool)

Sets whether the property::Paned::start-child can shrink.

resize

true to let the start child be shrunk

pub fn set_start_child(&self, child: Option<&impl IsA<Widget>>)

Sets the start child of @self to @child.

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

child

the widget to add

pub fn set_wide_handle(&self, wide: bool)

Sets whether the separator should be wide.

wide

the new value for the property::Paned::wide-handle property

pub fn max_position(&self) -> i32

The largest possible value for the property::Paned::position property.

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

pub fn min_position(&self) -> i32

The smallest possible value for the property::Paned::position property.

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

pub fn is_position_set(&self) -> bool

Whether the property::Paned::position property has been set.

pub fn connect_accept_position<F: Fn(&Self) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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 Return or Space.

pub fn emit_accept_position(&self) -> bool

pub fn connect_cancel_position<F: Fn(&Self) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

pub fn emit_cancel_position(&self) -> bool

pub fn connect_cycle_child_focus<F: Fn(&Self, bool) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

This is a keybinding signal.

The default binding is F6.

reversed

whether cycling backward or forward

pub fn emit_cycle_child_focus(&self, reversed: bool) -> bool

pub fn connect_cycle_handle_focus<F: Fn(&Self, bool) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

reversed

whether cycling backward or forward

pub fn emit_cycle_handle_focus(&self, reversed: bool) -> bool

pub fn connect_move_handle<F: Fn(&Self, ScrollType) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted to move the handle with key bindings.

This is a keybinding signal.

scroll_type

a ScrollType

pub fn emit_move_handle(&self, scroll_type: ScrollType) -> bool

pub fn connect_toggle_handle_focus<F: Fn(&Self) -> bool + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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

pub fn emit_toggle_handle_focus(&self) -> bool

pub fn connect_end_child_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_max_position_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_min_position_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_position_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_position_set_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_resize_end_child_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_resize_start_child_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_shrink_end_child_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_shrink_start_child_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_start_child_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_wide_handle_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Trait Implementations

impl Clone for Paned

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Paned

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Paned

fn default() -> Self

Returns the “default value” for a type.

impl Display for Paned

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Paned

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Paned

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Paned

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for Paned

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Paned

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Paned

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Paned

impl IsA<Accessible> for Paned

impl IsA<AccessibleRange> for Paned

impl IsA<Buildable> for Paned

impl IsA<ConstraintTarget> for Paned

impl IsA<Orientable> for Paned

impl IsA<Widget> for Paned