GI.Adw.Objects.HeaderBar

A title bar widget.

<picture> <source srcset="header-bar-dark.png" media="(prefers-color-scheme: dark)"> <img src="header-bar.png" alt="header-bar"> </picture>

AdwHeaderBar is similar to HeaderBar, but provides additional features compared to it. Refer to GtkHeaderBar for details. It is typically used as a top bar within [classtoolbarView].

Dialog Integration

When placed inside an [classdialog], AdwHeaderBar will display the dialog title intead of window title. It will also adjust the decoration layout to ensure it always has a close button and nothing else. Set [propertyheaderBar:show-start-title-buttons] and [propertyheaderBar:show-end-title-buttons] to FALSE to remove it if it's unwanted.

Navigation View Integration

When placed inside an [classnavigationPage], AdwHeaderBar will display the page title instead of window title.

When used together with [classnavigationView] or [classnavigationSplitView], it will also display a back button that can be used to go back to the previous page. The button also has a context menu, allowing to pop multiple pages at once, potentially across multiple navigation views.

Set [propertyheaderBar:show-back-button] to FALSE to disable this behavior in rare scenarios where it's unwanted.

Split View Integration

When placed inside AdwNavigationSplitView or AdwOverlaySplitView, AdwHeaderBar will automatically hide the title buttons other than at the edges of the window.

Centering Policy

propertyheaderBar:centering-policy

allows to enforce strict centering of the title widget. This can be useful for entries inside [classclamp].

Title Buttons

Unlike GtkHeaderBar, AdwHeaderBar allows to toggle title button visibility for each side individually, using the [propertyheaderBar:show-start-title-buttons] and [propertyheaderBar:show-end-title-buttons] properties.

CSS nodes

headerbar
╰── windowhandle
    ╰── box
        ├── widget
        │   ╰── box.start
        │       ├── windowcontrols.start
        │       ├── widget
        │       │   ╰── [button.back]
        │       ╰── [other children]
        ├── widget
        │   ╰── [Title Widget]
        ╰── widget
            ╰── box.end
                ├── [other children]
                ╰── windowcontrols.end

AdwHeaderBar's CSS node is called headerbar. It contains a windowhandle subnode, which contains a box subnode, which contains three widget subnodes at the start, center and end of the header bar. The start and end subnotes contain a box subnode with the .start and .end style classes respectively, and the center node contains a node that represents the title.

Each of the boxes contains a windowcontrols subnode, see WindowControls for details, as well as other children.

When [propertyheaderBar:show-back-button] is TRUE, the start box also contains a node with the name widget that contains a node with the name button and .back style class.

Accessibility

AdwHeaderBar uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Exported types

newtype HeaderBar

Memory-managed wrapper type.

Constructors

HeaderBar (ManagedPtr HeaderBar)

Instances

Eq HeaderBar

Defined in GI.Adw.Objects.HeaderBar

Methods

(==) :: HeaderBar -> HeaderBar -> Bool

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

GObject HeaderBar

Defined in GI.Adw.Objects.HeaderBar

ManagedPtrNewtype HeaderBar

Defined in GI.Adw.Objects.HeaderBar

Methods

toManagedPtr :: HeaderBar -> ManagedPtr HeaderBar

TypedObject HeaderBar

Defined in GI.Adw.Objects.HeaderBar

Methods

glibType :: IO GType

HasParentTypes HeaderBar

Defined in GI.Adw.Objects.HeaderBar

IsGValue (Maybe HeaderBar)

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

Defined in GI.Adw.Objects.HeaderBar

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes HeaderBar

Defined in GI.Adw.Objects.HeaderBar

type ParentTypes HeaderBar = '[Widget, Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf HeaderBar o) => IsHeaderBar o

Type class for types which can be safely cast to HeaderBar, for instance with toHeaderBar.

Instances

(GObject o, IsDescendantOf HeaderBar o) => IsHeaderBar o

Defined in GI.Adw.Objects.HeaderBar

toHeaderBar :: (MonadIO m, IsHeaderBar o) => o -> m HeaderBar

