class: HeaderBarMeta

[359:14] static extends: object

Generated metadata helpers for HeaderBar class surfaces.

Methods

• properties ()

  Returns property metadata for HeaderBar.

  • @r A list.

class: HeaderBar

[43:7] extends: object

Creates a custom titlebar for a window. GtkHeaderBar is similar to a horizontal GtkCenterBox. 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. GtkHeaderBar can add typical window frame controls, such as minimize, maximize and close buttons, or the window icon. For these reasons, GtkHeaderBar is the natural choice for use as the custom titlebar widget of a GtkWindow (see [method@Gtk.Window.set_titlebar]), as it gives features typical of titlebars while allowing the addition of child widgets. ## GtkHeaderBar as GtkBuildable The GtkHeaderBar implementation of the GtkBuildable 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 GtkHeaderBar uses a GtkLabel displaying the title of the window it is contained in as the title widget, equivalent to the following UI definition:

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 `GtkHeaderBar`'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 [class@Gtk.WindowControls] for
details, as well as other children. # Accessibility `GtkHeaderBar` uses the
[enum@Gtk.AccessibleRole.group] role.

#### Members
- **handleObj**
- **lib**
- **retainedCallbacks**
- **signalHandlerNames**
- **signalSetterHandlers**

#### Methods

- **HeaderBar** ()

	> Creates a new `GtkHeaderBar` widget.



- **toNativeHandle** (`Source`)

	> Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from `fn.call(...)`, another generated wrapper exposing `handle()`, or null. Returns null when the argument carries no pointer.

	- **@p** `Source` is the raw handle, raw buffer, wrapper, or null.
	- **@r** `A` raw pointer carrier or null when no pointer is present.


- **getLib** ()

	> Returns the opened native library for this generated wrapper.

	- **@r** `The` opened native library.


- **handle** ()

	> Returns the wrapped NativeHandle.

	- **@r** `The` wrapped NativeHandle.


- **isNull** ()

	> Returns true when the wrapped handle is null.

	- **@r** `A` bool.


- **describe** ()

	> Returns a small string for debugging generated wrappers.

	- **@r** `A` string.


- **asWidget** ()

	> Wraps this handle as `Widget`.

	- **@r** `A` `Widget` object.


- **asAccessible** ()

	> Wraps this handle as `Accessible`.

	- **@r** `A` `Accessible` object.


- **asBuildable** ()

	> Wraps this handle as `Buildable`.

	- **@r** `A` `Buildable` object.


- **asConstraintTarget** ()

	> Wraps this handle as `ConstraintTarget`.

	- **@r** `A` `ConstraintTarget` object.


- **getProperty** (`string Name`)

	> Reads one generated property by name.



- **setProperty** (`string Name, Value`)

	> Writes one generated property by name.



- **setDecorationlayout** (`string Value`)

	> The decoration layout for buttons. If this property is not set, the [property@Gtk.Settings:gtk-decoration-layout] setting is used.

	- **@p** `Value` is the new property value.
	- **@r** `None.` 


- **setShowtitlebuttons** (`bool Value`)

	> Whether to show title buttons like close, minimize, maximize. Which buttons are actually shown and where is determined by the [property@Gtk.HeaderBar: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).

	- **@p** `Value` is the new property value.
	- **@r** `None.` 


- **setTitlewidget** (`object Value`)

	> The title widget to display.

	- **@p** `Value` is the new property value.
	- **@r** `None.` 


- **setUsenativecontrols** (`bool Value`)

	> Whether to show platform native close/minimize/maximize buttons. For macOS, the [property@Gtk.HeaderBar:decoration-layout] property can be used to enable/disable controls. On Linux, this option has no effect. See also [Using GTK on Apple macOS](osx.html?native-window-controls).

	- **@p** `Value` is the new property value.
	- **@r** `None.` 


- **get\_decoration\_layout** ()

	> Gets the decoration layout of the header bar.



- **get\_show\_title\_buttons** ()

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



- **get\_title\_widget** ()

	> Retrieves the title widget of the header bar. See [method@Gtk.HeaderBar.set_title_widget].



- **get\_use\_native\_controls** ()

	> Returns whether this header bar shows platform native window controls.



- **pack\_end** (`object child`)

	> Adds a child to the header bar, packed with reference to the end.

	- **@p** `child` is the widget to be added to @bar.
	- **@r** `None.` 


- **pack\_start** (`object child`)

	> Adds a child to the header bar, packed with reference to the start.

	- **@p** `child` is the widget to be added to @bar.
	- **@r** `None.` 


- **remove** (`object child`)

	> Removes a child from the header bar. The child must have been added with [method@Gtk.HeaderBar.pack_start], [method@Gtk.HeaderBar.pack_end] or [method@Gtk.HeaderBar.set_title_widget].

	- **@p** `child` is the child to remove.
	- **@r** `None.` 


- **set\_decoration\_layout** (`string layout`)

	> Sets the decoration layout for this header bar. This property overrides the [property@Gtk.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.

	- **@p** `layout` is a decoration layout.
	- **@r** `None.` 


- **set\_show\_title\_buttons** (`bool setting`)

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

	- **@p** `setting` is true to show standard title buttons.
	- **@r** `None.` 


- **set\_title\_widget** (`object title_widget`)

	> Sets the title for the header bar. When set to `NULL`, 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 `NULL`, for the window title label to be visible again.

	- **@p** `title_widget` is a widget to use for a title.
	- **@r** `None.` 


- **set\_use\_native\_controls** (`bool setting`)

	> Sets whether this header bar shows native window controls. This option shows the "stoplight" buttons on macOS. For Linux, this option has no effect. See also [Using GTK on Apple macOS](osx.html?native-window-controls).

	- **@p** `setting` is true to show native window controls.
	- **@r** `None.`