Package ch.bailu.gtk.gtk

Class HeaderBar

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gobject.InitiallyUnowned
ch.bailu.gtk.gtk.Widget
ch.bailu.gtk.gtk.HeaderBar
All Implemented Interfaces:
PointerInterface
public class HeaderBar extends Widget
`GtkHeaderBar` is a widget for creating custom title bars for windows.

![An example GtkHeaderBar](headerbar.png)

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

```xml
<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 `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 %GTK_ACCESSIBLE_ROLE_GROUP role.

https://docs.gtk.org/gtk4/class.HeaderBar.html

  • Constructor Details

    • HeaderBar

      public HeaderBar(PointerContainer pointer)

    • HeaderBar

      public HeaderBar()
      Creates a new `GtkHeaderBar` widget.

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • getDecorationLayout

      public Str getDecorationLayout()
      Gets the decoration layout of the `GtkHeaderBar`.
      Returns:
      the decoration layout

    • getShowTitleButtons

      public boolean getShowTitleButtons()
      Returns whether this header bar shows the standard window
      title buttons.
      Returns:
      %TRUE if title buttons are shown

    • getTitleWidget

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

      See [method@Gtk.HeaderBar.set_title_widget].
      Returns:
      the title widget of the header

    • packEnd

      public void packEnd(@Nonnull Widget child)
      Adds @child to @bar, packed with reference to the
      end of the @bar.
      Parameters:
      child - the `GtkWidget` to be added to @bar

    • packStart

      public void packStart(@Nonnull Widget child)
      Adds @child to @bar, packed with reference to the
      start of the @bar.
      Parameters:
      child - the `GtkWidget` to be added to @bar

    • remove

      public void remove(@Nonnull Widget child)
      Removes a child from the `GtkHeaderBar`.

      The child must have been added with
      [method@Gtk.HeaderBar.pack_start],
      [method@Gtk.HeaderBar.pack_end] or
      [method@Gtk.HeaderBar.set_title_widget].
      Parameters:
      child - the child to remove

    • setDecorationLayout

      public void setDecorationLayout(@Nullable Str 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 a icon
      on the left, and minimize, maximize and close buttons on the right.
      Parameters:
      layout - a decoration layout, or %NULL to unset the layout

    • setDecorationLayout

      public void setDecorationLayout(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 a icon
      on the left, and minimize, maximize and close buttons on the right.
      Parameters:
      layout - a decoration layout, or %NULL to unset the layout

    • setShowTitleButtons

      public void setShowTitleButtons(boolean setting)
      Sets whether this header bar shows the standard window
      title buttons.
      Parameters:
      setting - %TRUE to show standard title buttons

    • setTitleWidget

      public void setTitleWidget(@Nullable Widget title_widget)
      Sets the title for the `GtkHeaderBar`.

      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.
      Parameters:
      title_widget - a widget to use for a title

    • asAccessible

      public Accessible asAccessible()
      Implements interface Accessible. Call this to get access to interface functions.
      Overrides:
      asAccessible in class Widget
      Returns:
      Accessible

    • asBuildable

      public Buildable asBuildable()
      Implements interface Buildable. Call this to get access to interface functions.
      Overrides:
      asBuildable in class Widget
      Returns:
      Buildable

    • asConstraintTarget

      public ConstraintTarget asConstraintTarget()
      Implements interface ConstraintTarget. Call this to get access to interface functions.
      Overrides:
      asConstraintTarget in class Widget
      Returns:
      ConstraintTarget

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()