GI.Adw.Objects.OverlaySplitView

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

<picture> <source srcset="overlay-split-view-dark.png" media="(prefers-color-scheme: dark)"> <img src="overlay-split-view.png" alt="overlay-split-view"> </picture> <picture> <source srcset="overlay-split-view-collapsed-dark.png" media="(prefers-color-scheme: dark)"> <img src="overlay-split-view-collapsed.png" alt="overlay-split-view-collapsed"> </picture>

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

When [propertyoverlaySplitView: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 [propertyoverlaySplitView:show-sidebar] property.

Sidebar can be displayed before or after the content, this can be controlled with the [propertyoverlaySplitView: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 [propertyoverlaySplitView: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 [propertyoverlaySplitView:enable-show-gesture] and [propertyoverlaySplitView:enable-hide-gesture] properties.

See also [classnavigationSplitView].

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

xml code

<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 [propertyoverlaySplitView:sidebar-width-fraction] property.

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

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

Header Bar Integration

When used inside AdwOverlaySplitView, [classheaderBar] will automatically hide the window buttons in the middle.

AdwOverlaySplitView as GtkBuildable

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

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.

Since: 1.4

Exported types

newtype OverlaySplitView

Memory-managed wrapper type.

Constructors

OverlaySplitView (ManagedPtr OverlaySplitView)

Instances

Eq OverlaySplitView

Defined in GI.Adw.Objects.OverlaySplitView

Methods

(==) :: OverlaySplitView -> OverlaySplitView -> Bool

(/=) :: OverlaySplitView -> OverlaySplitView -> Bool

GObject OverlaySplitView

Defined in GI.Adw.Objects.OverlaySplitView

ManagedPtrNewtype OverlaySplitView

Defined in GI.Adw.Objects.OverlaySplitView

Methods

toManagedPtr :: OverlaySplitView -> ManagedPtr OverlaySplitView

TypedObject OverlaySplitView

Defined in GI.Adw.Objects.OverlaySplitView

Methods

glibType :: IO GType

HasParentTypes OverlaySplitView

Defined in GI.Adw.Objects.OverlaySplitView

IsGValue (Maybe OverlaySplitView)

Convert OverlaySplitView to and from GValue. See toGValue and fromGValue.

Defined in GI.Adw.Objects.OverlaySplitView

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe OverlaySplitView -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe OverlaySplitView)

type ParentTypes OverlaySplitView

Defined in GI.Adw.Objects.OverlaySplitView

type ParentTypes OverlaySplitView = '[Widget, Object, Swipeable, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf OverlaySplitView o) => IsOverlaySplitView o

Type class for types which can be safely cast to OverlaySplitView, for instance with toOverlaySplitView.

Instances

(GObject o, IsDescendantOf OverlaySplitView o) => IsOverlaySplitView o

Defined in GI.Adw.Objects.OverlaySplitView

toOverlaySplitView :: (MonadIO m, IsOverlaySplitView o) => o -> m OverlaySplitView

Cast to OverlaySplitView, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, announce, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBaseline, getBounds, getBuildableId, getCanFocus, getCanTarget, getCancelProgress, getChildVisible, getClipboard, getCollapsed, getColor, getContent, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getDistance, getEnableHideGesture, getEnableShowGesture, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMaxSidebarWidth, getMinSidebarWidth, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPinSidebar, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProgress, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getShowSidebar, getSidebar, getSidebarPosition, getSidebarWidthFraction, getSidebarWidthUnit, getSize, getSizeRequest, getSnapPoints, getStateFlags, getStyleContext, getSwipeArea, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setAccessibleParent, setCanFocus, setCanTarget, setChildVisible, setCollapsed, setContent, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setEnableHideGesture, setEnableShowGesture, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMaxSidebarWidth, setMinSidebarWidth, setName, setOpacity, setOverflow, setParent, setPinSidebar, setProperty, setReceivesDefault, setSensitive, setShowSidebar, setSidebar, setSidebarPosition, setSidebarWidthFraction, setSidebarWidthUnit, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

getCollapsed

overlaySplitViewGetCollapsed

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m Bool

Returns: whether self is collapsed

Gets whether self is collapsed.

Since: 1.4

getContent

overlaySplitViewGetContent

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m (Maybe Widget)

Returns: the content widget for self

Gets the content widget for self.

Since: 1.4

getEnableHideGesture

overlaySplitViewGetEnableHideGesture

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m Bool

Returns: TRUE if self can be closed with a swipe gesture

Gets whether self can be closed with a swipe gesture.

Since: 1.4

getEnableShowGesture

overlaySplitViewGetEnableShowGesture

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m Bool

Returns: TRUE if self can be opened with a swipe gesture

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

Since: 1.4

getMaxSidebarWidth

overlaySplitViewGetMaxSidebarWidth

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m Double

Returns: the maximum width

Gets the maximum sidebar width for self.

Since: 1.4

getMinSidebarWidth

overlaySplitViewGetMinSidebarWidth

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m Double

Returns: the minimum width

Gets the minimum sidebar width for self.

Since: 1.4

getPinSidebar

overlaySplitViewGetPinSidebar

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m Bool

Returns: whether if the sidebar widget is pinned

Gets whether the sidebar widget is pinned for self.

Since: 1.4

getShowSidebar

overlaySplitViewGetShowSidebar

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m Bool

Returns: TRUE if the sidebar widget is shown

Gets whether the sidebar widget is shown for self.

Since: 1.4

getSidebar

overlaySplitViewGetSidebar

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m (Maybe Widget)

Returns: the sidebar widget for self

Gets the sidebar widget for self.

Since: 1.4

getSidebarPosition

overlaySplitViewGetSidebarPosition

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m PackType

Returns: the sidebar position for self

Gets the sidebar position for self.

Since: 1.4

getSidebarWidthFraction

overlaySplitViewGetSidebarWidthFraction

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m Double

Returns: the preferred width fraction

Gets the preferred sidebar width fraction for self.

Since: 1.4

getSidebarWidthUnit

overlaySplitViewGetSidebarWidthUnit

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> m LengthUnit

Returns: the length unit

Gets the length unit for minimum and maximum sidebar widths.

Since: 1.4

new

overlaySplitViewNew

Arguments

:: (HasCallStack, MonadIO m)

=> m OverlaySplitView

Returns: the newly created AdwOverlaySplitView

Creates a new AdwOverlaySplitView.

Since: 1.4

setCollapsed

overlaySplitViewSetCollapsed

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> Bool

collapsed: whether self is collapsed

-> m ()

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.

Since: 1.4

setContent

overlaySplitViewSetContent

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a, IsWidget b)

=> a

self: an overlay split view

-> Maybe b

content: the content widget

-> m ()

Sets the content widget for self.

Since: 1.4

setEnableHideGesture

overlaySplitViewSetEnableHideGesture

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> Bool

enableHideGesture: whether self can be closed with a swipe gesture

-> m ()

Sets whether self can be closed with a swipe gesture.

Only touchscreen swipes are supported.

Since: 1.4

setEnableShowGesture

overlaySplitViewSetEnableShowGesture

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> Bool

enableShowGesture: whether self can be opened with a swipe gesture

-> m ()

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

Only touchscreen swipes are supported.

Since: 1.4

setMaxSidebarWidth

overlaySplitViewSetMaxSidebarWidth

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> Double

width: the maximum width

-> m ()

Sets the maximum sidebar width for self.

Maximum width is affected by [propertyoverlaySplitView:sidebar-width-unit].

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

Since: 1.4

setMinSidebarWidth

overlaySplitViewSetMinSidebarWidth

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> Double

width: the minimum width

-> m ()

Sets the minimum sidebar width for self.

Minimum width is affected by [propertyoverlaySplitView:sidebar-width-unit].

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

Since: 1.4

setPinSidebar

overlaySplitViewSetPinSidebar

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> Bool

pinSidebar: whether to pin the sidebar widget

-> m ()

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.

Since: 1.4

setShowSidebar

overlaySplitViewSetShowSidebar

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> Bool

showSidebar: whether to show the sidebar widget

-> m ()

Sets whether the sidebar widget is shown for self.

Since: 1.4

setSidebar

overlaySplitViewSetSidebar

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a, IsWidget b)

