Struct gtk4::Paned

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

Properties

end-child

The second child.

Readable | Writeable

max-position

The largest possible value for the position property.

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

Readable

min-position

The smallest possible value for the position property.

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

Readable

position

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

Readable | Writeable

position-set

Whether the position property has been set.

Readable | Writeable

resize-end-child

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

Readable | Writeable

resize-start-child

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

Readable | Writeable

shrink-end-child

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

Readable | Writeable

shrink-start-child

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

Readable | Writeable

start-child

The first child.

Readable | Writeable

wide-handle

Whether the Paned should provide a stronger visual separation.

For example, this could be set when a paned contains two Notebooks, whose tab rows would otherwise merge visually.

Readable | Writeable

Widget

can-focus

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

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

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

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

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

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

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

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

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Signals

accept-position

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.

Action

cancel-position

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.

Action

cycle-child-focus

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

This is a keybinding signal.

The default binding is F6.

Action

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.

This is a keybinding signal.

The default binding for this signal is F8.

Action

move-handle

Emitted to move the handle with key bindings.

This is a keybinding signal.

Action

toggle-handle-focus

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.

Action

Widget

destroy

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

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

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

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

WidgetExt, [trait@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 end-child can be resized.

Returns

true if the end child is resizable

pub fn resizes_start_child(&self) -> bool

Returns whether the start-child can be resized.

Returns

true if the start child is resizable

pub fn shrinks_end_child(&self) -> bool

Returns whether the end-child can shrink.

Returns

true if the end child is shrinkable

pub fn shrinks_start_child(&self) -> bool

Returns whether the 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 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 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 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 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 wide-handle property

pub fn max_position(&self) -> i32

The largest possible value for the 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 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 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 HasParamSpec for Paned

type ParamSpec = ParamSpecObject

type SetValue = Paned

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Paned>

fn param_spec_builder() -> Self::BuilderFn

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

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