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_set_has_subtitle().

GtkHeaderBar can add typical window frame controls, such as minimize, maximize and close buttons, or the window icon.

Constructors

this this(GtkHeaderBar* gtkHeaderBar, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new #GtkHeaderBar widget.

Members

Functions

getCustomTitle Widget getCustomTitle(): Retrieves the custom title widget of the header. See gtk_header_bar_set_custom_title().
getDecorationLayout string getDecorationLayout(): Gets the decoration layout set with gtk_header_bar_set_decoration_layout().
getHasSubtitle bool getHasSubtitle(): Retrieves whether the header bar reserves space for a subtitle, regardless if one is currently set or not.
getHeaderBarStruct GtkHeaderBar* getHeaderBarStruct(): 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 gtk_header_bar_set_subtitle().
getTitle string getTitle(): Retrieves the title of the header. See gtk_header_bar_set_title().
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 #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.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
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.

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(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
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 #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_pack_start() and gtk_grid_attach() as an alternative to gtk_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 #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on the child.
childNotifyByPspec void childNotifyByPspec(Widget child, ParamSpec pspec): Emits a #GtkWidget::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.
foreac void foreac(GtkCallback callback, void* callbackData): Invokes @callback on each non-internal child of @container. See gtk_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_set_border_width().
getChildren ListG getChildren(): Returns the container’s non-internal children. See gtk_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 gtk_window_get_focus().
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 gtk_container_set_focus_vadjustment().
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 #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_propagate_draw() 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 gtk_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 gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() 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 gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() 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 gtk_container_set_focus_chain().
connectedSignals int[string] connectedSignals;: Undocumented in source.
onAddListeners void delegate(Widget, Container)[] onAddListeners;: Undocumented in source.
addOnAdd void addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackAdd void callBackAdd(GtkContainer* containerStruct, GtkWidget* object, Container _container): Undocumented in source. Be warned that the author may not have intended to support it.
onCheckResizeListeners void delegate(Container)[] onCheckResizeListeners;: Undocumented in source.
addOnCheckResize void addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
callBackCheckResize void callBackCheckResize(GtkContainer* containerStruct, Container _container): Undocumented in source. Be warned that the author may not have intended to support it.
onRemoveListeners void delegate(Widget, Container)[] onRemoveListeners;: Undocumented in source.
addOnRemove void addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackRemove void callBackRemove(GtkContainer* containerStruct, GtkWidget* object, Container _container): Undocumented in source. Be warned that the author may not have intended to support it.
onSetFocusChildListeners void delegate(Widget, Container)[] onSetFocusChildListeners;: Undocumented in source.
addOnSetFocusChild void addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackSetFocusChild void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* object, Container _container): Undocumented in source. Be warned that the author may not have intended to support it.