| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.StackSidebar
Description
A GtkStackSidebar uses a sidebar to switch between GtkStack pages.
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 GtkStackSidebar
to the GtkStack.
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, IsDescendantOf StackSidebar o) => IsStackSidebar o
- toStackSidebar :: (MonadIO m, IsStackSidebar o) => o -> m 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, MonadIO m, IsStack a) => a -> m (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
| Eq StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| GObject StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| ManagedPtrNewtype StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar Methods toManagedPtr :: StackSidebar -> ManagedPtr StackSidebar | |
| TypedObject StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| HasParentTypes StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
| IsGValue (Maybe StackSidebar) Source # | Convert |
Defined in GI.Gtk.Objects.StackSidebar Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe StackSidebar -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe StackSidebar) | |
| type ParentTypes StackSidebar Source # | |
Defined in GI.Gtk.Objects.StackSidebar | |
class (GObject o, IsDescendantOf StackSidebar o) => IsStackSidebar o Source #
Type class for types which can be safely cast to StackSidebar, for instance with toStackSidebar.
Instances
| (GObject o, IsDescendantOf StackSidebar o) => IsStackSidebar o 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.
Methods
Click to display all available methods, including inherited ones
Methods
actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, 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, getBounds, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStack, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.
Setters
setAccessibleParent, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStack, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.
getStack
Arguments
| :: (HasCallStack, MonadIO m, IsStackSidebar a) | |
| => a |
|
| -> m (Maybe Stack) | Returns: the associated |
Retrieves the stack.
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m StackSidebar | Returns: the new |
Creates a new GtkStackSidebar.
setStack
Arguments
| :: (HasCallStack, MonadIO m, IsStackSidebar a, IsStack b) | |
| => a |
|
| -> b |
|
| -> m () |
Set the GtkStack associated with this GtkStackSidebar.
The sidebar widget will automatically update according to
the order and items within the given GtkStack.
Properties
stack
The stack.
constructStackSidebarStack :: (IsStackSidebar o, MonadIO m, IsStack a) => a -> m (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 ]