Cast to HeaderBar, 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, addController, addCssClass, addMnemonicLabel, addTickCallback, 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, packEnd, packStart, 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, getBounds, getBuildableId, getCanFocus, getCanTarget, getCenteringPolicy, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDecorationLayout, getDirection, getDisplay, 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, getRoot, getScaleFactor, getSensitive, getSettings, getShowBackButton, getShowEndTitleButtons, getShowStartTitleButtons, getShowTitle, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTitleWidget, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setAccessibleParent, setCanFocus, setCanTarget, setCenteringPolicy, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDecorationLayout, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setShowBackButton, setShowEndTitleButtons, setShowStartTitleButtons, setShowTitle, setSizeRequest, setStateFlags, setTitleWidget, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

getCenteringPolicy

headerBarGetCenteringPolicy

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> m CenteringPolicy

Returns: the centering policy

Gets the policy for aligning the center widget.

getDecorationLayout

headerBarGetDecorationLayout

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> m (Maybe Text)

Returns: the decoration layout

Gets the decoration layout for self.

getShowBackButton

headerBarGetShowBackButton

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> m Bool

Returns: whether to show the back button

Gets whether self can show the back button.

Since: 1.4

getShowEndTitleButtons

headerBarGetShowEndTitleButtons

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> m Bool

Returns: TRUE if title buttons at the end are shown

Gets whether to show title buttons at the end of self.

getShowStartTitleButtons

headerBarGetShowStartTitleButtons

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> m Bool

Returns: TRUE if title buttons at the start are shown

Gets whether to show title buttons at the start of self.

getShowTitle

headerBarGetShowTitle

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> m Bool

Returns: whether the title widget should be shown.

Gets whether the title widget should be shown.

Since: 1.4

getTitleWidget

headerBarGetTitleWidget

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> m (Maybe Widget)

Returns: the title widget

Gets the title widget widget of self.

new

headerBarNew

Arguments

:: (HasCallStack, MonadIO m)

=> m HeaderBar

Returns: the newly created AdwHeaderBar.

Creates a new AdwHeaderBar.

packEnd

headerBarPackEnd

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b)

=> a

self: a header bar

-> b

child: the widget to be added to self

-> m ()

Adds child to self, packed with reference to the end of self.

packStart

headerBarPackStart

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b)

=> a

self: a header bar

-> b

child: the widget to be added to self

-> m ()

Adds child to self, packed with reference to the start of the self.

remove

headerBarRemove

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b)

=> a

self: a header bar

-> b

child: the child to remove

-> m ()

Removes a child from self.

The child must have been added with [methodheaderBar.pack_start], [methodheaderBar.pack_end] or [propertyheaderBar:title-widget].

setCenteringPolicy

headerBarSetCenteringPolicy

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> CenteringPolicy

centeringPolicy: the centering policy

-> m ()

Sets the policy for aligning the center widget.

setDecorationLayout

headerBarSetDecorationLayout

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> Maybe Text

layout: a decoration layout

-> m ()

Sets the decoration layout for self.

If this property is not set, the Settings:gtkDecorationLayout setting is used.

The format of the string is button names, separated by commas. A colon separates the buttons that should appear at the start from those at the end. Recognized button names are minimize, maximize, close and icon (the window icon).

For example, “icon:minimize,maximize,close” specifies an icon at the start, and minimize, maximize and close buttons at the end.

setShowBackButton

headerBarSetShowBackButton

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> Bool

showBackButton: whether to show the back button

-> m ()

Sets whether self can show the back button.

The back button will never be shown unless the header bar is placed inside an [classnavigationView]. Usually, there is no reason to set it to FALSE.

Since: 1.4

setShowEndTitleButtons

headerBarSetShowEndTitleButtons

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> Bool

setting: TRUE to show standard title buttons

-> m ()

Sets whether to show title buttons at the end of self.

See [propertyheaderBar:show-start-title-buttons] for the other side.

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

setShowStartTitleButtons

headerBarSetShowStartTitleButtons

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> Bool

setting: TRUE to show standard title buttons

-> m ()

Sets whether to show title buttons at the start of self.

See [propertyheaderBar:show-end-title-buttons] for the other side.

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

setShowTitle

headerBarSetShowTitle

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a)

=> a

self: a header bar

-> Bool

showTitle: whether the title widget is visible

-> m ()

Sets whether the title widget should be shown.

Since: 1.4

setTitleWidget

headerBarSetTitleWidget

Arguments

:: (HasCallStack, MonadIO m, IsHeaderBar a, IsWidget b)

=> a

self: a header bar

-> Maybe b

titleWidget: a widget to use for a title

-> m ()

Sets the title widget for self.

When set to NULL, the header bar will display the title of the window it is contained in.

