gtk_header_bar_new ()

GtkWidget *
gtk_header_bar_new (void);

Creates a new GtkHeaderBar widget.

Since 3.10

gtk_header_bar_set_title ()

void
gtk_header_bar_set_title (GtkHeaderBar *bar,
                          const gchar *title);

Sets the title of the GtkHeaderBar. The title should help a user identify the current view. A good title should not include the application name.

Since 3.10

gtk_header_bar_get_title ()

const gchar *
gtk_header_bar_get_title (GtkHeaderBar *bar);

Retrieves the title of the header. See gtk_header_bar_set_title().

Since 3.10

gtk_header_bar_set_subtitle ()

void
gtk_header_bar_set_subtitle (GtkHeaderBar *bar,
                             const gchar *subtitle);

Sets the subtitle of the GtkHeaderBar. The title should give a user an additional detail to help him identify the current view.

Note that GtkHeaderBar by default reserves room for the subtitle, even if none is currently set. If this is not desired, set the “has-subtitle” property to FALSE.

Since 3.10

gtk_header_bar_get_subtitle ()

const gchar *
gtk_header_bar_get_subtitle (GtkHeaderBar *bar);

Retrieves the subtitle of the header. See gtk_header_bar_set_subtitle().

Since 3.10

gtk_header_bar_set_has_subtitle ()

void
gtk_header_bar_set_has_subtitle (GtkHeaderBar *bar,
                                 gboolean setting);

Sets whether the header bar should reserve space for a subtitle, even if none is currently set.

Since 3.12

gtk_header_bar_get_has_subtitle ()

gboolean
gtk_header_bar_get_has_subtitle (GtkHeaderBar *bar);

Retrieves whether the header bar reserves space for a subtitle, regardless if one is currently set or not.

Since 3.12

gtk_header_bar_set_custom_title ()

void
gtk_header_bar_set_custom_title (GtkHeaderBar *bar,
                                 GtkWidget *title_widget);

Sets a custom title for the GtkHeaderBar.

The title should help a user identify the current view. This supersedes any title set by gtk_header_bar_set_title() or gtk_header_bar_set_subtitle(). To achieve the same style as the builtin title and subtitle, use the “title” and “subtitle” style classes.

You should set the custom title to NULL, for the header title label to be visible again.

Since 3.10

gtk_header_bar_get_custom_title ()

GtkWidget *
gtk_header_bar_get_custom_title (GtkHeaderBar *bar);

Retrieves the custom title widget of the header. See gtk_header_bar_set_custom_title().

Since 3.10

gtk_header_bar_pack_start ()

void
gtk_header_bar_pack_start (GtkHeaderBar *bar,
                           GtkWidget *child);

Adds child to bar , packed with reference to the start of the bar .

Since 3.10

gtk_header_bar_pack_end ()

void
gtk_header_bar_pack_end (GtkHeaderBar *bar,
                         GtkWidget *child);

Adds child to bar , packed with reference to the end of the bar .

Since 3.10

gtk_header_bar_set_show_close_button ()

void
gtk_header_bar_set_show_close_button (GtkHeaderBar *bar,
                                      gboolean setting);

Sets whether this header bar shows the standard window decorations, including close, maximize, and minimize.

Since 3.10

gtk_header_bar_get_show_close_button ()

gboolean
gtk_header_bar_get_show_close_button (GtkHeaderBar *bar);

Returns whether this header bar shows the standard window decorations.

Since 3.10

gtk_header_bar_set_decoration_layout ()

void
gtk_header_bar_set_decoration_layout (GtkHeaderBar *bar,
                                      const gchar *layout);

Sets the decoration layout for this header bar, overriding the “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, icon (the window icon) and menu (a menu button for the fallback app menu).

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

Since 3.12

gtk_header_bar_get_decoration_layout ()

const gchar *
gtk_header_bar_get_decoration_layout (GtkHeaderBar *bar);

Gets the decoration layout set with gtk_header_bar_set_decoration_layout().

Since 3.12

struct GtkHeaderBar

struct GtkHeaderBar;

The “custom-title” property

  “custom-title”             GtkWidget *

Custom title widget to display.

Flags: Read / Write / Construct

The “decoration-layout” property

  “decoration-layout”        gchar *

The decoration layout for buttons. If this property is not set, the “gtk-decoration-layout” setting is used.

See gtk_header_bar_set_decoration_layout() for information about the format of this string.

Flags: Read / Write

Default value: NULL

Since 3.12

The “decoration-layout-set” property

  “decoration-layout-set”    gboolean

Set to TRUE if “decoration-layout” is set.

Flags: Read / Write

Default value: FALSE

Since 3.12

The “has-subtitle” property

  “has-subtitle”             gboolean

If TRUE, reserve space for a subtitle, even if none is currently set.

Flags: Read / Write

Default value: TRUE

Since 3.12

The “show-close-button” property

  “show-close-button”        gboolean

Whether to show window decorations.

Which buttons are actually shown and where is determined by the “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).

Flags: Read / Write

Default value: FALSE

The “spacing” property

  “spacing”                  gint

The amount of space between children.

Flags: Read / Write

Allowed values: >= 0

Default value: 6

The “subtitle” property

  “subtitle”                 gchar *

The subtitle to display.

Flags: Read / Write

Default value: NULL

The “title” property

  “title”                    gchar *

The title to display.

Flags: Read / Write

Default value: NULL

The “pack-type” child property

  “pack-type”                GtkPackType

A GtkPackType indicating whether the child is packed with reference to the start or end of the parent.

Flags: Read / Write

Default value: GTK_PACK_START

The “position” child property

  “position”                 gint

The index of the child in the parent.

Flags: Read

Allowed values: >= -1

Default value: 0