Struct OverlaySplitView 

pub struct OverlaySplitView { /* private fields */ }

Available on crate feature v1_4 only.

A widget presenting sidebar and content side by side or as an overlay.

OverlaySplitView has two children: sidebar and content, and displays them side by side.

When collapsed is set to TRUE, the sidebar is instead shown as an overlay above the content widget.

The sidebar can be hidden or shown using the show-sidebar property.

Sidebar can be displayed before or after the content, this can be controlled with the sidebar-position property.

Collapsing the split view automatically hides the sidebar widget, and uncollapsing it shows the sidebar. If this behavior is not desired, the pin-sidebar property can be used to override it.

OverlaySplitView supports an edge swipe gesture for showing the sidebar, and a swipe from the sidebar for hiding it. Gestures are only supported on touchscreen, but not touchpad. Gestures can be controlled with the enable-show-gesture and enable-hide-gesture properties.

See also NavigationSplitView.

OverlaySplitView is typically used together with an Breakpoint setting the collapsed property to TRUE on small widths, as follows:

<object class="AdwWindow">
  <property name="default-width">800</property>
  <property name="default-height">800</property>
  <child>
    <object class="AdwBreakpoint">
      <condition>max-width: 400sp</condition>
      <setter object="split_view" property="collapsed">True</setter>
    </object>
  </child>
  <property name="content">
    <object class="AdwOverlaySplitView" id="split_view">
      <property name="sidebar">
        <!-- ... -->
      </property>
      <property name="content">
        <!-- ... -->
      </property>
    </object>
  </property>
</object>

OverlaySplitView is often used for implementing the utility pane pattern.

Sizing

When not collapsed, OverlaySplitView changes the sidebar width depending on its own width.

If possible, it tries to allocate a fraction of the total width, controlled with the sidebar-width-fraction property.

The sidebar also has minimum and maximum sizes, controlled with the min-sidebar-width and max-sidebar-width properties.

The minimum and maximum sizes are using the length unit specified with the sidebar-width-unit.

By default, sidebar is using 25% of the total width, with 180sp as the minimum size and 280sp as the maximum size.

When collapsed, the preferred width fraction is ignored and the sidebar uses max-sidebar-width when possible.

Header Bar Integration

When used inside OverlaySplitView, HeaderBar will automatically hide the window buttons in the middle.

OverlaySplitView as gtk::Buildable

The OverlaySplitView implementation of the gtk::Buildable interface supports setting the sidebar widget by specifying “sidebar” as the “type” attribute of a <child> element, Specifying “content” child type or omitting it results in setting the content widget.

CSS nodes

OverlaySplitView has a single CSS node with the name overlay-split-view.

It contains two nodes with the name widget, containing the sidebar and content children.

When not collapsed, they have the .sidebar-view and .content-view style classes respectively.

overlay-split-view
├── widget.sidebar-pane
│   ╰── [sidebar child]
╰── widget.content-pane
    ╰── [content child]

When collapsed, the one containing the sidebar child has the .background style class and the other one has no style classes.

overlay-split-view
├── widget.background
│   ╰── [sidebar child]
╰── widget
    ╰── [content child]

Accessibility

OverlaySplitView uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Properties

collapsed

Whether the split view is collapsed.

When collapsed, the sidebar widget is presented as an overlay above the content widget, otherwise they are displayed side by side.

Readable | Writeable

content

The content widget.

Readable | Writeable

enable-hide-gesture

Whether the sidebar can be closed with a swipe gesture.

Only touchscreen swipes are supported.

Readable | Writeable

enable-show-gesture

Whether the sidebar can be opened with an edge swipe gesture.

Only touchscreen swipes are supported.

Readable | Writeable

max-sidebar-width

The maximum sidebar width.

Maximum width is affected by sidebar-width-unit.

The sidebar widget can still be allocated with larger width if its own minimum width exceeds it.

Readable | Writeable

min-sidebar-width

The minimum sidebar width.

Minimum width is affected by sidebar-width-unit.

The sidebar widget can still be allocated with larger width if its own minimum width exceeds it.

Readable | Writeable

pin-sidebar

Whether the sidebar widget is pinned.

By default, collapsing @self_ automatically hides the sidebar widget, and uncollapsing it shows the sidebar. If set to TRUE, sidebar visibility never changes on its own.

Readable | Writeable

show-sidebar

Whether the sidebar widget is shown.

Readable | Writeable

sidebar

The sidebar widget.

Readable | Writeable

sidebar-position

The sidebar position.

If it’s set to GTK_PACK_START, the sidebar is displayed before the content, if GTK_PACK_END, it’s displayed after the content.

Readable | Writeable

sidebar-width-fraction

The preferred sidebar width as a fraction of the total width.

The preferred width is additionally limited by min-sidebar-width and max-sidebar-width.

The sidebar widget can be allocated with larger width if its own minimum width exceeds the preferred width.

Readable | Writeable

sidebar-width-unit

The length unit for minimum and maximum sidebar widths.

See min-sidebar-width and max-sidebar-width.

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 true value 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

Overrides 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 gtk::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

limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See Gtk::EventController::set_propagation_limit().

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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 gtk::Root widget of the widget tree containing this widget.

This will be NULL 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 Gtk::Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: 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 Gtk::Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: 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

Overrides 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 gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt, SwipeableExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl OverlaySplitView

pub fn new() -> OverlaySplitView

