gtk.header_bar

Module for [HeaderBar] class

class HeaderBar HeaderBarGidBuilder HeaderBarGidBuilderImpl

Types 3

[gtk.header_bar.HeaderBar] is a widget for creating custom title bars for windows.

[gtk.header_bar.HeaderBar] is similar to a horizontal [gtk.center_box.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.

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

For these reasons, [gtk.header_bar.HeaderBar] is the natural choice for use as the custom titlebar widget of a [gtk.window.Window] (see [gtk.window.Window.setTitlebar]), as it gives features typical of titlebars while allowing the addition of child widgets.

GtkHeaderBar as GtkBuildable

The [gtk.header_bar.HeaderBar] implementation of the [gtk.buildable.Buildable] interface supports adding children at the start or end sides by specifying “start” or “end” as the “type” attribute of a <child> element, or setting the title widget by specifying “title” value.

By default the [gtk.header_bar.HeaderBar] uses a [gtk.label.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 [gtk.header_bar.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 [gtk.window_controls.WindowControls] for details, as well as other children.

Accessibility

[gtk.header_bar.HeaderBar] uses the [gtk.types.AccessibleRole.Group] role.

Methods

GType _getGType()

GType _gType() @property

HeaderBar self()Returns `this`, for use in `with` statements.

HeaderBarGidBuilder builder()Get builder for [gtk.header_bar.HeaderBar] Returns: New builder object

string decorationLayout() @propertyGet `decorationLayout` property. Returns: The decoration layout for buttons.

void decorationLayout(string propval) @propertySet `decorationLayout` property. Params: propval = The decoration layout for buttons.

bool showTitleButtons() @propertyGet `showTitleButtons` property. Returns: Whether to show title buttons like close, minimize, maximize.

void showTitleButtons(bool propval) @propertySet `showTitleButtons` property. Params: propval = Whether to show title buttons like close, minimize, maximize.

gtk.widget.Widget titleWidget() @property

void titleWidget(gtk.widget.Widget propval) @property

string getDecorationLayout()Gets the decoration layout of the [gtk.header_bar.HeaderBar]. Returns: the decoration layout

bool getShowTitleButtons()Returns whether this header bar shows the standard window title buttons. Returns: true if title buttons are shown

gtk.widget.Widget getTitleWidget()Retrieves the title widget of the header.

void packEnd(gtk.widget.Widget child)Adds child to bar, packed with reference to the end of the bar.

void packStart(gtk.widget.Widget child)Adds child to bar, packed with reference to the start of the bar.

void remove(gtk.widget.Widget child)Removes a child from the [gtk.header_bar.HeaderBar].

void setDecorationLayout(string layout = null)Sets the decoration layout for this header bar.

void setShowTitleButtons(bool setting)Sets whether this header bar shows the standard window title buttons.

void setTitleWidget(gtk.widget.Widget titleWidget = null)Sets the title for the [gtk.header_bar.HeaderBar].

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new [gtk.headerbar.HeaderBar] widget. Returns: a new [gtk.headerbar.HeaderBar]

classHeaderBarGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T

Methods

T decorationLayout(string propval)Set `decorationLayout` property. Params: propval = The decoration layout for buttons.

T showTitleButtons(bool propval)Set `showTitleButtons` property. Params: propval = Whether to show title buttons like close, minimize, maximize.

T titleWidget(gtk.widget.Widget propval)

classHeaderBarGidBuilder : HeaderBarGidBuilderImpl!HeaderBarGidBuilder

Fluent builder for [gtk.header_bar.HeaderBar]

Methods

HeaderBar build()