OverlaySplitView

Added in version 1.4.

class OverlaySplitView(**properties: Any)

Superclasses: Widget, InitiallyUnowned, Object

Implemented Interfaces: Swipeable, Accessible, Buildable, ConstraintTarget

Constructors:

OverlaySplitView(**properties)
new() -> Gtk.Widget

Constructors

class OverlaySplitView

classmethod new() → Widget: Creates a new AdwOverlaySplitView.

Added in version 1.4.

Methods

class OverlaySplitView

get_collapsed() → bool: Gets whether self is collapsed.

Added in version 1.4.

get_content() → Widget | None: Gets the content widget for self.

Added in version 1.4.

get_enable_hide_gesture() → bool: Gets whether self can be closed with a swipe gesture.

Added in version 1.4.

get_enable_show_gesture() → bool: Gets whether self can be opened with an edge swipe gesture.

Added in version 1.4.

get_max_sidebar_width() → float: Gets the maximum sidebar width for self.

Added in version 1.4.

get_min_sidebar_width() → float: Gets the minimum sidebar width for self.

Added in version 1.4.

get_pin_sidebar() → bool: Gets whether the sidebar widget is pinned for self.

Added in version 1.4.

get_show_sidebar() → bool: Gets whether the sidebar widget is shown for self.

Added in version 1.4.

get_sidebar() → Widget | None: Gets the sidebar widget for self.

Added in version 1.4.

get_sidebar_position() → PackType: Gets the sidebar position for self.

Added in version 1.4.

get_sidebar_width_fraction() → float: Gets the preferred sidebar width fraction for self.

Added in version 1.4.

get_sidebar_width_unit() → LengthUnit: Gets the length unit for minimum and maximum sidebar widths.

Added in version 1.4.

set_collapsed(collapsed: bool) → None

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.

Added in version 1.4.

Parameters:: collapsed – whether self is collapsed

set_content(content: Widget | None = None) → None

Sets the content widget for self.

Added in version 1.4.

Parameters:: content – the content widget

set_enable_hide_gesture(enable_hide_gesture: bool) → None

Sets whether self can be closed with a swipe gesture.

Only touchscreen swipes are supported.

Added in version 1.4.

Parameters:: enable_hide_gesture – whether self can be closed with a swipe gesture

set_enable_show_gesture(enable_show_gesture: bool) → None

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

Only touchscreen swipes are supported.

Added in version 1.4.

Parameters:: enable_show_gesture – whether self can be opened with a swipe gesture

set_max_sidebar_width(width: float) → None

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.

Added in version 1.4.

Parameters:: width – the maximum width

set_min_sidebar_width(width: float) → None

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.

Added in version 1.4.

Parameters:: width – the minimum width

set_pin_sidebar(pin_sidebar: bool) → None

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.

Added in version 1.4.

Parameters:: pin_sidebar – whether to pin the sidebar widget

set_show_sidebar(show_sidebar: bool) → None

Sets whether the sidebar widget is shown for self.

Added in version 1.4.

Parameters:: show_sidebar – whether to show the sidebar widget

set_sidebar(sidebar: Widget | None = None) → None

Sets the sidebar widget for self.

Added in version 1.4.

Parameters:: sidebar – the sidebar widget

set_sidebar_position(position: PackType) → None

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.

Added in version 1.4.

Parameters:: position – the new position

set_sidebar_width_fraction(fraction: float) → None

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.

Added in version 1.4.

Parameters:: fraction – the preferred width fraction

set_sidebar_width_unit(unit: LengthUnit) → None

Sets the length unit for minimum and maximum sidebar widths.

See min_sidebar_width and max_sidebar_width.

Added in version 1.4.

Parameters:: unit – the length unit

Properties

class OverlaySplitView

props.collapsed: bool

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.

Added in version 1.4.

props.content: Widget: The content widget.

Added in version 1.4.

props.enable_hide_gesture: bool

Whether the sidebar can be closed with a swipe gesture.

Only touchscreen swipes are supported.

Added in version 1.4.

props.enable_show_gesture: bool

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

Only touchscreen swipes are supported.

Added in version 1.4.

props.max_sidebar_width: float

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.

Added in version 1.4.

props.min_sidebar_width: float

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.

Added in version 1.4.

props.pin_sidebar: bool

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.

Added in version 1.4.

props.show_sidebar: bool: Whether the sidebar widget is shown.

Added in version 1.4.

props.sidebar: Widget: The sidebar widget.

Added in version 1.4.

props.sidebar_position: PackType

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.

Added in version 1.4.

props.sidebar_width_fraction: float

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.

Added in version 1.4.

props.sidebar_width_unit: LengthUnit

The length unit for minimum and maximum sidebar widths.

See min_sidebar_width and max_sidebar_width.

Added in version 1.4.