| 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.Handy.Objects.HeaderBar
Contents
- Exported types
- Methods
- getCenteringPolicy
- getCustomTitle
- getDecorationLayout
- getHasSubtitle
- getInterpolateSize
- getShowCloseButton
- getSubtitle
- getTitle
- getTransitionDuration
- getTransitionRunning
- new
- packEnd
- packStart
- setCenteringPolicy
- setCustomTitle
- setDecorationLayout
- setHasSubtitle
- setInterpolateSize
- setShowCloseButton
- setSubtitle
- setTitle
- setTransitionDuration
- Properties
Description
A title bar widget.
HdyHeaderBar is similar to HeaderBar but is designed to fix
some of its shortcomings for adaptive applications.
HdyHeaderBar doesn't force the custom title widget to be vertically
centered, hence allowing it to fill up the whole height, which is e.g. needed
for [classviewSwitcher].
When used in a mobile dialog, HdyHeaderBar will replace its window
decorations by a back button allowing to close it. It doesn't have to be its
direct child and you can use any complex contraption you like as the dialog's
titlebar.
HdyHeaderBar can be used in window's content area rather than titlebar, and
will still be draggable and will handle right click, middle click and double
click as expected from a titlebar. This is particularly useful with
[classwindow] or [classapplicationWindow].
CSS nodes
HdyHeaderBar has a single CSS node with name headerbar.
Since: 1.0
Synopsis
- newtype HeaderBar = HeaderBar (ManagedPtr HeaderBar)
- class (GObject o, IsDescendantOf HeaderBar o) => IsHeaderBar o
- toHeaderBar :: (MonadIO m, IsHeaderBar o) => o -> m HeaderBar
- headerBarGetCenteringPolicy :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m CenteringPolicy
- headerBarGetCustomTitle :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m (Maybe Widget)
- headerBarGetDecorationLayout :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m Text
- headerBarGetHasSubtitle :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m Bool
- headerBarGetInterpolateSize :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m Bool
- headerBarGetShowCloseButton :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m Bool
- headerBarGetSubtitle :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m (Maybe Text)
- headerBarGetTitle :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m (Maybe Text)
- headerBarGetTransitionDuration :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m Word32
- headerBarGetTransitionRunning :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> m Bool
- headerBarNew :: (HasCallStack, MonadIO m) => m HeaderBar
- headerBarPackEnd :: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b) => a -> b -> m ()
- headerBarPackStart :: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b) => a -> b -> m ()
- headerBarSetCenteringPolicy :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> CenteringPolicy -> m ()
- headerBarSetCustomTitle :: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b) => a -> Maybe b -> m ()
- headerBarSetDecorationLayout :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> Maybe Text -> m ()
- headerBarSetHasSubtitle :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> Bool -> m ()
- headerBarSetInterpolateSize :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> Bool -> m ()
- headerBarSetShowCloseButton :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> Bool -> m ()
- headerBarSetSubtitle :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> Maybe Text -> m ()
- headerBarSetTitle :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> Maybe Text -> m ()
- headerBarSetTransitionDuration :: (HasCallStack, MonadIO m, IsHeaderBar a) => a -> Word32 -> m ()
- constructHeaderBarCenteringPolicy :: (IsHeaderBar o, MonadIO m) => CenteringPolicy -> m (GValueConstruct o)
- getHeaderBarCenteringPolicy :: (MonadIO m, IsHeaderBar o) => o -> m CenteringPolicy
- setHeaderBarCenteringPolicy :: (MonadIO m, IsHeaderBar o) => o -> CenteringPolicy -> m ()
- clearHeaderBarCustomTitle :: (MonadIO m, IsHeaderBar o) => o -> m ()
- constructHeaderBarCustomTitle :: (IsHeaderBar o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getHeaderBarCustomTitle :: (MonadIO m, IsHeaderBar o) => o -> m (Maybe Widget)
- setHeaderBarCustomTitle :: (MonadIO m, IsHeaderBar o, IsWidget a) => o -> a -> m ()
- clearHeaderBarDecorationLayout :: (MonadIO m, IsHeaderBar o) => o -> m ()
- constructHeaderBarDecorationLayout :: (IsHeaderBar o, MonadIO m) => Text -> m (GValueConstruct o)
- getHeaderBarDecorationLayout :: (MonadIO m, IsHeaderBar o) => o -> m Text
- setHeaderBarDecorationLayout :: (MonadIO m, IsHeaderBar o) => o -> Text -> m ()
- constructHeaderBarDecorationLayoutSet :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getHeaderBarDecorationLayoutSet :: (MonadIO m, IsHeaderBar o) => o -> m Bool
- setHeaderBarDecorationLayoutSet :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m ()
- constructHeaderBarHasSubtitle :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getHeaderBarHasSubtitle :: (MonadIO m, IsHeaderBar o) => o -> m Bool
- setHeaderBarHasSubtitle :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m ()
- constructHeaderBarInterpolateSize :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getHeaderBarInterpolateSize :: (MonadIO m, IsHeaderBar o) => o -> m Bool
- setHeaderBarInterpolateSize :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m ()
- constructHeaderBarShowCloseButton :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getHeaderBarShowCloseButton :: (MonadIO m, IsHeaderBar o) => o -> m Bool
- setHeaderBarShowCloseButton :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m ()
- constructHeaderBarSpacing :: (IsHeaderBar o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getHeaderBarSpacing :: (MonadIO m, IsHeaderBar o) => o -> m Int32
- setHeaderBarSpacing :: (MonadIO m, IsHeaderBar o) => o -> Int32 -> m ()
- clearHeaderBarSubtitle :: (MonadIO m, IsHeaderBar o) => o -> m ()
- constructHeaderBarSubtitle :: (IsHeaderBar o, MonadIO m) => Text -> m (GValueConstruct o)
- getHeaderBarSubtitle :: (MonadIO m, IsHeaderBar o) => o -> m (Maybe Text)
- setHeaderBarSubtitle :: (MonadIO m, IsHeaderBar o) => o -> Text -> m ()
- clearHeaderBarTitle :: (MonadIO m, IsHeaderBar o) => o -> m ()
- constructHeaderBarTitle :: (IsHeaderBar o, MonadIO m) => Text -> m (GValueConstruct o)
- getHeaderBarTitle :: (MonadIO m, IsHeaderBar o) => o -> m (Maybe Text)
- setHeaderBarTitle :: (MonadIO m, IsHeaderBar o) => o -> Text -> m ()
- constructHeaderBarTransitionDuration :: (IsHeaderBar o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getHeaderBarTransitionDuration :: (MonadIO m, IsHeaderBar o) => o -> m Word32
- setHeaderBarTransitionDuration :: (MonadIO m, IsHeaderBar o) => o -> Word32 -> m ()
- getHeaderBarTransitionRunning :: (MonadIO m, IsHeaderBar o) => o -> m Bool
Exported types
Memory-managed wrapper type.
Instances
| Eq HeaderBar Source # | |
| GObject HeaderBar Source # | |
Defined in GI.Handy.Objects.HeaderBar | |
| ManagedPtrNewtype HeaderBar Source # | |
Defined in GI.Handy.Objects.HeaderBar Methods toManagedPtr :: HeaderBar -> ManagedPtr HeaderBar | |
| TypedObject HeaderBar Source # | |
Defined in GI.Handy.Objects.HeaderBar | |
| HasParentTypes HeaderBar Source # | |
Defined in GI.Handy.Objects.HeaderBar | |
| IsGValue (Maybe HeaderBar) Source # | Convert |
Defined in GI.Handy.Objects.HeaderBar Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe HeaderBar -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe HeaderBar) | |
| type ParentTypes HeaderBar Source # | |
Defined in GI.Handy.Objects.HeaderBar type ParentTypes HeaderBar = '[Container, Widget, Object, ImplementorIface, Buildable] | |
class (GObject o, IsDescendantOf HeaderBar o) => IsHeaderBar o Source #
Type class for types which can be safely cast to HeaderBar, for instance with toHeaderBar.
Instances
| (GObject o, IsDescendantOf HeaderBar o) => IsHeaderBar o Source # | |
Defined in GI.Handy.Objects.HeaderBar | |
toHeaderBar :: (MonadIO m, IsHeaderBar o) => o -> m HeaderBar Source #
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, 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, getCenteringPolicy, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getCustomTitle, getData, getDecorationLayout, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasSubtitle, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getInterpolateSize, 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, getShowCloseButton, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSubtitle, getSupportMultidevice, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getTransitionDuration, getTransitionRunning, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.
Setters
setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setCenteringPolicy, setChildVisible, setClip, setCompositeName, setCustomTitle, setData, setDataFull, setDecorationLayout, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasSubtitle, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setInterpolateSize, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setShowCloseButton, setSizeRequest, setState, setStateFlags, setStyle, setSubtitle, setSupportMultidevice, setTitle, setTooltipMarkup, setTooltipText, setTooltipWindow, setTransitionDuration, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.
getCenteringPolicy
headerBarGetCenteringPolicy Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m CenteringPolicy | Returns: the centering policy |
Gets the policy self follows to horizontally align its center widget.
Since: 1.0
getCustomTitle
headerBarGetCustomTitle Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m (Maybe Widget) | Returns: the custom title widget of the header |
Retrieves the custom title widget of the header.
Since: 1.0
getDecorationLayout
headerBarGetDecorationLayout Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m Text | Returns: the decoration layout |
Gets the decoration layout.
Since: 1.0
getHasSubtitle
headerBarGetHasSubtitle Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m Bool | Returns: |
Gets whether space is reserved for a subtitle, regardless if one is currently set or not.
Since: 1.0
getInterpolateSize
headerBarGetInterpolateSize Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m Bool | Returns: whether |
Gets whether self should interpolate its size on visible child change.
Since: 1.0
getShowCloseButton
headerBarGetShowCloseButton Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m Bool | Returns: whether decorations are shown |
Gets whether this header bar shows the standard window decorations.
Since: 1.0
getSubtitle
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m (Maybe Text) | Returns: the subtitle of the header |
Gets the subtitle of the header.
Since: 1.0
getTitle
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m (Maybe Text) | Returns: the title of the header. |
Retrieves the title of the header.
Since: 1.0
getTransitionDuration
headerBarGetTransitionDuration Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m Word32 | Returns: the transition duration, in milliseconds |
Gets the amount of time that transitions between pages will take.
Since: 1.0
getTransitionRunning
headerBarGetTransitionRunning Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> m Bool | Returns: whether the transition is currently running |
Gets whether the self is currently in a transition from one page to another.
Since: 1.0
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m HeaderBar | Returns: the newly created |
Creates a new HdyHeaderBar.
Since: 1.0
packEnd
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b) | |
| => a |
|
| -> b |
|
| -> m () |
Adds child to self, packed with reference to the end of the self.
Since: 1.0
packStart
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b) | |
| => a |
|
| -> b |
|
| -> m () |
Adds child to self, packed with reference to the start of the self.
Since: 1.0
setCenteringPolicy
headerBarSetCenteringPolicy Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> CenteringPolicy |
|
| -> m () |
Sets the policy self must follow to horizontally align its center widget.
Since: 1.0
setCustomTitle
headerBarSetCustomTitle Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b) | |
| => a |
|
| -> Maybe b |
|
| -> m () |
Sets a custom title for the header bar.
The title should help a user identify the current view. This supersedes any
title set by [methodheaderBar.set_title] or [methodheaderBar.set_subtitle].
To achieve the same style as the builtin title and subtitle, use the .title
and .subtitle style classes.
You should set the custom title to NULL, for the header title label to be
visible again.
Since: 1.0
setDecorationLayout
headerBarSetDecorationLayout Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets the decoration layout for this header bar.
Since: 1.0
setHasSubtitle
headerBarSetHasSubtitle Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether space is reserved for a subtitle, even if none is currently set.
Since: 1.0
setInterpolateSize
headerBarSetInterpolateSize Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether self should interpolate its size on visible child change.
Since: 1.0
setShowCloseButton
headerBarSetShowCloseButton Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether this header bar shows the standard window decorations.
Since: 1.0
setSubtitle
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets the subtitle of the header bar.
The title should give a user an additional detail to help them identify the current view.
Note that [classheaderBar] by default reserves room for the subtitle, even
if none is currently set. If this is not desired, set the
[propertyheaderBar:has-subtitle] property to FALSE.
Since: 1.0
setTitle
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets the title of the [classheaderBar].
The title should help a user identify the current view. A good title should not include the application name.
Since: 1.0
setTransitionDuration
headerBarSetTransitionDuration Source #
Arguments
| :: (HasCallStack, MonadIO m, IsHeaderBar a) | |
| => a |
|
| -> Word32 |
|
| -> m () |
Sets the duration that transitions between pages will take.
Since: 1.0
Properties
centeringPolicy
The policy for aligning the center widget.
Since: 1.0
constructHeaderBarCenteringPolicy :: (IsHeaderBar o, MonadIO m) => CenteringPolicy -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “centering-policy” property. This is rarely needed directly, but it is used by new.
getHeaderBarCenteringPolicy :: (MonadIO m, IsHeaderBar o) => o -> m CenteringPolicy Source #
Get the value of the “centering-policy” property.
When overloading is enabled, this is equivalent to
get headerBar #centeringPolicy
setHeaderBarCenteringPolicy :: (MonadIO m, IsHeaderBar o) => o -> CenteringPolicy -> m () Source #
Set the value of the “centering-policy” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #centeringPolicy:=value ]
customTitle
Custom title widget to display.
Since: 1.0
clearHeaderBarCustomTitle :: (MonadIO m, IsHeaderBar o) => o -> m () Source #
Set the value of the “custom-title” property to Nothing.
When overloading is enabled, this is equivalent to
clear #customTitle
constructHeaderBarCustomTitle :: (IsHeaderBar o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “custom-title” property. This is rarely needed directly, but it is used by new.
getHeaderBarCustomTitle :: (MonadIO m, IsHeaderBar o) => o -> m (Maybe Widget) Source #
Get the value of the “custom-title” property.
When overloading is enabled, this is equivalent to
get headerBar #customTitle
setHeaderBarCustomTitle :: (MonadIO m, IsHeaderBar o, IsWidget a) => o -> a -> m () Source #
Set the value of the “custom-title” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #customTitle:=value ]
decorationLayout
The decoration layout for buttons.
If this property is not set, the Settings:gtkDecorationLayout setting is used.
There can be valid reasons for overriding the setting, such as a header bar design that does not allow for buttons to take room on the right, or only offers room for a single close button. Split header bars are another example for overriding the setting.
The format of the string is button names, separated by commas. A colon separates the buttons that should appear on the start from those on the end. Recognized button names are minimize, maximize, close, icon (the window icon) and menu (a menu button for the fallback app menu).
For example, “menu:minimize,maximize,close” specifies a menu on the left, and minimize, maximize and close buttons on the right.
Since: 1.0
clearHeaderBarDecorationLayout :: (MonadIO m, IsHeaderBar o) => o -> m () Source #
Set the value of the “decoration-layout” property to Nothing.
When overloading is enabled, this is equivalent to
clear #decorationLayout
constructHeaderBarDecorationLayout :: (IsHeaderBar o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “decoration-layout” property. This is rarely needed directly, but it is used by new.
getHeaderBarDecorationLayout :: (MonadIO m, IsHeaderBar o) => o -> m Text Source #
Get the value of the “decoration-layout” property.
When overloading is enabled, this is equivalent to
get headerBar #decorationLayout
setHeaderBarDecorationLayout :: (MonadIO m, IsHeaderBar o) => o -> Text -> m () Source #
Set the value of the “decoration-layout” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #decorationLayout:=value ]
decorationLayoutSet
Whether [propertyheaderBar:decoration-layout] is set.
Since: 1.0
constructHeaderBarDecorationLayoutSet :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “decoration-layout-set” property. This is rarely needed directly, but it is used by new.
getHeaderBarDecorationLayoutSet :: (MonadIO m, IsHeaderBar o) => o -> m Bool Source #
Get the value of the “decoration-layout-set” property.
When overloading is enabled, this is equivalent to
get headerBar #decorationLayoutSet
setHeaderBarDecorationLayoutSet :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m () Source #
Set the value of the “decoration-layout-set” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #decorationLayoutSet:=value ]
hasSubtitle
Whether to reserve space for a subtitle, even if none is currently set.
Since: 1.0
constructHeaderBarHasSubtitle :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “has-subtitle” property. This is rarely needed directly, but it is used by new.
getHeaderBarHasSubtitle :: (MonadIO m, IsHeaderBar o) => o -> m Bool Source #
Get the value of the “has-subtitle” property.
When overloading is enabled, this is equivalent to
get headerBar #hasSubtitle
setHeaderBarHasSubtitle :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m () Source #
Set the value of the “has-subtitle” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #hasSubtitle:=value ]
interpolateSize
Whether the size should smoothly change when changing between children.
If TRUE, the header bar will interpolate its size between the one of the
previous visible child and the one of the new visible child, according to
the set transition duration and the orientation, e.g. if the orientation is
horizontal, it will interpolate the its height.
Since: 1.0
constructHeaderBarInterpolateSize :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “interpolate-size” property. This is rarely needed directly, but it is used by new.
getHeaderBarInterpolateSize :: (MonadIO m, IsHeaderBar o) => o -> m Bool Source #
Get the value of the “interpolate-size” property.
When overloading is enabled, this is equivalent to
get headerBar #interpolateSize
setHeaderBarInterpolateSize :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m () Source #
Set the value of the “interpolate-size” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #interpolateSize:=value ]
showCloseButton
Whether to show window decorations.
Which buttons are actually shown and where is determined by the
[propertyheaderBar:decoration-layout] property, and by the state of the
window (e.g. a close button will not be shown if the window can't be
closed).
Since: 1.0
constructHeaderBarShowCloseButton :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “show-close-button” property. This is rarely needed directly, but it is used by new.
getHeaderBarShowCloseButton :: (MonadIO m, IsHeaderBar o) => o -> m Bool Source #
Get the value of the “show-close-button” property.
When overloading is enabled, this is equivalent to
get headerBar #showCloseButton
setHeaderBarShowCloseButton :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m () Source #
Set the value of the “show-close-button” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #showCloseButton:=value ]
spacing
The amount of space between children.
Since: 1.0
constructHeaderBarSpacing :: (IsHeaderBar o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “spacing” property. This is rarely needed directly, but it is used by new.
getHeaderBarSpacing :: (MonadIO m, IsHeaderBar o) => o -> m Int32 Source #
Get the value of the “spacing” property.
When overloading is enabled, this is equivalent to
get headerBar #spacing
setHeaderBarSpacing :: (MonadIO m, IsHeaderBar o) => o -> Int32 -> m () Source #
Set the value of the “spacing” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #spacing:=value ]
subtitle
The subtitle to display.
Since: 1.0
clearHeaderBarSubtitle :: (MonadIO m, IsHeaderBar o) => o -> m () Source #
Set the value of the “subtitle” property to Nothing.
When overloading is enabled, this is equivalent to
clear #subtitle
constructHeaderBarSubtitle :: (IsHeaderBar o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “subtitle” property. This is rarely needed directly, but it is used by new.
getHeaderBarSubtitle :: (MonadIO m, IsHeaderBar o) => o -> m (Maybe Text) Source #
Get the value of the “subtitle” property.
When overloading is enabled, this is equivalent to
get headerBar #subtitle
setHeaderBarSubtitle :: (MonadIO m, IsHeaderBar o) => o -> Text -> m () Source #
Set the value of the “subtitle” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #subtitle:=value ]
title
The title to display.
Since: 1.0
clearHeaderBarTitle :: (MonadIO m, IsHeaderBar o) => o -> m () Source #
Set the value of the “title” property to Nothing.
When overloading is enabled, this is equivalent to
clear #title
constructHeaderBarTitle :: (IsHeaderBar o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “title” property. This is rarely needed directly, but it is used by new.
getHeaderBarTitle :: (MonadIO m, IsHeaderBar o) => o -> m (Maybe Text) Source #
Get the value of the “title” property.
When overloading is enabled, this is equivalent to
get headerBar #title
setHeaderBarTitle :: (MonadIO m, IsHeaderBar o) => o -> Text -> m () Source #
Set the value of the “title” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #title:=value ]
transitionDuration
The transition duration, in milliseconds.
Since: 1.0
constructHeaderBarTransitionDuration :: (IsHeaderBar o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “transition-duration” property. This is rarely needed directly, but it is used by new.
getHeaderBarTransitionDuration :: (MonadIO m, IsHeaderBar o) => o -> m Word32 Source #
Get the value of the “transition-duration” property.
When overloading is enabled, this is equivalent to
get headerBar #transitionDuration
setHeaderBarTransitionDuration :: (MonadIO m, IsHeaderBar o) => o -> Word32 -> m () Source #
Set the value of the “transition-duration” property.
When overloading is enabled, this is equivalent to
setheaderBar [ #transitionDuration:=value ]
transitionRunning
Whether or not the transition is currently running.
Since: 1.0
getHeaderBarTransitionRunning :: (MonadIO m, IsHeaderBar o) => o -> m Bool Source #
Get the value of the “transition-running” property.
When overloading is enabled, this is equivalent to
get headerBar #transitionRunning