To use a different title, use [classwindowTitle]:

xml code

<object class="AdwHeaderBar">
  <property name="title-widget">
    <object class="AdwWindowTitle">
      <property name="title" translatable="yes">Title</property>
    </object>
  </property>
</object>

Properties

centeringPolicy

The policy for aligning the center widget.

constructHeaderBarCenteringPolicy :: (IsHeaderBar o, MonadIO m) => CenteringPolicy -> m (GValueConstruct o)

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

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 ()

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

set headerBar [ #centeringPolicy := value ]

decorationLayout

The decoration layout for buttons.

If this property is not set, the Settings:gtkDecorationLayout setting is used.

The format of the string is button names, separated by commas. A colon separates the buttons that should appear at the start from those at the end. Recognized button names are minimize, maximize, close and icon (the window icon).

For example, “icon:minimize,maximize,close” specifies an icon at the start, and minimize, maximize and close buttons at the end.

clearHeaderBarDecorationLayout :: (MonadIO m, IsHeaderBar o) => o -> m ()

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)

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 (Maybe Text)

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 ()

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

set headerBar [ #decorationLayout := value ]

showBackButton

Whether the header bar can show the back button.

The back button will never be shown unless the header bar is placed inside an [classnavigationView]. Usually, there is no reason to set this to FALSE.

Since: 1.4

constructHeaderBarShowBackButton :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getHeaderBarShowBackButton :: (MonadIO m, IsHeaderBar o) => o -> m Bool

Get the value of the “show-back-button” property. When overloading is enabled, this is equivalent to

get headerBar #showBackButton

setHeaderBarShowBackButton :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m ()

Set the value of the “show-back-button” property. When overloading is enabled, this is equivalent to

set headerBar [ #showBackButton := value ]

showEndTitleButtons

Whether to show title buttons at the end of the header bar.

See [propertyheaderBar:show-start-title-buttons] for the other side.

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

constructHeaderBarShowEndTitleButtons :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getHeaderBarShowEndTitleButtons :: (MonadIO m, IsHeaderBar o) => o -> m Bool

Get the value of the “show-end-title-buttons” property. When overloading is enabled, this is equivalent to

get headerBar #showEndTitleButtons

setHeaderBarShowEndTitleButtons :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m ()

Set the value of the “show-end-title-buttons” property. When overloading is enabled, this is equivalent to

set headerBar [ #showEndTitleButtons := value ]

showStartTitleButtons

Whether to show title buttons at the start of the header bar.

See [propertyheaderBar:show-end-title-buttons] for the other side.

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

constructHeaderBarShowStartTitleButtons :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getHeaderBarShowStartTitleButtons :: (MonadIO m, IsHeaderBar o) => o -> m Bool

Get the value of the “show-start-title-buttons” property. When overloading is enabled, this is equivalent to

get headerBar #showStartTitleButtons

setHeaderBarShowStartTitleButtons :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m ()

Set the value of the “show-start-title-buttons” property. When overloading is enabled, this is equivalent to

set headerBar [ #showStartTitleButtons := value ]

showTitle

Whether the title widget should be shown.

Since: 1.4

constructHeaderBarShowTitle :: (IsHeaderBar o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getHeaderBarShowTitle :: (MonadIO m, IsHeaderBar o) => o -> m Bool

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

get headerBar #showTitle

setHeaderBarShowTitle :: (MonadIO m, IsHeaderBar o) => o -> Bool -> m ()

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

set headerBar [ #showTitle := value ]

titleWidget

The title widget to display.

When set to NULL, the header bar will display the title of the window it is contained in.

To use a different title, use [classwindowTitle]:

xml code

<object class="AdwHeaderBar">
  <property name="title-widget">
    <object class="AdwWindowTitle">
      <property name="title" translatable="yes">Title</property>
    </object>
  </property>
</object>

clearHeaderBarTitleWidget :: (MonadIO m, IsHeaderBar o) => o -> m ()

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

clear #titleWidget

constructHeaderBarTitleWidget :: (IsHeaderBar o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getHeaderBarTitleWidget :: (MonadIO m, IsHeaderBar o) => o -> m (Maybe Widget)

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

get headerBar #titleWidget

setHeaderBarTitleWidget :: (MonadIO m, IsHeaderBar o, IsWidget a) => o -> a -> m ()

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

set headerBar [ #titleWidget := value ]