| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gtk.Objects.StackSidebar
Description
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.
Synopsis
- newtype StackSidebar = StackSidebar (ManagedPtr StackSidebar)
- class GObject o => IsStackSidebar o
- toStackSidebar :: (MonadIO m, IsStackSidebar o) => o -> m StackSidebar
- noStackSidebar :: Maybe StackSidebar
- stackSidebarGetStack :: (HasCallStack, MonadIO m, IsStackSidebar a) => a -> m (Maybe Stack)
- stackSidebarNew :: (HasCallStack, MonadIO m) => m StackSidebar
- stackSidebarSetStack :: (HasCallStack, MonadIO m, IsStackSidebar a, IsStack b) => a -> b -> m ()
- 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 ()
Exported types
newtype StackSidebar Source #
Memory-managed wrapper type.
Constructors
| StackSidebar (ManagedPtr StackSidebar) |
Instances
| GObject StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar Methods gobjectType :: StackSidebar -> IO GType # | |
| IsImplementorIface StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| IsObject StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| IsBuildable StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| IsBin StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| IsContainer StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| IsWidget StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| IsStackSidebar StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
class GObject o => IsStackSidebar o Source #
Type class for types which can be safely cast to StackSidebar, for instance with toStackSidebar.
Instances
| (GObject a, (UnknownAncestorError StackSidebar a :: Constraint)) => IsStackSidebar a Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| IsStackSidebar StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
toStackSidebar :: (MonadIO m, IsStackSidebar o) => o -> m StackSidebar Source #
Cast to StackSidebar, for types for which this is known to be safe. For general casts, use castTo.
noStackSidebar :: Maybe StackSidebar Source #
A convenience alias for Nothing :: Maybe StackSidebar.
Methods
getStack
Arguments
| :: (HasCallStack, MonadIO m, IsStackSidebar a) | |
| => a |
|
| -> m (Maybe Stack) | Returns: the associated |
Retrieves the stack.
See stackSidebarSetStack.
Since: 3.16
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m StackSidebar | Returns: the new |
Creates a new sidebar.
Since: 3.16
setStack
Arguments
| :: (HasCallStack, MonadIO m, IsStackSidebar a, IsStack b) | |
| => a |
|
| -> b |
|
| -> 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) Source #
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) Source #
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 () Source #
Set the value of the “stack” property.
When overloading is enabled, this is equivalent to
setstackSidebar [ #stack:=value ]