Creates a new OverlaySplitView.

Returns

the newly created OverlaySplitView

pub fn builder() -> OverlaySplitViewBuilder

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

This method returns an instance of OverlaySplitViewBuilder which can be used to create OverlaySplitView objects.

pub fn is_collapsed(&self) -> bool

Gets whether @self is collapsed.

Returns

whether @self is collapsed

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

Gets the content widget for @self.

Returns

the content widget for @self

pub fn enables_hide_gesture(&self) -> bool

Gets whether @self can be closed with a swipe gesture.

Returns

TRUE if @self can be closed with a swipe gesture

pub fn enables_show_gesture(&self) -> bool

Gets whether @self can be opened with an edge swipe gesture.

Returns

TRUE if @self can be opened with a swipe gesture

pub fn max_sidebar_width(&self) -> f64

Gets the maximum sidebar width for @self.

Returns

the maximum width

pub fn min_sidebar_width(&self) -> f64

Gets the minimum sidebar width for @self.

Returns

the minimum width

pub fn is_pin_sidebar(&self) -> bool

Gets whether the sidebar widget is pinned for @self.

Returns

whether if the sidebar widget is pinned

pub fn shows_sidebar(&self) -> bool

Gets whether the sidebar widget is shown for @self.

Returns

TRUE if the sidebar widget is shown

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

Gets the sidebar widget for @self.

Returns

the sidebar widget for @self

pub fn sidebar_position(&self) -> PackType

Gets the sidebar position for @self.

Returns

the sidebar position for @self

pub fn sidebar_width_fraction(&self) -> f64

Gets the preferred sidebar width fraction for @self.

Returns

the preferred width fraction

pub fn sidebar_width_unit(&self) -> LengthUnit

Gets the length unit for minimum and maximum sidebar widths.

Returns

the length unit

pub fn set_collapsed(&self, collapsed: bool)

Sets whether @self view is collapsed.

When collapsed, the sidebar widget is presented as an overlay above the content widget, otherwise they are displayed side by side.

collapsed

whether @self is collapsed

pub fn set_content(&self, content: Option<&impl IsA<Widget>>)

Sets the content widget for @self.

content

the content widget

pub fn set_enable_hide_gesture(&self, enable_hide_gesture: bool)

Sets whether @self can be closed with a swipe gesture.

Only touchscreen swipes are supported.

enable_hide_gesture

whether @self can be closed with a swipe gesture

pub fn set_enable_show_gesture(&self, enable_show_gesture: bool)

Sets whether @self can be opened with an edge swipe gesture.

Only touchscreen swipes are supported.

enable_show_gesture

whether @self can be opened with a swipe gesture

pub fn set_max_sidebar_width(&self, width: f64)

Sets the maximum sidebar width for @self.

Maximum width is affected by sidebar-width-unit.

The sidebar widget can still be allocated with larger width if its own minimum width exceeds it.

width

the maximum width

pub fn set_min_sidebar_width(&self, width: f64)

Sets the minimum sidebar width for @self.

Minimum width is affected by sidebar-width-unit.

The sidebar widget can still be allocated with larger width if its own minimum width exceeds it.

width

the minimum width

pub fn set_pin_sidebar(&self, pin_sidebar: bool)

Sets whether the sidebar widget is pinned for @self.

By default, collapsing @self automatically hides the sidebar widget, and uncollapsing it shows the sidebar. If set to TRUE, sidebar visibility never changes on its own.

pin_sidebar

whether to pin the sidebar widget

pub fn set_show_sidebar(&self, show_sidebar: bool)

Sets whether the sidebar widget is shown for @self.

show_sidebar

whether to show the sidebar widget

pub fn set_sidebar(&self, sidebar: Option<&impl IsA<Widget>>)

Sets the sidebar widget for @self.

sidebar

the sidebar widget

pub fn set_sidebar_position(&self, position: PackType)

Sets the sidebar position for @self.

If it’s set to GTK_PACK_START, the sidebar is displayed before the content, if GTK_PACK_END, it’s displayed after the content.

position

the new position

pub fn set_sidebar_width_fraction(&self, fraction: f64)

Sets the preferred sidebar width as a fraction of the total width of @self.

The preferred width is additionally limited by min-sidebar-width and max-sidebar-width.

The sidebar widget can be allocated with larger width if its own minimum width exceeds the preferred width.

fraction

the preferred width fraction

pub fn set_sidebar_width_unit(&self, unit: LengthUnit)

Sets the length unit for minimum and maximum sidebar widths.

See min-sidebar-width and max-sidebar-width.

unit

the length unit

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for OverlaySplitView

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for OverlaySplitView

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

Formats the value using the given formatter.

impl Default for OverlaySplitView

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for OverlaySplitView

type ParamSpec = ParamSpecObject

type SetValue = OverlaySplitView

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for OverlaySplitView

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

where H: Hasher,

Hashes the memory address of this object.

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 OverlaySplitView

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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,

Restrict a value to a certain interval.

impl ParentClassIs for OverlaySplitView

type Parent = Widget

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for OverlaySplitView

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for OverlaySplitView

impl IsA<Accessible> for OverlaySplitView

impl IsA<Buildable> for OverlaySplitView

impl IsA<ConstraintTarget> for OverlaySplitView

impl IsA<Swipeable> for OverlaySplitView

impl IsA<Widget> for OverlaySplitView