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.StackSwitcher

Contents

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

Description

The GtkStackSwitcher widget acts as a controller for a `Stack`; it shows a row of buttons to switch between the various pages of the associated stack widget.

All the content for the buttons comes from the child properties of the `Stack`; the button visibility in a `StackSwitcher` widget is controlled by the visibility of the child in the `Stack`.

It is possible to associate multiple `StackSwitcher` widgets with the same `Stack` widget.

The GtkStackSwitcher widget was added in 3.10.

# CSS nodes

GtkStackSwitcher has a single CSS node named stackswitcher and style class .stack-switcher.

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

Synopsis

- newtype StackSwitcher = StackSwitcher (ManagedPtr StackSwitcher)
- class (GObject o, IsDescendantOf StackSwitcher o) => IsStackSwitcher o
- toStackSwitcher :: (MonadIO m, IsStackSwitcher o) => o -> m StackSwitcher
- stackSwitcherGetStack :: (HasCallStack, MonadIO m, IsStackSwitcher a) => a -> m (Maybe Stack)
- stackSwitcherNew :: (HasCallStack, MonadIO m) => m StackSwitcher
- stackSwitcherSetStack :: (HasCallStack, MonadIO m, IsStackSwitcher a, IsStack b) => a -> Maybe b -> m ()
- constructStackSwitcherIconSize :: (IsStackSwitcher o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getStackSwitcherIconSize :: (MonadIO m, IsStackSwitcher o) => o -> m Int32
- setStackSwitcherIconSize :: (MonadIO m, IsStackSwitcher o) => o -> Int32 -> m ()
- clearStackSwitcherStack :: (MonadIO m, IsStackSwitcher o) => o -> m ()
- constructStackSwitcherStack :: (IsStackSwitcher o, MonadIO m, IsStack a) => a -> m (GValueConstruct o)
- getStackSwitcherStack :: (MonadIO m, IsStackSwitcher o) => o -> m (Maybe Stack)
- setStackSwitcherStack :: (MonadIO m, IsStackSwitcher o, IsStack a) => o -> a -> m ()

# Exported types

newtype StackSwitcher Source #

Memory-managed wrapper type.

Constructors

StackSwitcher (ManagedPtr StackSwitcher) |

#### Instances

Instances details

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

class (GObject o, IsDescendantOf StackSwitcher o) => IsStackSwitcher o Source #

Type class for types which can be safely cast to `StackSwitcher`, for instance with `toStackSwitcher`.

#### Instances

Instances details

(GObject o, IsDescendantOf StackSwitcher o) => IsStackSwitcher o Source # |
Instance details Defined in GI.Gtk.Objects.StackSwitcher

toStackSwitcher :: (MonadIO m, IsStackSwitcher o) => o -> m StackSwitcher Source #

Cast to `StackSwitcher`, 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, packEnd, packStart, parserFinished, path, propagateDraw, queryChildPacking, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reorderChild, 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, getBaselinePosition, getBorderWidth, getCanDefault, getCanFocus, getCenterWidget, 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, getHomogeneous, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOrientation, 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, getSpacing, getStack, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

#### Setters

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

## getStack

stackSwitcherGetStack Source #

Arguments

:: (HasCallStack, MonadIO m, IsStackSwitcher a) |
=> a | `switcher`: a `StackSwitcher`
-> m (Maybe Stack) | Returns: the stack, or `Nothing` if none has been set explicitly.

Retrieves the stack. See `stackSwitcherSetStack`.

Since: 3.10

## new

stackSwitcherNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m StackSwitcher | Returns: a new `StackSwitcher`.

Create a new `StackSwitcher`.

Since: 3.10

## setStack

stackSwitcherSetStack Source #

Arguments

:: (HasCallStack, MonadIO m, IsStackSwitcher a, IsStack b) |
=> a | `switcher`: a `StackSwitcher`
-> Maybe b | `stack`: a `Stack`
-> m () |

Sets the stack to control.

Since: 3.10

# Properties

## iconSize

Use the "icon-size" property to change the size of the image displayed when a `StackSwitcher` is displaying icons.

Since: 3.20

constructStackSwitcherIconSize :: (IsStackSwitcher o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getStackSwitcherIconSize :: (MonadIO m, IsStackSwitcher o) => o -> m Int32 Source #

Get the value of the “`icon-size`” property. When overloading is enabled, this is equivalent to

    get stackSwitcher #iconSize

setStackSwitcherIconSize :: (MonadIO m, IsStackSwitcher o) => o -> Int32 -> m () Source #

Set the value of the “`icon-size`” property. When overloading is enabled, this is equivalent to

    set stackSwitcher [ #iconSize := value ]

## stack

No description available in the introspection data.

clearStackSwitcherStack :: (MonadIO m, IsStackSwitcher o) => o -> m () Source #

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

    clear #stack

constructStackSwitcherStack :: (IsStackSwitcher 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`.

getStackSwitcherStack :: (MonadIO m, IsStackSwitcher o) => o -> m (Maybe Stack) Source #

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

    get stackSwitcher #stack

setStackSwitcherStack :: (MonadIO m, IsStackSwitcher o, IsStack a) => o -> a -> m () Source #

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

    set stackSwitcher [ #stack := value ]