Struct libadwaita::HeaderBar

pub struct HeaderBar { /* private fields */ }

A title bar widget.

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, HeaderBar 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 show-start-title-buttons and show-end-title-buttons to FALSE to remove it if it’s unwanted.

Navigation View Integration

When placed inside an NavigationPage, 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 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, HeaderBar will automatically hide the title buttons other than at the edges of the window.

Bottom Sheet Integration

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

Centering Policy

centering-policy allows to enforce strict centering of the title widget. This can be useful for entries inside Clamp.

Title Buttons

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

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

When 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

HeaderBar uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Properties

centering-policy

The policy for aligning the center widget.

Readable | Writeable

decoration-layout

The decoration layout for buttons.

If this property is not set, the gtk-decoration-layout 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.

Readable | Writeable

show-back-button

Whether the header bar can show the back button.

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

Readable | Writeable

show-end-title-buttons

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

See show-start-title-buttons for the other side.

Which buttons are actually shown and where is determined by the 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).

Readable | Writeable

show-start-title-buttons

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

See show-end-title-buttons for the other side.

Which buttons are actually shown and where is determined by the 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).

Readable | Writeable

show-title

Whether the title widget should be shown.

Readable | Writeable

title-widget

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 WindowTitle:

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

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The gtk::Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Gtk::Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Gtk::Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl HeaderBar

pub fn new() -> HeaderBar

Creates a new HeaderBar.

Returns

the newly created HeaderBar.

pub fn builder() -> HeaderBarBuilder

Creates a new builder-pattern struct instance to construct HeaderBar objects.

This method returns an instance of HeaderBarBuilder which can be used to create HeaderBar objects.

pub fn centering_policy(&self) -> CenteringPolicy

Gets the policy for aligning the center widget.

Returns

the centering policy

pub fn decoration_layout(&self) -> Option<GString>

Gets the decoration layout for @self.

Returns

the decoration layout

pub fn shows_back_button(&self) -> bool

Available on crate feature v1_4 only.

Gets whether @self can show the back button.

Returns

whether to show the back button

pub fn shows_end_title_buttons(&self) -> bool

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

Returns

TRUE if title buttons at the end are shown

pub fn shows_start_title_buttons(&self) -> bool

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

Returns

TRUE if title buttons at the start are shown

pub fn shows_title(&self) -> bool

Available on crate feature v1_4 only.

Gets whether the title widget should be shown.

Returns

whether the title widget should be shown.

pub fn title_widget(&self) -> Option<Widget>

Gets the title widget widget of @self.

Returns

the title widget

pub fn pack_end(&self, child: &impl IsA<Widget>)

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

child

the widget to be added to @self

pub fn pack_start(&self, child: &impl IsA<Widget>)

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

child

the widget to be added to @self

pub fn remove(&self, child: &impl IsA<Widget>)

Removes a child from @self.

The child must have been added with pack_start(), pack_end() or title-widget.

child

the child to remove

pub fn set_centering_policy(&self, centering_policy: CenteringPolicy)

Sets the policy for aligning the center widget.

centering_policy

the centering policy

pub fn set_decoration_layout(&self, layout: Option<&str>)

Sets the decoration layout for @self.

If this property is not set, the gtk-decoration-layout 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.

layout

a decoration layout

pub fn set_show_back_button(&self, show_back_button: bool)

Available on crate feature v1_4 only.

Sets whether @self can show the back button.

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

show_back_button

whether to show the back button

pub fn set_show_end_title_buttons(&self, setting: bool)

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

See show-start-title-buttons for the other side.

Which buttons are actually shown and where is determined by the 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).

setting

TRUE to show standard title buttons

pub fn set_show_start_title_buttons(&self, setting: bool)

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

See show-end-title-buttons for the other side.

Which buttons are actually shown and where is determined by the 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).

setting

TRUE to show standard title buttons

pub fn set_show_title(&self, show_title: bool)

Available on crate feature v1_4 only.

Sets whether the title widget should be shown.

show_title

whether the title widget is visible

pub fn set_title_widget(&self, title_widget: Option<&impl IsA<Widget>>)

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 WindowTitle:

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

title_widget

a widget to use for a title

pub fn connect_centering_policy_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_decoration_layout_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_show_back_button_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_4 only.

pub fn connect_show_end_title_buttons_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_show_start_title_buttons_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_show_title_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_4 only.

pub fn connect_title_widget_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for HeaderBar

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HeaderBar

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HeaderBar

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for HeaderBar

type ParamSpec = ParamSpecObject

type SetValue = HeaderBar

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, HeaderBar>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for HeaderBar

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HeaderBar

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for HeaderBar

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for HeaderBar

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for HeaderBar

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for HeaderBar

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for HeaderBar

impl IsA<Accessible> for HeaderBar

impl IsA<Buildable> for HeaderBar

impl IsA<ConstraintTarget> for HeaderBar

impl IsA<Widget> for HeaderBar