GI.Handy.Objects.ViewSwitcher

An adaptive view switcher, designed to switch between multiple views in a similar fashion than a StackSwitcher.

Depending on the available width, the view switcher can adapt from a wide mode showing the view's icon and title side by side, to a narrow mode showing the view's icon and title one on top of the other, in a more compact way. This can be controlled via the policy property.

To look good in a header bar, an ViewSwitcher requires to fill its full height. Contrary to HeaderBar, HeaderBar doesn't force a vertical alignment on its title widget, so we recommend it over HeaderBar.

Since: 0.0.10

Exported types

newtype ViewSwitcher

Memory-managed wrapper type.

Constructors

ViewSwitcher (ManagedPtr ViewSwitcher)

Instances

Eq ViewSwitcher

Defined in GI.Handy.Objects.ViewSwitcher

Methods

(==) :: ViewSwitcher -> ViewSwitcher -> Bool

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

GObject ViewSwitcher

Defined in GI.Handy.Objects.ViewSwitcher

ManagedPtrNewtype ViewSwitcher

Defined in GI.Handy.Objects.ViewSwitcher

Methods

toManagedPtr :: ViewSwitcher -> ManagedPtr ViewSwitcher

TypedObject ViewSwitcher

Defined in GI.Handy.Objects.ViewSwitcher

Methods

glibType :: IO GType

HasParentTypes ViewSwitcher

Defined in GI.Handy.Objects.ViewSwitcher

IsGValue (Maybe ViewSwitcher)

Convert ViewSwitcher to and from GValue. See toGValue and fromGValue.

Defined in GI.Handy.Objects.ViewSwitcher

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ViewSwitcher -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ViewSwitcher)

type ParentTypes ViewSwitcher

Defined in GI.Handy.Objects.ViewSwitcher

type ParentTypes ViewSwitcher = '[Box, Container, Widget, Object, ImplementorIface, Buildable, Orientable]

class (GObject o, IsDescendantOf ViewSwitcher o) => IsViewSwitcher o

Type class for types which can be safely cast to ViewSwitcher, for instance with toViewSwitcher.

Instances

(GObject o, IsDescendantOf ViewSwitcher o) => IsViewSwitcher o

Defined in GI.Handy.Objects.ViewSwitcher

toViewSwitcher :: (MonadIO m, IsViewSwitcher o) => o -> m ViewSwitcher

Cast to ViewSwitcher, 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

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, getIconSize, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNarrowEllipsize, getNoShowAll, getOpacity, getOrientation, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPolicy, 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, setIconSize, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNarrowEllipsize, setNoShowAll, setOpacity, setOrientation, setParent, setParentWindow, setPolicy, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setSizeRequest, setSpacing, setStack, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

getIconSize

viewSwitcherGetIconSize

Arguments

:: (HasCallStack, MonadIO m, IsViewSwitcher a)

=> a

self: a ViewSwitcher

-> m IconSize

Returns: the icon size of the images

Get the icon size of the images used in the ViewSwitcher.

See: viewSwitcherSetIconSize

Since: 0.0.10

getNarrowEllipsize

viewSwitcherGetNarrowEllipsize

Arguments

:: (HasCallStack, MonadIO m, IsViewSwitcher a)

=> a

self: a ViewSwitcher

-> m EllipsizeMode

Returns: EllipsizeMode

Get the ellipsizing position of the narrow mode label. See viewSwitcherSetNarrowEllipsize.

Since: 0.0.10

getPolicy

viewSwitcherGetPolicy

Arguments

:: (HasCallStack, MonadIO m, IsViewSwitcher a)

=> a

self: a ViewSwitcher

-> m ViewSwitcherPolicy

Returns: the policy of self

Gets the policy of self.

Since: 0.0.10

getStack

viewSwitcherGetStack

Arguments

:: (HasCallStack, MonadIO m, IsViewSwitcher a)

=> a

self: a ViewSwitcher

-> m (Maybe Stack)

Returns: the Stack, or Nothing if none has been set

Get the Stack being controlled by the ViewSwitcher.

See: viewSwitcherSetStack

Since: 0.0.10

