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.Adw.Objects.ToolbarView
Contents
- Exported types
- Methods
- addBottomBar
- addTopBar
- getBottomBarHeight
- getBottomBarStyle
- getContent
- getExtendContentToBottomEdge
- getExtendContentToTopEdge
- getRevealBottomBars
- getRevealTopBars
- getTopBarHeight
- getTopBarStyle
- new
- remove
- setBottomBarStyle
- setContent
- setExtendContentToBottomEdge
- setExtendContentToTopEdge
- setRevealBottomBars
- setRevealTopBars
- setTopBarStyle
- Properties
Description
A widget containing a page, as well as top and/or bottom bars.
<picture> <source srcset="toolbar-view-dark.png" media="(prefers-color-scheme: dark)"> <img src="toolbar-view.png" alt="toolbar-view"> </picture>
AdwToolbarView
has a single content widget and one or multiple top and
bottom bars, shown at the top and bottom sides respectively.
Example of an AdwToolbarView
UI definition:
xml code
<object class="AdwToolbarView"> <child type="top"> <object class="AdwHeaderBar"/> </child> <property name="content"> <object class="AdwPreferencesPage"> <!-- ... --> </object> </property> </object>
The following kinds of top and bottom bars are supported:
- [class
headerBar
] - [class
tabBar
] - [class
viewSwitcherBar
] ActionBar
HeaderBar
PopoverMenuBar
SearchBar
- Any
Box
or a similar widget with the `.toolbar` style class
By default, top and bottom bars are flat and scrolling content has a subtle
undershoot shadow, same as when using the
`.undershoot-top` and
`.undershoot-bottom` style
classes. This works well in most cases, e.g. with [classstatusPage
] or
[classpreferencesPage
], where the background at the top and bottom parts of
the page is uniform. Additionally, windows with sidebars should always use
this style.
- property
toolbarView
:top-bar-style - and
- property
toolbarView
:bottom-bar-style - properties can be used add an opaque
background and a persistent shadow to top and bottom bars, this can be useful
for content such as utility panes,
where some elements are adjacent to the top/bottom bars, or [class
tabView
], where each page can have a different background.
<picture style="min-width: 33%; display: inline-block;"> <source srcset="toolbar-view-flat-1-dark.png" media="(prefers-color-scheme: dark)"> <img src="toolbar-view-flat-1.png" alt="toolbar-view-flat-1"> </picture> <picture style="min-width: 33%; display: inline-block;"> <source srcset="toolbar-view-flat-2-dark.png" media="(prefers-color-scheme: dark)"> <img src="toolbar-view-flat-2.png" alt="toolbar-view-flat-2"> </picture> <picture style="min-width: 33%; display: inline-block;"> <source srcset="toolbar-view-raised-dark.png" media="(prefers-color-scheme: dark)"> <img src="toolbar-view-raised.png" alt="toolbar-view-raised"> </picture>
AdwToolbarView
ensures the top and bottom bars have consistent backdrop
styles and vertical spacing. For comparison:
<picture style="min-width: 40%; display: inline-block;"> <source srcset="toolbar-view-spacing-dark.png" media="(prefers-color-scheme: dark)"> <img src="toolbar-view-spacing.png" alt="toolbar-view-spacing"> </picture> <picture style="min-width: 40%; display: inline-block;"> <source srcset="toolbar-view-spacing-box-dark.png" media="(prefers-color-scheme: dark)"> <img src="toolbar-view-spacing-box.png" alt="toolbar-view-spacing-box"> </picture>
Any top and bottom bars can also be dragged to move the window, equivalent
to putting them into a WindowHandle
.
Content is typically place between top and bottom bars, but can also extend
behind them. This is controlled with the
[propertytoolbarView
:extend-content-to-top-edge] and
[propertytoolbarView
:extend-content-to-bottom-edge] properties.
Top and bottom bars can be hidden and revealed with an animation using the
[propertytoolbarView
:reveal-top-bars] and
[propertytoolbarView
:reveal-bottom-bars] properties.
AdwToolbarView
as GtkBuildable
The AdwToolbarView
implementation of the Buildable
interface
supports adding a top bar by specifying “top” as the “type” attribute of a
<child>
element, or adding a bottom bar by specifying “bottom”.
Accessibility
AdwToolbarView
uses the GTK_ACCESSIBLE_ROLE_GROUP
role.
Since: 1.4
Synopsis
- newtype ToolbarView = ToolbarView (ManagedPtr ToolbarView)
- class (GObject o, IsDescendantOf ToolbarView o) => IsToolbarView o
- toToolbarView :: (MonadIO m, IsToolbarView o) => o -> m ToolbarView
- toolbarViewAddBottomBar :: (HasCallStack, MonadIO m, IsToolbarView a, IsWidget b) => a -> b -> m ()
- toolbarViewAddTopBar :: (HasCallStack, MonadIO m, IsToolbarView a, IsWidget b) => a -> b -> m ()
- toolbarViewGetBottomBarHeight :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> m Int32
- toolbarViewGetBottomBarStyle :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> m ToolbarStyle
- toolbarViewGetContent :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> m (Maybe Widget)
- toolbarViewGetExtendContentToBottomEdge :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> m Bool
- toolbarViewGetExtendContentToTopEdge :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> m Bool
- toolbarViewGetRevealBottomBars :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> m Bool
- toolbarViewGetRevealTopBars :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> m Bool
- toolbarViewGetTopBarHeight :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> m Int32
- toolbarViewGetTopBarStyle :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> m ToolbarStyle
- toolbarViewNew :: (HasCallStack, MonadIO m) => m ToolbarView
- toolbarViewRemove :: (HasCallStack, MonadIO m, IsToolbarView a, IsWidget b) => a -> b -> m ()
- toolbarViewSetBottomBarStyle :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> ToolbarStyle -> m ()
- toolbarViewSetContent :: (HasCallStack, MonadIO m, IsToolbarView a, IsWidget b) => a -> Maybe b -> m ()
- toolbarViewSetExtendContentToBottomEdge :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> Bool -> m ()
- toolbarViewSetExtendContentToTopEdge :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> Bool -> m ()
- toolbarViewSetRevealBottomBars :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> Bool -> m ()
- toolbarViewSetRevealTopBars :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> Bool -> m ()
- toolbarViewSetTopBarStyle :: (HasCallStack, MonadIO m, IsToolbarView a) => a -> ToolbarStyle -> m ()
- getToolbarViewBottomBarHeight :: (MonadIO m, IsToolbarView o) => o -> m Int32
- constructToolbarViewBottomBarStyle :: (IsToolbarView o, MonadIO m) => ToolbarStyle -> m (GValueConstruct o)
- getToolbarViewBottomBarStyle :: (MonadIO m, IsToolbarView o) => o -> m ToolbarStyle
- setToolbarViewBottomBarStyle :: (MonadIO m, IsToolbarView o) => o -> ToolbarStyle -> m ()
- clearToolbarViewContent :: (MonadIO m, IsToolbarView o) => o -> m ()
- constructToolbarViewContent :: (IsToolbarView o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getToolbarViewContent :: (MonadIO m, IsToolbarView o) => o -> m (Maybe Widget)
- setToolbarViewContent :: (MonadIO m, IsToolbarView o, IsWidget a) => o -> a -> m ()
- constructToolbarViewExtendContentToBottomEdge :: (IsToolbarView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getToolbarViewExtendContentToBottomEdge :: (MonadIO m, IsToolbarView o) => o -> m Bool
- setToolbarViewExtendContentToBottomEdge :: (MonadIO m, IsToolbarView o) => o -> Bool -> m ()
- constructToolbarViewExtendContentToTopEdge :: (IsToolbarView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getToolbarViewExtendContentToTopEdge :: (MonadIO m, IsToolbarView o) => o -> m Bool
- setToolbarViewExtendContentToTopEdge :: (MonadIO m, IsToolbarView o) => o -> Bool -> m ()
- constructToolbarViewRevealBottomBars :: (IsToolbarView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getToolbarViewRevealBottomBars :: (MonadIO m, IsToolbarView o) => o -> m Bool
- setToolbarViewRevealBottomBars :: (MonadIO m, IsToolbarView o) => o -> Bool -> m ()
- constructToolbarViewRevealTopBars :: (IsToolbarView o, MonadIO m) => Bool -> m (GValueConstruct o)
- getToolbarViewRevealTopBars :: (MonadIO m, IsToolbarView o) => o -> m Bool
- setToolbarViewRevealTopBars :: (MonadIO m, IsToolbarView o) => o -> Bool -> m ()
- getToolbarViewTopBarHeight :: (MonadIO m, IsToolbarView o) => o -> m Int32
- constructToolbarViewTopBarStyle :: (IsToolbarView o, MonadIO m) => ToolbarStyle -> m (GValueConstruct o)
- getToolbarViewTopBarStyle :: (MonadIO m, IsToolbarView o) => o -> m ToolbarStyle
- setToolbarViewTopBarStyle :: (MonadIO m, IsToolbarView o) => o -> ToolbarStyle -> m ()
Exported types
newtype ToolbarView Source #
Memory-managed wrapper type.
Constructors
ToolbarView (ManagedPtr ToolbarView) |
Instances
Eq ToolbarView Source # | |
Defined in GI.Adw.Objects.ToolbarView | |
GObject ToolbarView Source # | |
Defined in GI.Adw.Objects.ToolbarView | |
ManagedPtrNewtype ToolbarView Source # | |
Defined in GI.Adw.Objects.ToolbarView Methods toManagedPtr :: ToolbarView -> ManagedPtr ToolbarView | |
TypedObject ToolbarView Source # | |
Defined in GI.Adw.Objects.ToolbarView | |
HasParentTypes ToolbarView Source # | |
Defined in GI.Adw.Objects.ToolbarView | |
IsGValue (Maybe ToolbarView) Source # | Convert |
Defined in GI.Adw.Objects.ToolbarView Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe ToolbarView -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe ToolbarView) | |
type ParentTypes ToolbarView Source # | |
Defined in GI.Adw.Objects.ToolbarView type ParentTypes ToolbarView = '[Widget, Object, Accessible, Buildable, ConstraintTarget] |
class (GObject o, IsDescendantOf ToolbarView o) => IsToolbarView o Source #
Type class for types which can be safely cast to ToolbarView
, for instance with toToolbarView
.
Instances
(GObject o, IsDescendantOf ToolbarView o) => IsToolbarView o Source # | |
Defined in GI.Adw.Objects.ToolbarView |
toToolbarView :: (MonadIO m, IsToolbarView o) => o -> m ToolbarView Source #
Cast to ToolbarView
, 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, addBottomBar, addController, addCssClass, addMnemonicLabel, addTickCallback, addTopBar, allocate, announce, 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, remove, 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, getBaseline, getBottomBarHeight, getBottomBarStyle, getBounds, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getContent, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getExtendContentToBottomEdge, getExtendContentToTopEdge, 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, getRevealBottomBars, getRevealTopBars, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getTopBarHeight, getTopBarStyle, getValign, getVexpand, getVexpandSet, getVisible, getWidth.
Setters
setAccessibleParent, setBottomBarStyle, setCanFocus, setCanTarget, setChildVisible, setContent, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setExtendContentToBottomEdge, setExtendContentToTopEdge, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setRevealBottomBars, setRevealTopBars, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setTopBarStyle, setValign, setVexpand, setVexpandSet, setVisible.
addBottomBar
toolbarViewAddBottomBar Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Adds a bottom bar to self
.
Since: 1.4
addTopBar
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Adds a top bar to self
.
Since: 1.4
getBottomBarHeight
toolbarViewGetBottomBarHeight Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> m Int32 | Returns: the current bottom bar height |
Gets the current bottom bar height for self
.
Bottom bar height does change depending on
[propertytoolbarView
:reveal-bottom-bars], including during the transition.
See [methodtoolbarView
.get_top_bar_height].
Since: 1.4
getBottomBarStyle
toolbarViewGetBottomBarStyle Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> m ToolbarStyle | Returns: bottom bar style |
Gets appearance of the botom bars for self
.
Since: 1.4
getContent
toolbarViewGetContent Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the content widget |
Gets the content widget for self
.
Since: 1.4
getExtendContentToBottomEdge
toolbarViewGetExtendContentToBottomEdge Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> m Bool | Returns: whether content extends behind bottom bars |
Gets whether the content widget can extend behind bottom bars.
Since: 1.4
getExtendContentToTopEdge
toolbarViewGetExtendContentToTopEdge Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> m Bool | Returns: whether content extends behind top bars |
Gets whether the content widget can extend behind top bars.
Since: 1.4
getRevealBottomBars
toolbarViewGetRevealBottomBars Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> m Bool | Returns: whether bottom bars are revealed |
Gets whether bottom bars are revealed for self
.
Since: 1.4
getRevealTopBars
toolbarViewGetRevealTopBars Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> m Bool | Returns: whether top bars are revealed |
Gets whether top bars are revealed for self
.
Since: 1.4
getTopBarHeight
toolbarViewGetTopBarHeight Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> m Int32 | Returns: the current top bar height |
Gets the current top bar height for self
.
Top bar height does change depending on
[propertytoolbarView
:reveal-top-bars], including during the transition.
See [methodtoolbarView
.get_bottom_bar_height].
Since: 1.4
getTopBarStyle
toolbarViewGetTopBarStyle Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> m ToolbarStyle | Returns: top bar style |
Gets appearance of the top bars for self
.
Since: 1.4
new
Arguments
:: (HasCallStack, MonadIO m) | |
=> m ToolbarView | Returns: the newly created |
Creates a new AdwToolbarView
.
Since: 1.4
remove
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Removes a child from self
.
Since: 1.4
setBottomBarStyle
toolbarViewSetBottomBarStyle Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> ToolbarStyle |
|
-> m () |
Sets appearance of the bottom bars for self
.
If set to ADW_TOOLBAR_FLAT
, bottom bars are flat and scrolling content has
a subtle undershoot shadow when touching them, same as the
`.undershoot-bottom`
style class. This works well for simple content, e.g. [classstatusPage
] or
[classpreferencesPage
], where the background at the bottom of the page is
uniform. Additionally, windows with sidebars should always use this style.
Undershoot shadow is only present if a bottom bar is actually present and
visible. It is also never present if
[propertytoolbarView
:extend-content-to-bottom-edge] is set to TRUE
.
If set to ADW_TOOLBAR_RAISED
, bottom bars have an opaque background and a
persistent shadow, this is suitable for content such as
utility panes,
where some elements are directly adjacent to the bottom bars, or
[classtabView
], where each page can have a different background.
ADW_TOOLBAR_RAISED_BORDER
is similar to ADW_TOOLBAR_RAISED
, but the
shadow is replaced with a more subtle border. This can be useful for
applications like image viewers.
See also [methodtoolbarView
.set_top_bar_style].
Since: 1.4
setContent
toolbarViewSetContent Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the content widget for self
.
Since: 1.4
setExtendContentToBottomEdge
toolbarViewSetExtendContentToBottomEdge Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the content widget can extend behind bottom bars.
This can be used in combination with [propertytoolbarView
:reveal-bottom-bars]
to show and hide toolbars in fullscreen.
See [methodtoolbarView
.set_extend_content_to_top_edge].
Since: 1.4
setExtendContentToTopEdge
toolbarViewSetExtendContentToTopEdge Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the content widget can extend behind top bars.
This can be used in combination with [propertytoolbarView
:reveal-top-bars]
to show and hide toolbars in fullscreen.
See [methodtoolbarView
.set_extend_content_to_bottom_edge].
Since: 1.4
setRevealBottomBars
toolbarViewSetRevealBottomBars Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether bottom bars are revealed for self
.
The transition will be animated.
This can be used in combination with
[propertytoolbarView
:extend-content-to-bottom-edge] to show and hide
toolbars in fullscreen.
See [methodtoolbarView
.set_reveal_top_bars].
Since: 1.4
setRevealTopBars
toolbarViewSetRevealTopBars Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether top bars are revealed for self
.
The transition will be animated.
This can be used in combination with
[propertytoolbarView
:extend-content-to-top-edge] to show and hide toolbars
in fullscreen.
See [methodtoolbarView
.set_reveal_bottom_bars].
Since: 1.4
setTopBarStyle
toolbarViewSetTopBarStyle Source #
Arguments
:: (HasCallStack, MonadIO m, IsToolbarView a) | |
=> a |
|
-> ToolbarStyle |
|
-> m () |
Sets appearance of the top bars for self
.
If set to ADW_TOOLBAR_FLAT
, top bars are flat and scrolling content has a
subtle undershoot shadow when touching them, same as the
`.undershoot-top`
style class. This works well for simple content, e.g. [classstatusPage
] or
[classpreferencesPage
], where the background at the top of the page is
uniform. Additionally, windows with sidebars should always use this style.
Undershoot shadow is only present if a top bar is actually present and
visible. It is also never present if
[propertytoolbarView
:extend-content-to-top-edge] is set to TRUE
.
If set to ADW_TOOLBAR_RAISED
, top bars have an opaque background and a
persistent shadow, this is suitable for content such as
utility panes,
where some elements are directly adjacent to the top bars, or
[classtabView
], where each page can have a different background.
ADW_TOOLBAR_RAISED_BORDER
is similar to ADW_TOOLBAR_RAISED
, but the
shadow is replaced with a more subtle border. This can be useful for
applications like image viewers.
See also [methodtoolbarView
.set_bottom_bar_style].
Since: 1.4
Properties
bottomBarHeight
The current bottom bar height.
Bottom bar height does change depending on
[propertytoolbarView
:reveal-bottom-bars], including during the transition.
See [propertytoolbarView
:top-bar-height].
Since: 1.4
getToolbarViewBottomBarHeight :: (MonadIO m, IsToolbarView o) => o -> m Int32 Source #
Get the value of the “bottom-bar-height
” property.
When overloading is enabled, this is equivalent to
get
toolbarView #bottomBarHeight
bottomBarStyle
Appearance of the bottom bars.
If set to ADW_TOOLBAR_FLAT
, bottom bars are flat and scrolling content
has a subtle undershoot shadow when touching them, same as the
`.undershoot-bottom`
style class. This works well for simple content, e.g. [classstatusPage
] or
[classpreferencesPage
], where the background at the bottom of the page is
uniform. Additionally, windows with sidebars should always use this style.
Undershoot shadow is only present if a bottom bar is actually present and
visible. It is also never present if
[propertytoolbarView
:extend-content-to-bottom-edge] is set to TRUE
.
If set to ADW_TOOLBAR_RAISED
, bottom bars have an opaque background and a
persistent shadow, this is suitable for content such as
utility panes,
where some elements are directly adjacent to the bottom bars, or
[classtabView
], where each page can have a different background.
ADW_TOOLBAR_RAISED_BORDER
is similar to ADW_TOOLBAR_RAISED
, but the
shadow is replaced with a more subtle border. This can be useful for
applications like image viewers.
See also [propertytoolbarView
:top-bar-style].
Since: 1.4
constructToolbarViewBottomBarStyle :: (IsToolbarView o, MonadIO m) => ToolbarStyle -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “bottom-bar-style
” property. This is rarely needed directly, but it is used by new
.
getToolbarViewBottomBarStyle :: (MonadIO m, IsToolbarView o) => o -> m ToolbarStyle Source #
Get the value of the “bottom-bar-style
” property.
When overloading is enabled, this is equivalent to
get
toolbarView #bottomBarStyle
setToolbarViewBottomBarStyle :: (MonadIO m, IsToolbarView o) => o -> ToolbarStyle -> m () Source #
Set the value of the “bottom-bar-style
” property.
When overloading is enabled, this is equivalent to
set
toolbarView [ #bottomBarStyle:=
value ]
content
The content widget.
Since: 1.4
clearToolbarViewContent :: (MonadIO m, IsToolbarView o) => o -> m () Source #
Set the value of the “content
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#content
constructToolbarViewContent :: (IsToolbarView o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “content
” property. This is rarely needed directly, but it is used by new
.
getToolbarViewContent :: (MonadIO m, IsToolbarView o) => o -> m (Maybe Widget) Source #
Get the value of the “content
” property.
When overloading is enabled, this is equivalent to
get
toolbarView #content
setToolbarViewContent :: (MonadIO m, IsToolbarView o, IsWidget a) => o -> a -> m () Source #
Set the value of the “content
” property.
When overloading is enabled, this is equivalent to
set
toolbarView [ #content:=
value ]
extendContentToBottomEdge
Whether the content widget can extend behind bottom bars.
This can be used in combination with
[propertytoolbarView
:reveal-bottom-bars] to show and hide toolbars in
fullscreen.
See [propertytoolbarView
:extend-content-to-top-edge].
Since: 1.4
constructToolbarViewExtendContentToBottomEdge :: (IsToolbarView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “extend-content-to-bottom-edge
” property. This is rarely needed directly, but it is used by new
.
getToolbarViewExtendContentToBottomEdge :: (MonadIO m, IsToolbarView o) => o -> m Bool Source #
Get the value of the “extend-content-to-bottom-edge
” property.
When overloading is enabled, this is equivalent to
get
toolbarView #extendContentToBottomEdge
setToolbarViewExtendContentToBottomEdge :: (MonadIO m, IsToolbarView o) => o -> Bool -> m () Source #
Set the value of the “extend-content-to-bottom-edge
” property.
When overloading is enabled, this is equivalent to
set
toolbarView [ #extendContentToBottomEdge:=
value ]
extendContentToTopEdge
Whether the content widget can extend behind top bars.
This can be used in combination with [propertytoolbarView
:reveal-top-bars]
to show and hide toolbars in fullscreen.
See [propertytoolbarView
:extend-content-to-bottom-edge].
Since: 1.4
constructToolbarViewExtendContentToTopEdge :: (IsToolbarView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “extend-content-to-top-edge
” property. This is rarely needed directly, but it is used by new
.
getToolbarViewExtendContentToTopEdge :: (MonadIO m, IsToolbarView o) => o -> m Bool Source #
Get the value of the “extend-content-to-top-edge
” property.
When overloading is enabled, this is equivalent to
get
toolbarView #extendContentToTopEdge
setToolbarViewExtendContentToTopEdge :: (MonadIO m, IsToolbarView o) => o -> Bool -> m () Source #
Set the value of the “extend-content-to-top-edge
” property.
When overloading is enabled, this is equivalent to
set
toolbarView [ #extendContentToTopEdge:=
value ]
revealBottomBars
Whether bottom bars are visible.
The transition will be animated.
This can be used in combination with
[propertytoolbarView
:extend-content-to-bottom-edge] to show and hide
toolbars in fullscreen.
See [propertytoolbarView
:reveal-top-bars].
Since: 1.4
constructToolbarViewRevealBottomBars :: (IsToolbarView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “reveal-bottom-bars
” property. This is rarely needed directly, but it is used by new
.
getToolbarViewRevealBottomBars :: (MonadIO m, IsToolbarView o) => o -> m Bool Source #
Get the value of the “reveal-bottom-bars
” property.
When overloading is enabled, this is equivalent to
get
toolbarView #revealBottomBars
setToolbarViewRevealBottomBars :: (MonadIO m, IsToolbarView o) => o -> Bool -> m () Source #
Set the value of the “reveal-bottom-bars
” property.
When overloading is enabled, this is equivalent to
set
toolbarView [ #revealBottomBars:=
value ]
revealTopBars
Whether top bars are revealed.
The transition will be animated.
This can be used in combination with
[propertytoolbarView
:extend-content-to-top-edge] to show and hide toolbars
in fullscreen.
See [propertytoolbarView
:reveal-bottom-bars].
Since: 1.4
constructToolbarViewRevealTopBars :: (IsToolbarView o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “reveal-top-bars
” property. This is rarely needed directly, but it is used by new
.
getToolbarViewRevealTopBars :: (MonadIO m, IsToolbarView o) => o -> m Bool Source #
Get the value of the “reveal-top-bars
” property.
When overloading is enabled, this is equivalent to
get
toolbarView #revealTopBars
setToolbarViewRevealTopBars :: (MonadIO m, IsToolbarView o) => o -> Bool -> m () Source #
Set the value of the “reveal-top-bars
” property.
When overloading is enabled, this is equivalent to
set
toolbarView [ #revealTopBars:=
value ]
topBarHeight
The current top bar height.
Top bar height does change depending [propertytoolbarView
:reveal-top-bars],
including during the transition.
See [propertytoolbarView
:bottom-bar-height].
Since: 1.4
getToolbarViewTopBarHeight :: (MonadIO m, IsToolbarView o) => o -> m Int32 Source #
Get the value of the “top-bar-height
” property.
When overloading is enabled, this is equivalent to
get
toolbarView #topBarHeight
topBarStyle
Appearance of the top bars.
If set to ADW_TOOLBAR_FLAT
, top bars are flat and scrolling content has a
subtle undershoot shadow when touching them, same as the
`.undershoot-top`
style class. This works well for simple content, e.g. [classstatusPage
] or
[classpreferencesPage
], where the background at the top of the page is
uniform. Additionally, windows with sidebars should always use this style.
Undershoot shadow is only present if a top bar is actually present and
visible. It is also never present if
[propertytoolbarView
:extend-content-to-top-edge] is set to TRUE
.
If set to ADW_TOOLBAR_RAISED
, top bars have an opaque background and a
persistent shadow, this is suitable for content such as
utility panes,
where some elements are directly adjacent to the top bars, or
[classtabView
], where each page can have a different background.
ADW_TOOLBAR_RAISED_BORDER
is similar to ADW_TOOLBAR_RAISED
, but the
shadow is replaced with a more subtle border. This can be useful for
applications like image viewers.
See also [propertytoolbarView
:bottom-bar-style].
Since: 1.4
constructToolbarViewTopBarStyle :: (IsToolbarView o, MonadIO m) => ToolbarStyle -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “top-bar-style
” property. This is rarely needed directly, but it is used by new
.
getToolbarViewTopBarStyle :: (MonadIO m, IsToolbarView o) => o -> m ToolbarStyle Source #
Get the value of the “top-bar-style
” property.
When overloading is enabled, this is equivalent to
get
toolbarView #topBarStyle
setToolbarViewTopBarStyle :: (MonadIO m, IsToolbarView o) => o -> ToolbarStyle -> m () Source #
Set the value of the “top-bar-style
” property.
When overloading is enabled, this is equivalent to
set
toolbarView [ #topBarStyle:=
value ]