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.

Since: 3.16

Exported types

newtype StackSidebar

Memory-managed wrapper type.

Constructors

StackSidebar (ManagedPtr StackSidebar)

Instances

Eq StackSidebar

Defined in GI.Gtk.Objects.StackSidebar

Methods

(==) :: StackSidebar -> StackSidebar -> Bool

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

IsGValue StackSidebar

Convert StackSidebar to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.StackSidebar

Methods

toGValue :: StackSidebar -> IO GValue

fromGValue :: GValue -> IO StackSidebar

GObject StackSidebar

Defined in GI.Gtk.Objects.StackSidebar

Methods

gobjectType :: IO GType

HasParentTypes StackSidebar

Defined in GI.Gtk.Objects.StackSidebar

type ParentTypes StackSidebar

Defined in GI.Gtk.Objects.StackSidebar

type ParentTypes StackSidebar = '[Bin, Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf StackSidebar o) => IsStackSidebar o

Type class for types which can be safely cast to StackSidebar, for instance with toStackSidebar.

Instances

(GObject o, IsDescendantOf StackSidebar o) => IsStackSidebar o

Defined in GI.Gtk.Objects.StackSidebar

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

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

noStackSidebar :: Maybe StackSidebar

A convenience alias for Nothing :: Maybe StackSidebar.

Methods

Overloaded 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

No description available in the introspection data.

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

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

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

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

get stackSidebar #stack

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

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

set stackSidebar [ #stack := value ]