HeaderBar

GtkHeaderBar is similar to a horizontal gtk.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 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 gtk.Window (see Window.setTitlebar), as it gives features typical of titlebars while allowing the addition of child widgets.

Constructors

this
this(GtkHeaderBar* gtkHeaderBar, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new gtk.HeaderBar widget.

Members

Functions

getCustomTitle
Widget getCustomTitle()

Retrieves the custom title widget of the header. See HeaderBar.setCustomTitle.

getDecorationLayout
string getDecorationLayout()

Gets the decoration layout set with HeaderBar.setDecorationLayout.

getHasSubtitle
bool getHasSubtitle()

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

getHeaderBarStruct
GtkHeaderBar* getHeaderBarStruct(bool transferOwnership)

Get the main Gtk struct

getShowCloseButton
bool getShowCloseButton()

Returns whether this header bar shows the standard window decorations.

getStruct
void* getStruct()

the main Gtk struct as a void*

getSubtitle
string getSubtitle()

Retrieves the subtitle of the header. See HeaderBar.setSubtitle.

getTitle
string getTitle()

Retrieves the title of the header. See HeaderBar.setTitle.

packEnd
void packEnd(Widget child)

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

packStart
void packStart(Widget child)

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

setCustomTitle
void setCustomTitle(Widget titleWidget)

Sets a custom title for the gtk.HeaderBar

setDecorationLayout
void setDecorationLayout(string layout)

Sets the decoration layout for this header bar, overriding the 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 gtk.HeaderBar 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 gtk.HeaderBar The title should help a user identify the current view. A good title should not include the application name.

Static functions

getType
GType getType()

Variables

gtkHeaderBar
GtkHeaderBar* gtkHeaderBar;

the main Gtk struct

Inherited Members

From Container

gtkContainer
GtkContainer* gtkContainer;

the main Gtk struct

getContainerStruct
GtkContainer* getContainerStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

removeAll
void removeAll()

Removes all widgets from the container

getType
GType getType()
add
void add(Widget widget)

Adds widget to container. Typically used for simple containers such as gtk.Window, gtk.Frame, or gtk.Button; for more complicated layout containers such as gtk.Box or gtk.Grid, this function will pick default packing parameters that may not be correct. So consider functions such as Box.packStart and Grid.attach as an alternative to 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(Widget child, string propertyName, Value value)

Gets the value of a child property for child and container.

childGetValist
void childGetValist(Widget child, string firstPropertyName, void* varArgs)

Gets the values of one or more child properties for child and container.

childNotify
void childNotify(Widget child, string childProperty)

Emits a child-notify signal for the [child property][child-properties] child_property on the child.

childNotifyByPspec
void childNotifyByPspec(Widget child, ParamSpec pspec)

Emits a child-notify signal for the [child property][child-properties] specified by pspec on the child.

childSetProperty
void childSetProperty(Widget child, string propertyName, Value value)

Sets a child property for child and container.

childSetValist
void childSetValist(Widget child, string firstPropertyName, void* varArgs)

Sets one or more child properties for child and container.

childType
GType childType()

Returns the type of the children supported by the container.

forall
void forall(GtkCallback callback, void* callbackData)

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_(GtkCallback callback, void* callbackData)

Invokes callback on each non-internal child of container. See 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 Container.setBorderWidth.

getChildren
ListG getChildren()

Returns the container’s non-internal children. See Container.forall for details on what constitutes an "internal" child.

getFocusChain
bool getFocusChain(ListG 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
Widget getFocusChild()

Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling Window.getFocus.

getFocusHadjustment
Adjustment getFocusHadjustment()

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().

getFocusVadjustment
Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See Container.setFocusVadjustment.

getPathForChild
WidgetPath getPathForChild(Widget child)

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.

getResizeMode
GtkResizeMode getResizeMode()

Returns the resize mode for the container. See gtk_container_set_resize_mode ().

propagateDraw
void propagateDraw(Widget child, Context cr)

When a container receives a call to the draw function, it must send synthetic draw calls to all children that don’t have their own gdk.Windows This function provides a convenient way of doing this. A container, when it receives a call to its draw function, calls Container.propagateDraw once for each child, passing in the cr the container received.

remove
void remove(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 g_object_ref(). If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using 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(ListG focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+.

setFocusChild
void setFocusChild(Widget child)

Sets, or unsets if child is NULL, the focused child of container.

setFocusHadjustment
void setFocusHadjustment(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 ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and Container.setFocusVadjustment for setting the vertical adjustment.

setFocusVadjustment
void setFocusVadjustment(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 ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and 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(GtkResizeMode resizeMode)

Sets the resize mode for the container.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with Container.setFocusChain.

addOnAdd
gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnCheckResize
gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
addOnRemove
gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnSetFocusChild
gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)