Class
AdwHeaderBar
Description [src]
final class Adw.HeaderBar : Gtk.Widget {
/* No available fields */
}
A title bar widget.
AdwHeaderBar is similar to GtkHeaderBar, but provides additional
features compared to it. Refer to GtkHeaderBar for details. It is typically
used as a top bar within AdwToolbarView.
Navigation View Integration
When placed inside an AdwNavigationPage, AdwHeaderBar will display the
page title instead of window title.
When used together with AdwNavigationView or AdwNavigationSplitView,
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. In rare scenarios, set
AdwHeaderBar:show-back-button to FALSE to disable the back button
if it’s unwanted (e.g. in an extra header bar on the same page).
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
AdwHeaderBar:centering-policy allows to enforce strict centering of
the title widget. This can be useful for entries inside AdwClamp.
Title Buttons
Unlike GtkHeaderBar, AdwHeaderBar allows to toggle title button
visibility for each side individually, using the
AdwHeaderBar:show-start-title-buttons and
AdwHeaderBar: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
GtkWindowControls for details, as well as other children.
When AdwHeaderBar: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.
Constructors
adw_header_bar_new
Creates a new AdwHeaderBar.
Instance methods
adw_header_bar_get_centering_policy
Gets the policy for aligning the center widget.
adw_header_bar_get_decoration_layout
Gets the decoration layout for self.
adw_header_bar_get_show_back_button
Gets whether self can show the back button.
Available since: 1.4
adw_header_bar_get_show_end_title_buttons
Gets whether to show title buttons at the end of self.
adw_header_bar_get_show_start_title_buttons
Gets whether to show title buttons at the start of self.
adw_header_bar_get_title_widget
Gets the title widget widget of self.
adw_header_bar_pack_end
Adds child to self, packed with reference to the end of self.
adw_header_bar_pack_start
Adds child to self, packed with reference to the start of the self.
adw_header_bar_remove
Removes a child from self.
adw_header_bar_set_centering_policy
Sets the policy for aligning the center widget.
adw_header_bar_set_decoration_layout
Sets the decoration layout for self.
adw_header_bar_set_show_back_button
Sets whether self can show the back button.
Available since: 1.4
adw_header_bar_set_show_end_title_buttons
Sets whether to show title buttons at the end of self.
adw_header_bar_set_show_start_title_buttons
Sets whether to show title buttons at the start of self.
adw_header_bar_set_title_widget
Sets the title widget for self.
Properties
Adw.HeaderBar:centering-policy
The policy for aligning the center widget.
Adw.HeaderBar:decoration-layout
The decoration layout for buttons.
Adw.HeaderBar:show-back-button
Whether the header bar can show the back button.
Available since: 1.4
Adw.HeaderBar:show-end-title-buttons
Whether to show title buttons at the end of the header bar.
Adw.HeaderBar:show-start-title-buttons
Whether to show title buttons at the start of the header bar.
Adw.HeaderBar:title-widget
The title widget to display.