GI.Gtk.Objects.StackSidebar

A GtkStackSidebar enables you to quickly and easily provide a consistent "sidebar" object for your user interface.

In order to use a GtkStackSidebar, you simply use a GtkStack to organize your UI flow, and add the sidebar to your sidebar area. You can use stackSidebarSetStack to connect the StackSidebar to the Stack.

CSS nodes

GtkStackSidebar has a single CSS node with name stacksidebar and style class .sidebar.

When circumstances require it, GtkStackSidebar adds the .needs-attention style class to the widgets representing the stack pages.

Exported types

newtype StackSidebar

Constructors

StackSidebar (ManagedPtr StackSidebar)

Instances

GObject StackSidebar

Methods

gobjectType :: StackSidebar -> IO GType

IsImplementorIface StackSidebar

IsObject StackSidebar

IsWidget StackSidebar

IsContainer StackSidebar

IsBin StackSidebar

IsBuildable StackSidebar

IsStackSidebar StackSidebar

class GObject o => IsStackSidebar o

Instances

(GObject a, UnknownAncestorError Constraint StackSidebar a) => IsStackSidebar a

IsStackSidebar StackSidebar

toStackSidebar :: (MonadIO m, IsStackSidebar o) => o -> m StackSidebar

noStackSidebar :: Maybe StackSidebar

Methods

getStack

stackSidebarGetStack

Arguments

:: (HasCallStack, MonadIO m, IsStackSidebar a)

=> a

sidebar: a StackSidebar

-> m (Maybe Stack)

Returns: the associated Stack or Nothing if none has been set explicitly

Retrieves the stack. See stackSidebarSetStack.

Since: 3.16

new

stackSidebarNew

Arguments

:: (HasCallStack, MonadIO m)

=> m StackSidebar

Returns: the new StackSidebar

Creates a new sidebar.

Since: 3.16

setStack

stackSidebarSetStack

Arguments

:: (HasCallStack, MonadIO m, IsStackSidebar a, IsStack b)

=> a

sidebar: a StackSidebar

-> b

stack: a Stack

-> m ()

Set the Stack associated with this StackSidebar.

The sidebar widget will automatically update according to the order (packing) and items within the given Stack.

Since: 3.16

Properties

stack

constructStackSidebarStack :: (IsStackSidebar o, IsStack a) => a -> IO (GValueConstruct o)

getStackSidebarStack :: (MonadIO m, IsStackSidebar o) => o -> m (Maybe Stack)

setStackSidebarStack :: (MonadIO m, IsStackSidebar o, IsStack a) => o -> a -> m ()