new

viewSwitcherNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ViewSwitcher

Returns: a new ViewSwitcher

Creates a new ViewSwitcher widget.

Since: 0.0.10

setIconSize

viewSwitcherSetIconSize

Arguments

:: (HasCallStack, MonadIO m, IsViewSwitcher a)

=> a

self: a ViewSwitcher

-> IconSize

iconSize: the new icon size

-> m ()

Change the icon size hint for the icons in a ViewSwitcher.

Since: 0.0.10

setNarrowEllipsize

viewSwitcherSetNarrowEllipsize

Arguments

:: (HasCallStack, MonadIO m, IsViewSwitcher a)

=> a

self: a ViewSwitcher

-> EllipsizeMode

mode: a EllipsizeMode

-> m ()

Set the mode used to ellipsize the text in narrow mode if there is not enough space to render the entire string.

Since: 0.0.10

setPolicy

viewSwitcherSetPolicy

Arguments

:: (HasCallStack, MonadIO m, IsViewSwitcher a)

=> a

self: a ViewSwitcher

-> ViewSwitcherPolicy

policy: the new policy

-> m ()

Sets the policy of self.

Since: 0.0.10

setStack

viewSwitcherSetStack

Arguments

:: (HasCallStack, MonadIO m, IsViewSwitcher a, IsStack b)

=> a

self: a ViewSwitcher

-> Maybe b

stack: a Stack

-> m ()

Sets the Stack to control.

Since: 0.0.10

Properties

iconSize

Use the "icon-size" property to hint the icons to use, you almost certainly want to leave this as IconSizeButton.

Since: 0.0.10

constructViewSwitcherIconSize :: (IsViewSwitcher o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getViewSwitcherIconSize :: (MonadIO m, IsViewSwitcher o) => o -> m Int32

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

get viewSwitcher #iconSize

setViewSwitcherIconSize :: (MonadIO m, IsViewSwitcher o) => o -> Int32 -> m ()

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

set viewSwitcher [ #iconSize := value ]

narrowEllipsize

The preferred place to ellipsize the string, if the narrow mode label does not have enough room to display the entire string, specified as a EllipsizeMode.

Note that setting this property to a value other than EllipsizeModeNone has the side-effect that the label requests only enough space to display the ellipsis.

Since: 0.0.10

constructViewSwitcherNarrowEllipsize :: (IsViewSwitcher o, MonadIO m) => EllipsizeMode -> m (GValueConstruct o)

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

getViewSwitcherNarrowEllipsize :: (MonadIO m, IsViewSwitcher o) => o -> m EllipsizeMode

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

get viewSwitcher #narrowEllipsize

setViewSwitcherNarrowEllipsize :: (MonadIO m, IsViewSwitcher o) => o -> EllipsizeMode -> m ()

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

set viewSwitcher [ #narrowEllipsize := value ]

policy

The ViewSwitcherPolicy the view switcher should use to determine which mode to use.

Since: 0.0.10

constructViewSwitcherPolicy :: (IsViewSwitcher o, MonadIO m) => ViewSwitcherPolicy -> m (GValueConstruct o)

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

getViewSwitcherPolicy :: (MonadIO m, IsViewSwitcher o) => o -> m ViewSwitcherPolicy

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

get viewSwitcher #policy

setViewSwitcherPolicy :: (MonadIO m, IsViewSwitcher o) => o -> ViewSwitcherPolicy -> m ()

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

set viewSwitcher [ #policy := value ]

stack

The Stack the view switcher controls.

Since: 0.0.10

clearViewSwitcherStack :: (MonadIO m, IsViewSwitcher o) => o -> m ()

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

clear #stack

constructViewSwitcherStack :: (IsViewSwitcher o, MonadIO m, IsStack a) => a -> m (GValueConstruct o)

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

getViewSwitcherStack :: (MonadIO m, IsViewSwitcher o) => o -> m (Maybe Stack)

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

get viewSwitcher #stack

setViewSwitcherStack :: (MonadIO m, IsViewSwitcher o, IsStack a) => o -> a -> m ()

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

set viewSwitcher [ #stack := value ]