class Adw::HeaderBar

• Adw::HeaderBar
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

A title bar widget.

Adw::HeaderBar is similar to Gtk::HeaderBar, but provides additional features compared to it. Refer to Gtk::HeaderBar for details. It is typically used as a top bar within #ToolbarView.

Dialog Integration

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

Navigation View Integration

When placed inside an #NavigationPage, Adw::HeaderBar will display the page title instead of window title.

When used together with #NavigationView or #NavigationSplitView, 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 [property@HeaderBar:show-back-button] to FALSE to disable this behavior in rare scenarios where it's unwanted.

Split View Integration

When placed inside #NavigationSplitView or #OverlaySplitView, Adw::HeaderBar will automatically hide the title buttons other than at the edges of the window.

Bottom Sheet Integration

When played inside #BottomSheet, Adw::HeaderBar will not show the title unless [property@BottomSheet:show-drag-handle] is set to FALSE, regardless of [property@HeaderBar:show-title]. This only applies to the default title, titles set with [property@HeaderBar:title-widget] will still be shown.

Centering Policy

[property@HeaderBar:centering-policy] allows to enforce strict centering of the title widget. This can be useful for entries inside #Clamp.

Title Buttons

Unlike Gtk::HeaderBar, Adw::HeaderBar allows to toggle title button visibility for each side individually, using the [property@HeaderBar:show-start-title-buttons] and [property@HeaderBar: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

Adw::HeaderBar'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 subnodes 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 Gtk::WindowControls for details, as well as other children.

When [property@HeaderBar: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

Adw::HeaderBar uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget

Defined in:

Constructors

• .new : self

  Creates a new Adw::HeaderBar.

• .new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, centering_policy : Adw::CenteringPolicy | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, cursor : Gdk::Cursor | Nil = nil, decoration_layout : String | Nil = nil, focus_on_click : Bool | Nil = nil, focusable : Bool | Nil = nil, halign : Gtk::Align | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, limit_events : Bool | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, parent : Gtk::Widget | Nil = nil, receives_default : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, show_back_button : Bool | Nil = nil, show_end_title_buttons : Bool | Nil = nil, show_start_title_buttons : Bool | Nil = nil, show_title : Bool | Nil = nil, title_widget : Gtk::Widget | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, valign : Gtk::Align | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, width_request : Int32 | Nil = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #centering_policy : Adw::CenteringPolicy

  Gets the policy for aligning the center widget.

• #centering_policy=(centering_policy : Adw::CenteringPolicy) : Nil

  Sets the policy for aligning the center widget.

• #decoration_layout : String | Nil

  Gets the decoration layout for self.

• #decoration_layout=(value : String) : String
• #decoration_layout=(value : Nil) : Nil

  Set #decoration_layout property to nil.

• #decoration_layout=(layout : String | Nil) : Nil

  Sets the decoration layout for self.

• #decoration_layout? : String | Nil

  Same as #decoration_layout, but can return nil.

• #hash(hasher)

  See Object#hash(hasher)

• #pack_end(child : Gtk::Widget) : Nil

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

• #pack_start(child : Gtk::Widget) : Nil

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

• #remove(child : Gtk::Widget) : Nil

  Removes a child from self.

• #show_back_button : Bool

  Gets whether self can show the back button.

• #show_back_button=(show_back_button : Bool) : Nil

  Sets whether self can show the back button.

• #show_back_button? : Bool
• #show_end_title_buttons : Bool

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

• #show_end_title_buttons=(setting : Bool) : Nil

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

• #show_end_title_buttons? : Bool
• #show_start_title_buttons : Bool

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

• #show_start_title_buttons=(setting : Bool) : Nil

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

• #show_start_title_buttons? : Bool
• #show_title : Bool

  Gets whether the title widget should be shown.

• #show_title=(show_title : Bool) : Nil

  Sets whether the title widget should be shown.

• #show_title? : Bool
• #title_widget : Gtk::Widget | Nil

  Gets the title widget widget of self.

• #title_widget=(title_widget : Gtk::Widget | Nil) : Nil

  Sets the title widget for self.

Constructor Detail

Class Method Detail

Instance Method Detail

<object class="Adw::HeaderBar">
  <property name="title-widget">
    <object class="Adw::WindowTitle">
      <property name="title" translatable="yes">Title</property>
    </object>
  </property>
</object>