GtkHeaderBar — A box with a centered child
GtkWidget * | gtk_header_bar_new () |
void | gtk_header_bar_set_title () |
const gchar * | gtk_header_bar_get_title () |
void | gtk_header_bar_set_subtitle () |
const gchar * | gtk_header_bar_get_subtitle () |
void | gtk_header_bar_set_has_subtitle () |
gboolean | gtk_header_bar_get_has_subtitle () |
void | gtk_header_bar_set_custom_title () |
GtkWidget * | gtk_header_bar_get_custom_title () |
void | gtk_header_bar_pack_start () |
void | gtk_header_bar_pack_end () |
void | gtk_header_bar_set_show_close_button () |
gboolean | gtk_header_bar_get_show_close_button () |
void | gtk_header_bar_set_decoration_layout () |
const gchar * | gtk_header_bar_get_decoration_layout () |
GtkWidget * | custom-title | Read / Write |
char * | decoration-layout | Read / Write |
gboolean | decoration-layout-set | Read / Write |
gboolean | has-subtitle | Read / Write |
gboolean | show-close-button | Read / Write |
int | spacing | Read / Write |
char * | subtitle | Read / Write |
char * | title | Read / Write |
GtkPackType | pack-type | Read / Write |
int | position | Read / Write |
struct | GtkHeaderBar |
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkHeaderBar
GtkHeaderBar implements AtkImplementorIface and GtkBuildable.
#include <gtk/gtk.h>
GtkHeaderBar is similar to a horizontal GtkBox. It allows children to be placed at the start or the end. In addition, it allows a title and subtitle 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. The height of the titlebar will be set to provide sufficient space for the subtitle, even if none is currently set. If a subtitle is not needed, the space reservation can be turned off with gtk_header_bar_set_has_subtitle()
.
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 gtk_window_set_titlebar()
), as it gives features typical of titlebars while allowing the addition of child widgets.
GtkWidget *
gtk_header_bar_new (void
);
Creates a new GtkHeaderBar widget.
a new GtkHeaderBar
Since: 3.10
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.
bar | ||
title | a title, or | [allow-none] |
Since: 3.10
const gchar *
gtk_header_bar_get_title (GtkHeaderBar *bar
);
Retrieves the title of the header. See gtk_header_bar_set_title()
.
bar |
the title of the header, or NULL
if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed.
[nullable]
Since: 3.10
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
.
bar | ||
subtitle | a subtitle, or | [allow-none] |
Since: 3.10
const gchar *
gtk_header_bar_get_subtitle (GtkHeaderBar *bar
);
Retrieves the subtitle of the header. See gtk_header_bar_set_subtitle()
.
bar |
the subtitle of the header, or NULL
if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed.
[nullable]
Since: 3.10
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.
bar | ||
setting |
|
Since: 3.12
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.
bar |
TRUE
if the header bar reserves space for a subtitle
Since: 3.12
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.
bar | ||
title_widget | a custom widget to use for a title. | [allow-none] |
Since: 3.10
GtkWidget *
gtk_header_bar_get_custom_title (GtkHeaderBar *bar
);
Retrieves the custom title widget of the header. See gtk_header_bar_set_custom_title()
.
bar |
the custom title widget of the header, or NULL
if none has been set explicitly.
[nullable][transfer none]
Since: 3.10
void gtk_header_bar_pack_start (GtkHeaderBar *bar
,GtkWidget *child
);
Adds child
to bar
, packed with reference to the start of the bar
.
bar | ||
child | the GtkWidget to be added to |
Since: 3.10
void gtk_header_bar_pack_end (GtkHeaderBar *bar
,GtkWidget *child
);
Adds child
to bar
, packed with reference to the end of the bar
.
bar | ||
child | the GtkWidget to be added to |
Since: 3.10
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.
bar | ||
setting |
|
Since: 3.10
gboolean
gtk_header_bar_get_show_close_button (GtkHeaderBar *bar
);
Returns whether this header bar shows the standard window decorations.
bar |
TRUE
if the decorations are shown
Since: 3.10
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.
bar | ||
layout | a decoration layout, or | [allow-none] |
Since: 3.12
const gchar *
gtk_header_bar_get_decoration_layout (GtkHeaderBar *bar
);
Gets the decoration layout set with gtk_header_bar_set_decoration_layout()
.
bar |
the decoration layout
Since: 3.12
struct GtkHeaderBar;
“custom-title”
property“custom-title” GtkWidget *
Custom title widget to display.
Owner: GtkHeaderBar
Flags: Read / Write
“decoration-layout”
property“decoration-layout” char *
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.
Owner: GtkHeaderBar
Flags: Read / Write
Default value: NULL
Since: 3.12
“decoration-layout-set”
property“decoration-layout-set” gboolean
Set to TRUE
if “decoration-layout” is set.
Owner: GtkHeaderBar
Flags: Read / Write
Default value: FALSE
Since: 3.12
“has-subtitle”
property“has-subtitle” gboolean
If TRUE
, reserve space for a subtitle, even if none is currently set.
Owner: GtkHeaderBar
Flags: Read / Write
Default value: TRUE
Since: 3.12
“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).
Owner: GtkHeaderBar
Flags: Read / Write
Default value: FALSE
“spacing”
property“spacing” int
The amount of space between children.
Owner: GtkHeaderBar
Flags: Read / Write
Allowed values: >= 0
Default value: 6
“subtitle”
property“subtitle” char *
The subtitle to display.
Owner: GtkHeaderBar
Flags: Read / Write
Default value: NULL
“title”
property“title” char *
The title to display.
Owner: GtkHeaderBar
Flags: Read / Write
Default value: NULL
“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.
Owner: GtkHeaderBar
Flags: Read / Write
Default value: GTK_PACK_START
“position”
child property“position” int
The index of the child in the parent.
Owner: GtkHeaderBar
Flags: Read / Write
Allowed values: >= -1
Default value: 0
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.24/GtkHeaderBar.html