Struct gtk4::HeaderBar

#[repr(transparent)]
pub struct HeaderBar { /* private fields */ }

HeaderBar is a widget for creating custom title bars for windows.

HeaderBar is similar to a horizontal CenterBox. It allows children to be placed at the start or the end. In addition, it allows the window title to be displayed. The title will be centered with respect to the width of the box, even if the children at either side take up different amounts of space.

HeaderBar can add typical window frame controls, such as minimize, maximize and close buttons, or the window icon.

For these reasons, HeaderBar is the natural choice for use as the custom titlebar widget of a Window (see GtkWindowExt::set_titlebar()), as it gives features typical of titlebars while allowing the addition of child widgets.

GtkHeaderBar as GtkBuildable

The HeaderBar implementation of the Buildable interface supports adding children at the start or end sides by specifying “start” or “end” as the “type” attribute of a element, or setting the title widget by specifying “title” value.

By default the HeaderBar uses a Label displaying the title of the window it is contained in as the title widget, equivalent to the following UI definition:

<object class="GtkHeaderBar">
  <property name="title-widget">
    <object class="GtkLabel">
      <property name="label" translatable="yes">Label</property>
      <property name="single-line-mode">True</property>
      <property name="ellipsize">end</property>
      <property name="width-chars">5</property>
      <style>
        <class name="title"/>
      </style>
    </object>
  </property>
</object>

CSS nodes

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

A HeaderBar’s CSS node is called headerbar. It contains a windowhandle subnode, which contains a box subnode, which contains two box subnodes at the start and end of the header bar, as well as a center node that represents the title.

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

Accessibility

HeaderBar uses the AccessibleRole::Group role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

impl HeaderBar

pub fn new() -> HeaderBar

Creates a new HeaderBar widget.

Returns

a new 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 decoration_layout(&self) -> Option<GString>

Gets the decoration layout of the HeaderBar.

Returns

the decoration layout

pub fn shows_title_buttons(&self) -> bool

Returns whether this header bar shows the standard window title buttons.

Returns

true if title buttons are shown

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

Retrieves the title widget of the header.

See set_title_widget().

Returns

the title widget of the header

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

Adds @child to @self, packed with reference to the end of the @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 the HeaderBar.

The child must have been added with pack_start(), pack_end() or set_title_widget().

child

the child to remove

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

Sets the decoration layout for this header bar.

This property overrides the property::Settings::gtk-decoration-layout setting.

There can be valid reasons for overriding the setting, such as a header bar design that does not allow for buttons to take room on the right, or only offers room for a single close button. Split header bars are another example for overriding the setting.

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

For example, “icon:minimize,maximize,close” specifies an icon on the left, and minimize, maximize and close buttons on the right.

layout

a decoration layout, or None to unset the layout

pub fn set_show_title_buttons(&self, setting: bool)

Sets whether this header bar shows the standard window title buttons.

setting

true to show standard title buttons

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

Sets the title for the HeaderBar.

When set to None, the headerbar will display the title of the window it is contained in.

The title should help a user identify the current view. To achieve the same style as the builtin title, use the “title” style class.

You should set the title widget to None, for the window title label to be visible again.

title_widget

a widget to use for a title

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

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

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

Trait Implementations

impl Clone for HeaderBar

fn clone(&self) -> Self

Returns a copy of the value.

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 Display for HeaderBar

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

Formats the value using the given formatter.

impl Hash for HeaderBar

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

Feeds this value into the given Hasher.

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

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

This method tests for self and other values to be equal, and is used by ==.

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>

This method returns an ordering between self and other values if one exists.

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