HeaderBar

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_header_bar_get_type ()" ) ]
public class HeaderBar : Container, Implementor, Buildable

GtkHeaderBar is similar to a horizontal Box.

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 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 Window (see set_titlebar ), as it gives features typical of titlebars while allowing the addition of child widgets.

Namespace: Gtk

Package: gtk+-3.0

Content:

Properties:

public Widget custom_title { get; set; }
public string decoration_layout { get; set; }
The decoration layout for buttons.
public bool decoration_layout_set { get; set; }
Set to true if decoration_layout is set.
public bool has_subtitle { get; set; }
If true, reserve space for a subtitle, even if none is currently set.
public bool show_close_button { get; set; }
Whether to show window decorations.
public int spacing { get; set; }
public string subtitle { get; set; }
public string title { get; set; }

Creation methods:

public HeaderBar ()
Creates a new HeaderBar widget.

Methods:

public unowned Widget? get_custom_title ()
Retrieves the custom title widget of the header.
public unowned string get_decoration_layout ()
Gets the decoration layout set with set_decoration_layout.
public bool get_has_subtitle ()
Retrieves whether the header bar reserves space for a subtitle, regardless if one is currently set or not.
public bool get_show_close_button ()
Returns whether this header bar shows the standard window decorations.
public unowned string? get_subtitle ()
Retrieves the subtitle of the header.
public unowned string? get_title ()
Retrieves the title of the header.
public void pack_end (Widget child)
Adds child to this, packed with reference to the end of the this.
public void pack_start (Widget child)
Adds child to this, packed with reference to the start of the this.
public void set_custom_title (Widget? title_widget)
Sets a custom title for the HeaderBar.
public void set_decoration_layout (string? layout)
Sets the decoration layout for this header bar, overriding the gtk_decoration_layout setting.
public void set_has_subtitle (bool setting)
Sets whether the header bar should reserve space for a subtitle, even if none is currently set.
public void set_show_close_button (bool setting)
Sets whether this header bar shows the standard window decorations, including close, maximize, and minimize.
public void set_subtitle (string? subtitle)
Sets the subtitle of the HeaderBar.
public void set_title (string? title)
Sets the title of the HeaderBar.

Inherited Members:

All known members inherited from class Gtk.Container

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Atk.Implementor

ref_accessible

All known members inherited from interface Gtk.Buildable