Class

AdwOverlaySplitView

Description [src]

final class Adw.OverlaySplitView : Gtk.Widget {
  /* No available fields */
}

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

overlay-split-view overlay-split-view-collapsed

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

When AdwOverlaySplitView: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 AdwOverlaySplitView:show-sidebar property.

Sidebar can be displayed before or after the content, this can be controlled with the AdwOverlaySplitView: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 AdwOverlaySplitView:pin-sidebar property can be used to override it.

AdwOverlaySplitView 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 AdwOverlaySplitView:enable-show-gesture and AdwOverlaySplitView:enable-hide-gesture properties.

See also AdwNavigationSplitView.

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

<object class="AdwWindow">
  <property name="width-request">360</property>
  <property name="height-request">200</property>
  <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>

AdwOverlaySplitView is often used for implementing the utility pane pattern.

Sizing

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

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

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

The minimum and maximum sizes are using the length unit specified with the AdwOverlaySplitView: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 AdwOverlaySplitView:max-sidebar-width when possible.

Header Bar Integration

When used inside AdwOverlaySplitView, AdwHeaderBar will automatically hide the window buttons in the middle.

AdwOverlaySplitView as GtkBuildable

The AdwOverlaySplitView implementation of the GtkBuildable 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

AdwOverlaySplitView 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

AdwOverlaySplitView uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Available since:1.4

Ancestors

  • GtkWidget
  • GInitiallyUnowned
  • GObject

Implements

  • AdwSwipeable
  • GtkAccessible
  • GtkBuildable
  • GtkConstraintTarget

Constructors

adw_overlay_split_view_new

Creates a new AdwOverlaySplitView.

Available since: 1.4

Instance methods

adw_overlay_split_view_get_collapsed

Gets whether self is collapsed.

Available since: 1.4

adw_overlay_split_view_get_content

Gets the content widget for self.

Available since: 1.4

adw_overlay_split_view_get_enable_hide_gesture

Gets whether self can be closed with a swipe gesture.

Available since: 1.4

adw_overlay_split_view_get_enable_show_gesture

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

Available since: 1.4

adw_overlay_split_view_get_max_sidebar_width

Gets the maximum sidebar width for self.

Available since: 1.4

adw_overlay_split_view_get_min_sidebar_width

Gets the minimum sidebar width for self.

Available since: 1.4

adw_overlay_split_view_get_pin_sidebar

Gets whether the sidebar widget is pinned for self.

Available since: 1.4

adw_overlay_split_view_get_show_sidebar

Gets whether the sidebar widget is shown for self.

Available since: 1.4

adw_overlay_split_view_get_sidebar

Gets the sidebar widget for self.

Available since: 1.4

adw_overlay_split_view_get_sidebar_position

Gets the sidebar position for self.

Available since: 1.4

adw_overlay_split_view_get_sidebar_width_fraction

Gets the preferred sidebar width fraction for self.

Available since: 1.4

adw_overlay_split_view_get_sidebar_width_unit

Gets the length unit for minimum and maximum sidebar widths.

Available since: 1.4

adw_overlay_split_view_set_collapsed

Sets whether self view is collapsed.

Available since: 1.4

adw_overlay_split_view_set_content

Sets the content widget for self.

Available since: 1.4

adw_overlay_split_view_set_enable_hide_gesture

Sets whether self can be closed with a swipe gesture.

Available since: 1.4

adw_overlay_split_view_set_enable_show_gesture

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

Available since: 1.4

adw_overlay_split_view_set_max_sidebar_width

Sets the maximum sidebar width for self.

Available since: 1.4

adw_overlay_split_view_set_min_sidebar_width

Sets the minimum sidebar width for self.

Available since: 1.4

adw_overlay_split_view_set_pin_sidebar

Sets whether the sidebar widget is pinned for self.

Available since: 1.4

adw_overlay_split_view_set_show_sidebar

Sets whether the sidebar widget is shown for self.

Available since: 1.4

adw_overlay_split_view_set_sidebar

Sets the sidebar widget for self.

Available since: 1.4

adw_overlay_split_view_set_sidebar_position

Sets the sidebar position for self.

Available since: 1.4

adw_overlay_split_view_set_sidebar_width_fraction

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

Available since: 1.4

adw_overlay_split_view_set_sidebar_width_unit

Sets the length unit for minimum and maximum sidebar widths.

Available since: 1.4

Methods inherited from AdwSwipeable (5)
adw_swipeable_get_cancel_progress

Gets the progress self will snap back to after the gesture is canceled.

adw_swipeable_get_distance

Gets the swipe distance of self.

adw_swipeable_get_progress

Gets the current progress of self.

adw_swipeable_get_snap_points

Gets the snap points of self.

adw_swipeable_get_swipe_area

Gets the area self can start a swipe from for the given direction and gesture type.

Properties

Adw.OverlaySplitView:collapsed

Whether the split view is collapsed.

Available since: 1.4

Adw.OverlaySplitView:content

The content widget.

Available since: 1.4

Adw.OverlaySplitView:enable-hide-gesture

Whether the sidebar can be closed with a swipe gesture.

Available since: 1.4

Adw.OverlaySplitView:enable-show-gesture

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

Available since: 1.4

Adw.OverlaySplitView:max-sidebar-width

The maximum sidebar width.

Available since: 1.4

Adw.OverlaySplitView:min-sidebar-width

The minimum sidebar width.

Available since: 1.4

Adw.OverlaySplitView:pin-sidebar

Whether the sidebar widget is pinned.

Available since: 1.4

Adw.OverlaySplitView:show-sidebar

Whether the sidebar widget is shown.

Available since: 1.4

Adw.OverlaySplitView:sidebar

The sidebar widget.

Available since: 1.4

Adw.OverlaySplitView:sidebar-position

The sidebar position.

Available since: 1.4

Adw.OverlaySplitView:sidebar-width-fraction

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

Available since: 1.4

Adw.OverlaySplitView:sidebar-width-unit

The length unit for minimum and maximum sidebar widths.

Available since: 1.4

Class structure

struct AdwOverlaySplitViewClass {
  GtkWidgetClass parent_class;
  
}
Class members
parent_class
GtkWidgetClass
  No description available.