HeaderBar

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.HeaderBar.setHasSubtitle.

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

class HeaderBar : Container {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

HeaderBar self();

static HeaderBarGidBuilder builder();

gtk.widget.Widget customTitle [@property getter];

gtk.widget.Widget customTitle [@property setter];

string decorationLayout [@property getter];

string decorationLayout [@property setter];

bool decorationLayoutSet [@property getter];

bool decorationLayoutSet [@property setter];

bool hasSubtitle [@property getter];

bool hasSubtitle [@property setter];

bool showCloseButton [@property getter];

bool showCloseButton [@property setter];

int spacing [@property getter];

int spacing [@property setter];

string subtitle [@property getter];

string subtitle [@property setter];

string title [@property getter];

string title [@property setter];

this();

gtk.widget.Widget getCustomTitle();

string getDecorationLayout();

bool getHasSubtitle();

bool getShowCloseButton();

string getSubtitle();

string getTitle();

void packEnd(gtk.widget.Widget child);

void packStart(gtk.widget.Widget child);

void setCustomTitle(gtk.widget.Widget titleWidget);

void setDecorationLayout(string layout);

void setHasSubtitle(bool setting);

void setShowCloseButton(bool setting);

void setSubtitle(string subtitle);

void setTitle(string title);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkHeaderBar widget.

Members

Functions

getCustomTitle gtk.widget.Widget getCustomTitle(): Retrieves the custom title widget of the header. See gtk.header_bar.HeaderBar.setCustomTitle.
getDecorationLayout string getDecorationLayout(): Gets the decoration layout set with gtk.header_bar.HeaderBar.setDecorationLayout.
getHasSubtitle bool getHasSubtitle(): Retrieves whether the header bar reserves space for a subtitle, regardless if one is currently set or not.
getShowCloseButton bool getShowCloseButton(): Returns whether this header bar shows the standard window decorations.
getSubtitle string getSubtitle(): Retrieves the subtitle of the header. See gtk.header_bar.HeaderBar.setSubtitle.
getTitle string getTitle(): Retrieves the title of the header. See gtk.header_bar.HeaderBar.setTitle.
packEnd void packEnd(gtk.widget.Widget child): Adds child to bar, packed with reference to the end of the bar.
packStart void packStart(gtk.widget.Widget child): Adds child to bar, packed with reference to the start of the bar.
self HeaderBar self(): Returns this, for use in with statements.
setCustomTitle void setCustomTitle(gtk.widget.Widget titleWidget): Sets a custom title for the #GtkHeaderBar.
setDecorationLayout void setDecorationLayout(string layout): Sets the decoration layout for this header bar, overriding the #GtkSettings:gtk-decoration-layout setting.
setHasSubtitle void setHasSubtitle(bool setting): Sets whether the header bar should reserve space for a subtitle, even if none is currently set.
setShowCloseButton void setShowCloseButton(bool setting): Sets whether this header bar shows the standard window decorations, including close, maximize, and minimize.
setSubtitle void setSubtitle(string subtitle): Sets the subtitle of the #GtkHeaderBar. The title should give a user an additional detail to help him identify the current view.
setTitle void setTitle(string 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.

Properties

_gType GType _gType [@property getter]
customTitle gtk.widget.Widget customTitle [@property getter]
customTitle gtk.widget.Widget customTitle [@property setter]
decorationLayout string decorationLayout [@property getter]: Get decorationLayout property.
decorationLayout string decorationLayout [@property setter]: Set decorationLayout property.
decorationLayoutSet bool decorationLayoutSet [@property getter]: Get decorationLayoutSet property.
decorationLayoutSet bool decorationLayoutSet [@property setter]: Set decorationLayoutSet property.
hasSubtitle bool hasSubtitle [@property getter]: Get hasSubtitle property.
hasSubtitle bool hasSubtitle [@property setter]: Set hasSubtitle property.
showCloseButton bool showCloseButton [@property getter]: Get showCloseButton property.
showCloseButton bool showCloseButton [@property setter]: Set showCloseButton property.
spacing int spacing [@property getter]
spacing int spacing [@property setter]
subtitle string subtitle [@property getter]
subtitle string subtitle [@property setter]
title string title [@property getter]
title string title [@property setter]

Static functions

_getGType GType _getGType()
builder HeaderBarGidBuilder builder(): Get builder for gtk.header_bar.HeaderBar

Inherited Members

From Container

_getGType GType _getGType()
_gType GType _gType [@property getter]
self Container self(): Returns this, for use in with statements.
builder ContainerGidBuilder builder(): Get builder for gtk.container.Container
borderWidth uint borderWidth [@property getter]
borderWidth uint borderWidth [@property setter]
child gtk.widget.Widget child [@property setter]
resizeMode gtk.types.ResizeMode resizeMode [@property getter]
resizeMode gtk.types.ResizeMode resizeMode [@property setter]
add void add(gtk.widget.Widget widget): Adds widget to container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk.box.Box.packStart and gtk.grid.Grid.attach as an alternative to gtk.container.Container.add in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.
checkResize void checkResize()
childGetProperty void childGetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value): Gets the value of a child property for child and container.
childNotify void childNotify(gtk.widget.Widget child, string childProperty): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] child_property on the child.
childNotifyByPspec void childNotifyByPspec(gtk.widget.Widget child, gobject.param_spec.ParamSpec pspec): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by pspec on the child.
childSetProperty void childSetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value): Sets a child property for child and container.
childType gobject.types.GType childType(): Returns the type of the children supported by the container.
forall void forall(gtk.types.Callback callback): Invokes callback on each direct child of container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.
foreach_ void foreach_(gtk.types.Callback callback): Invokes callback on each non-internal child of container. See gtk.container.Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.
getBorderWidth uint getBorderWidth(): Retrieves the border width of the container. See gtk.container.Container.setBorderWidth.
getChildren gtk.widget.Widget[] getChildren(): Returns the container’s non-internal children. See gtk.container.Container.forall for details on what constitutes an "internal" child.
getFocusChain bool getFocusChain(gtk.widget.Widget[] focusableWidgets): Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores null in focusable_widgets and returns false.
getFocusChild gtk.widget.Widget getFocusChild(): Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk.window.Window.getFocus.
getFocusHadjustment gtk.adjustment.Adjustment getFocusHadjustment(): Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
getFocusVadjustment gtk.adjustment.Adjustment getFocusVadjustment(): Retrieves the vertical focus adjustment for the container. See gtk.container.Container.setFocusVadjustment.
getPathForChild gtk.widget_path.WidgetPath getPathForChild(gtk.widget.Widget child): Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.
getResizeMode gtk.types.ResizeMode getResizeMode(): Returns the resize mode for the container. See gtk_container_set_resize_mode ().
propagateDraw void propagateDraw(gtk.widget.Widget child, cairo.context.Context cr): When a container receives a call to the draw function, it must send synthetic #GtkWidget::draw calls to all children that don’t have their own #GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its #GtkWidget::draw function, calls gtk.container.Container.propagateDraw once for each child, passing in the cr the container received.
remove void remove(gtk.widget.Widget widget): Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it before removing it from a container, using gobject.object.ObjectWrap.ref_. If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using gtk.widget.Widget.destroy since this will remove it from the container and help break any circular reference count cycles.
resizeChildren void resizeChildren()
setBorderWidth void setBorderWidth(uint borderWidth): Sets the border width of the container.
setFocusChain void setFocusChain(gtk.widget.Widget[] focusableWidgets): Sets a focus chain, overriding the one computed automatically by GTK+.
setFocusChild void setFocusChild(gtk.widget.Widget child): Sets, or unsets if child is null, the focused child of container.
setFocusHadjustment void setFocusHadjustment(gtk.adjustment.Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk.scrolled_window.ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusVadjustment for setting the vertical adjustment.
setFocusVadjustment void setFocusVadjustment(gtk.adjustment.Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk.scrolled_window.ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusHadjustment for setting the horizontal adjustment.
setReallocateRedraws void setReallocateRedraws(bool needsRedraws): Sets the reallocate_redraws flag of the container to the given value.
setResizeMode void setResizeMode(gtk.types.ResizeMode resizeMode): Sets the resize mode for the container.
unsetFocusChain void unsetFocusChain(): Removes a focus chain explicitly set with gtk.container.Container.setFocusChain.
connectAdd gulong connectAdd(T callback, Flag!"After" after): Connect to Add signal.
connectCheckResize gulong connectCheckResize(T callback, Flag!"After" after): Connect to CheckResize signal.
connectRemove gulong connectRemove(T callback, Flag!"After" after): Connect to Remove signal.
connectSetFocusChild gulong connectSetFocusChild(T callback, Flag!"After" after): Connect to SetFocusChild signal.

gtk header_bar classes