gi-gtk-3.0.43: Gtk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.StackSidebar

Contents

- Exported types
- Methods
  - getStack
  - new
  - setStack
- Properties
  - stack

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.

Since: 3.16

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

Instances details

Eq StackSidebar Source # |
Instance details Defined in GI.Gtk.Objects.StackSidebar Methods (==) :: StackSidebar -> StackSidebar -> Bool Source # (/=) :: StackSidebar -> StackSidebar -> Bool Source #
GObject StackSidebar Source # |
Instance details Defined in GI.Gtk.Objects.StackSidebar
ManagedPtrNewtype StackSidebar Source # |
Instance details Defined in GI.Gtk.Objects.StackSidebar Methods toManagedPtr :: StackSidebar -> ManagedPtr StackSidebar Source #
TypedObject StackSidebar Source # |
Instance details Defined in GI.Gtk.Objects.StackSidebar Methods glibType :: IO GType Source #
HasParentTypes StackSidebar Source # |
Instance details Defined in GI.Gtk.Objects.StackSidebar
IsGValue (Maybe StackSidebar) Source # | Convert `StackSidebar` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.StackSidebar Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe StackSidebar -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe StackSidebar) Source #
type ParentTypes StackSidebar Source # |
Instance details Defined in GI.Gtk.Objects.StackSidebar type ParentTypes StackSidebar = '[Bin, Container, Widget, Object, ImplementorIface, Buildable]

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

Instances details

(GObject o, IsDescendantOf StackSidebar o) => IsStackSidebar o Source # |
Instance details 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

Expand

#### Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

#### Getters

getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getStack, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

#### Setters

setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setSizeRequest, setStack, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

## getStack

stackSidebarGetStack Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m StackSidebar | Returns: the new `StackSidebar`

Creates a new sidebar.

Since: 3.16

## setStack

stackSidebarSetStack Source #

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, 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

    set stackSidebar [ #stack := value ]