Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Child Properties | ![]() |
![]() |
![]() |
![]() |
#include <gtk/gtk.h> struct GtkHeaderBar; GtkWidget * gtk_header_bar_new (void
); void gtk_header_bar_set_title (GtkHeaderBar *bar
,const gchar *title
); const gchar * gtk_header_bar_get_title (GtkHeaderBar *bar
); void gtk_header_bar_set_subtitle (GtkHeaderBar *bar
,const gchar *subtitle
); const gchar * gtk_header_bar_get_subtitle (GtkHeaderBar *bar
); void gtk_header_bar_set_has_subtitle (GtkHeaderBar *bar
,gboolean setting
); gboolean gtk_header_bar_get_has_subtitle (GtkHeaderBar *bar
); void gtk_header_bar_set_custom_title (GtkHeaderBar *bar
,GtkWidget *title_widget
); GtkWidget * gtk_header_bar_get_custom_title (GtkHeaderBar *bar
); void gtk_header_bar_pack_start (GtkHeaderBar *bar
,GtkWidget *child
); void gtk_header_bar_pack_end (GtkHeaderBar *bar
,GtkWidget *child
); void gtk_header_bar_set_show_close_button (GtkHeaderBar *bar
,gboolean setting
); gboolean gtk_header_bar_get_show_close_button (GtkHeaderBar *bar
); void gtk_header_bar_set_decoration_layout (GtkHeaderBar *bar
,const gchar *layout
); const gchar * gtk_header_bar_get_decoration_layout (GtkHeaderBar *bar
);
"custom-title" GtkWidget* : Read / Write / Construct "decoration-layout" gchar* : Read / Write "decoration-layout-set" gboolean : Read / Write "has-subtitle" gboolean : Read / Write "show-close-button" gboolean : Read / Write "spacing" gint : Read / Write "subtitle" gchar* : Read / Write "title" gchar* : Read / Write
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.
GtkWidget * gtk_header_bar_new (void
);
Creates a new GtkHeaderBar widget.
Returns : |
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.
|
a GtkHeaderBar |
|
a title, or NULL . [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()
.
|
a GtkHeaderBar |
Returns : |
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. |
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
.
|
a GtkHeaderBar |
|
a subtitle, or NULL . [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()
.
|
a GtkHeaderBar |
Returns : |
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. |
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.
|
a GtkHeaderBar |
|
TRUE to reserve space for a subtitle |
Since 3.12
gboolean gtk_header_bar_get_has_subtitle (GtkHeaderBar *bar
);
|
a GtkHeaderBar |
Returns : |
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.
|
a GtkHeaderBar |
|
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()
.
|
a GtkHeaderBar |
Returns : |
the custom title widget
of the header, or NULL if none has been set explicitly. [transfer none]
|
Since 3.10
void gtk_header_bar_pack_start (GtkHeaderBar *bar
,GtkWidget *child
);
Adds child
to box
, packed with reference to the
start of the box
.
|
A GtkHeaderBar |
|
the GtkWidget to be added to bar
|
Since 3.10
void gtk_header_bar_pack_end (GtkHeaderBar *bar
,GtkWidget *child
);
Adds child
to box
, packed with reference to the
end of the box
.
|
A GtkHeaderBar |
|
the GtkWidget to be added to bar
|
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.
|
a GtkHeaderBar |
|
TRUE to show standard widow decorations |
Since 3.10
gboolean gtk_header_bar_get_show_close_button
(GtkHeaderBar *bar
);
Returns whether this header bar shows the standard window decorations.
|
a GtkHeaderBar |
Returns : |
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.
|
a GtkHeaderBar |
|
a decoration layout, or NULL to
unset the layout. [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()
.
|
a GtkHeaderBar |
Returns : |
the decoration layout |
Since 3.12
"custom-title"
property"custom-title" GtkWidget* : Read / Write / Construct
Custom title widget to display.
"decoration-layout"
property"decoration-layout" gchar* : Read / Write
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.
Default value: NULL
Since 3.12
"decoration-layout-set"
property"decoration-layout-set" gboolean : Read / Write
Set to TRUE
if "decoration-layout" is set.
Default value: FALSE
Since 3.12
"has-subtitle"
property"has-subtitle" gboolean : Read / Write
If TRUE
, reserve space for a subtitle, even if none
is currently set.
Default value: TRUE
Since 3.12
"show-close-button"
property"show-close-button" gboolean : Read / Write
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).
Default value: FALSE
"spacing"
property"spacing" gint : Read / Write
The amount of space between children.
Allowed values: >= 0
Default value: 6
"subtitle"
property"subtitle" gchar* : Read / Write
The subtitle to display.
Default value: NULL
"pack-type"
child property"pack-type" GtkPackType : Read / Write
A GtkPackType indicating whether the child is packed with reference to the start or end of the parent.
Default value: GTK_PACK_START
"position"
child property"position" gint : Read
The index of the child in the parent.
Allowed values: >= -1
Default value: 0