Class HeaderBar

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gobject.InitiallyUnowned
org.gnome.gtk.Widget
org.gnome.gtk.HeaderBar
All Implemented Interfaces:
Accessible, Buildable, ConstraintTarget, Proxy
@Generated("org.javagi.JavaGI") public class HeaderBar extends Widget implements Accessible, Buildable, ConstraintTarget

Creates a custom titlebar for a window.

An example GtkHeaderBar

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 Window.setTitlebar(Widget)), 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:

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

Accessibility

GtkHeaderBar uses the Gtk.AccessibleRole.group role.

  • Constructor Details

    • HeaderBar

      public HeaderBar(MemorySegment address)
      Create a HeaderBar instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • HeaderBar

      public HeaderBar()
      Create a new HeaderBar.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the HeaderBar class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected HeaderBar asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class Widget
      Returns:
      the instance as if it were its parent type

    • getDecorationLayout

      public @Nullable String getDecorationLayout()
      Gets the decoration layout of the header bar.
      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 @Nullable Widget getTitleWidget()

      Retrieves the title widget of the header bar.

      See setTitleWidget(Widget).

      Returns:
      the title widget

    • getUseNativeControls

      public boolean getUseNativeControls()
      Returns whether this header bar shows platform native window controls.
      Returns:
      true if native window controls are shown
      Since:
      4.18

    • packEnd

      public void packEnd(Widget child)
      Adds a child to the header bar, packed with reference to the end.
      Parameters:
      child - the widget to be added to this HeaderBar

    • packStart

      public void packStart(Widget child)
      Adds a child to the header bar, packed with reference to the start.
      Parameters:
      child - the widget to be added to this HeaderBar

    • remove

      public void remove(Widget child)

      Removes a child from the header bar.

      The child must have been added with packStart(Widget), packEnd(Widget) or setTitleWidget(Widget).

      Parameters:
      child - the child to remove

    • setDecorationLayout

      public void setDecorationLayout(@Nullable String layout)

      Sets the decoration layout for this header bar.

      This property overrides the 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.

      Parameters:
      layout - a decoration 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 titleWidget)

      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.

      Parameters:
      titleWidget - a widget to use for a title

    • setUseNativeControls

      public void setUseNativeControls(boolean 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.

      Parameters:
      setting - true to show native window controls
      Since:
      4.18

    • builder

      public static HeaderBar.Builder<? extends HeaderBar.Builder> builder()
      A HeaderBar.Builder object constructs a HeaderBar with the specified properties. Use the various set...() methods to set properties, and finish construction with HeaderBar.Builder.build().
      Returns:
      the builder object