=> a

self: an overlay split view

-> Maybe b

sidebar: the sidebar widget

-> m ()

Sets the sidebar widget for self.

Since: 1.4

setSidebarPosition

overlaySplitViewSetSidebarPosition

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> PackType

position: the new position

-> m ()

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.

Since: 1.4

setSidebarWidthFraction

overlaySplitViewSetSidebarWidthFraction

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> Double

fraction: the preferred width fraction

-> m ()

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

The preferred width is additionally limited by [propertyoverlaySplitView:min-sidebar-width] and [propertyoverlaySplitView:max-sidebar-width].

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

Since: 1.4

setSidebarWidthUnit

overlaySplitViewSetSidebarWidthUnit

Arguments

:: (HasCallStack, MonadIO m, IsOverlaySplitView a)

=> a

self: an overlay split view

-> LengthUnit

unit: the length unit

-> m ()

Sets the length unit for minimum and maximum sidebar widths.

See [propertyoverlaySplitView:min-sidebar-width] and [propertyoverlaySplitView:max-sidebar-width].

Since: 1.4

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.

Since: 1.4

constructOverlaySplitViewCollapsed :: (IsOverlaySplitView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “collapsed” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewCollapsed :: (MonadIO m, IsOverlaySplitView o) => o -> m Bool

Get the value of the “collapsed” property. When overloading is enabled, this is equivalent to

get overlaySplitView #collapsed

setOverlaySplitViewCollapsed :: (MonadIO m, IsOverlaySplitView o) => o -> Bool -> m ()

Set the value of the “collapsed” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #collapsed := value ]

content

The content widget.

Since: 1.4

clearOverlaySplitViewContent :: (MonadIO m, IsOverlaySplitView o) => o -> m ()

Set the value of the “content” property to Nothing. When overloading is enabled, this is equivalent to

clear #content

constructOverlaySplitViewContent :: (IsOverlaySplitView o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “content” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewContent :: (MonadIO m, IsOverlaySplitView o) => o -> m (Maybe Widget)

Get the value of the “content” property. When overloading is enabled, this is equivalent to

get overlaySplitView #content

setOverlaySplitViewContent :: (MonadIO m, IsOverlaySplitView o, IsWidget a) => o -> a -> m ()

Set the value of the “content” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #content := value ]

enableHideGesture

Whether the sidebar can be closed with a swipe gesture.

Only touchscreen swipes are supported.

Since: 1.4

constructOverlaySplitViewEnableHideGesture :: (IsOverlaySplitView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “enable-hide-gesture” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewEnableHideGesture :: (MonadIO m, IsOverlaySplitView o) => o -> m Bool

Get the value of the “enable-hide-gesture” property. When overloading is enabled, this is equivalent to

get overlaySplitView #enableHideGesture

setOverlaySplitViewEnableHideGesture :: (MonadIO m, IsOverlaySplitView o) => o -> Bool -> m ()

Set the value of the “enable-hide-gesture” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #enableHideGesture := value ]

enableShowGesture

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

Only touchscreen swipes are supported.

Since: 1.4

constructOverlaySplitViewEnableShowGesture :: (IsOverlaySplitView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “enable-show-gesture” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewEnableShowGesture :: (MonadIO m, IsOverlaySplitView o) => o -> m Bool

Get the value of the “enable-show-gesture” property. When overloading is enabled, this is equivalent to

get overlaySplitView #enableShowGesture

setOverlaySplitViewEnableShowGesture :: (MonadIO m, IsOverlaySplitView o) => o -> Bool -> m ()

Set the value of the “enable-show-gesture” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #enableShowGesture := value ]

maxSidebarWidth

The maximum sidebar width.

Maximum width is affected by [propertyoverlaySplitView:sidebar-width-unit].

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

Since: 1.4

constructOverlaySplitViewMaxSidebarWidth :: (IsOverlaySplitView o, MonadIO m) => Double -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “max-sidebar-width” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewMaxSidebarWidth :: (MonadIO m, IsOverlaySplitView o) => o -> m Double

Get the value of the “max-sidebar-width” property. When overloading is enabled, this is equivalent to

get overlaySplitView #maxSidebarWidth

setOverlaySplitViewMaxSidebarWidth :: (MonadIO m, IsOverlaySplitView o) => o -> Double -> m ()

Set the value of the “max-sidebar-width” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #maxSidebarWidth := value ]

minSidebarWidth

The minimum sidebar width.

Minimum width is affected by [propertyoverlaySplitView:sidebar-width-unit].

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

Since: 1.4

constructOverlaySplitViewMinSidebarWidth :: (IsOverlaySplitView o, MonadIO m) => Double -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “min-sidebar-width” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewMinSidebarWidth :: (MonadIO m, IsOverlaySplitView o) => o -> m Double

Get the value of the “min-sidebar-width” property. When overloading is enabled, this is equivalent to

get overlaySplitView #minSidebarWidth

setOverlaySplitViewMinSidebarWidth :: (MonadIO m, IsOverlaySplitView o) => o -> Double -> m ()

Set the value of the “min-sidebar-width” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #minSidebarWidth := value ]

pinSidebar

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.

Since: 1.4

constructOverlaySplitViewPinSidebar :: (IsOverlaySplitView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pin-sidebar” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewPinSidebar :: (MonadIO m, IsOverlaySplitView o) => o -> m Bool

Get the value of the “pin-sidebar” property. When overloading is enabled, this is equivalent to

get overlaySplitView #pinSidebar

setOverlaySplitViewPinSidebar :: (MonadIO m, IsOverlaySplitView o) => o -> Bool -> m ()

Set the value of the “pin-sidebar” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #pinSidebar := value ]

showSidebar

Whether the sidebar widget is shown.

Since: 1.4

constructOverlaySplitViewShowSidebar :: (IsOverlaySplitView o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-sidebar” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewShowSidebar :: (MonadIO m, IsOverlaySplitView o) => o -> m Bool

Get the value of the “show-sidebar” property. When overloading is enabled, this is equivalent to

get overlaySplitView #showSidebar

setOverlaySplitViewShowSidebar :: (MonadIO m, IsOverlaySplitView o) => o -> Bool -> m ()

Set the value of the “show-sidebar” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #showSidebar := value ]

sidebar

The sidebar widget.

Since: 1.4

clearOverlaySplitViewSidebar :: (MonadIO m, IsOverlaySplitView o) => o -> m ()

Set the value of the “sidebar” property to Nothing. When overloading is enabled, this is equivalent to

clear #sidebar

constructOverlaySplitViewSidebar :: (IsOverlaySplitView o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “sidebar” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewSidebar :: (MonadIO m, IsOverlaySplitView o) => o -> m (Maybe Widget)

Get the value of the “sidebar” property. When overloading is enabled, this is equivalent to

get overlaySplitView #sidebar

setOverlaySplitViewSidebar :: (MonadIO m, IsOverlaySplitView o, IsWidget a) => o -> a -> m ()

Set the value of the “sidebar” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #sidebar := value ]

sidebarPosition

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.

Since: 1.4

constructOverlaySplitViewSidebarPosition :: (IsOverlaySplitView o, MonadIO m) => PackType -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “sidebar-position” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewSidebarPosition :: (MonadIO m, IsOverlaySplitView o) => o -> m PackType

Get the value of the “sidebar-position” property. When overloading is enabled, this is equivalent to

get overlaySplitView #sidebarPosition

setOverlaySplitViewSidebarPosition :: (MonadIO m, IsOverlaySplitView o) => o -> PackType -> m ()

Set the value of the “sidebar-position” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #sidebarPosition := value ]

sidebarWidthFraction

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

The preferred width is additionally limited by [propertyoverlaySplitView:min-sidebar-width] and [propertyoverlaySplitView:max-sidebar-width].

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

Since: 1.4

constructOverlaySplitViewSidebarWidthFraction :: (IsOverlaySplitView o, MonadIO m) => Double -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “sidebar-width-fraction” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewSidebarWidthFraction :: (MonadIO m, IsOverlaySplitView o) => o -> m Double

Get the value of the “sidebar-width-fraction” property. When overloading is enabled, this is equivalent to

get overlaySplitView #sidebarWidthFraction

setOverlaySplitViewSidebarWidthFraction :: (MonadIO m, IsOverlaySplitView o) => o -> Double -> m ()

Set the value of the “sidebar-width-fraction” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #sidebarWidthFraction := value ]

sidebarWidthUnit

The length unit for minimum and maximum sidebar widths.

See [propertyoverlaySplitView:min-sidebar-width] and [propertyoverlaySplitView:max-sidebar-width].

Since: 1.4

constructOverlaySplitViewSidebarWidthUnit :: (IsOverlaySplitView o, MonadIO m) => LengthUnit -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “sidebar-width-unit” property. This is rarely needed directly, but it is used by new.

getOverlaySplitViewSidebarWidthUnit :: (MonadIO m, IsOverlaySplitView o) => o -> m LengthUnit

Get the value of the “sidebar-width-unit” property. When overloading is enabled, this is equivalent to

get overlaySplitView #sidebarWidthUnit

setOverlaySplitViewSidebarWidthUnit :: (MonadIO m, IsOverlaySplitView o) => o -> LengthUnit -> m ()

Set the value of the “sidebar-width-unit” property. When overloading is enabled, this is equivalent to

set overlaySplitView [ #sidebarWidthUnit := value ]