Class header-bar - cl-cffi-gtk3 API documentation

Package: gtk

Class gtk:header-bar

Superclasses

gtk:container, gtk:widget, gtk:buildable, gobject:object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

custom-title

The custom-title property of type gtk:widget (Read / Write / Construct)
The custom title widget to display.

decoration-layout

The decoration-layout property of type :string (Read / Write / Construct)
The decoration layout for buttons. If this property is not set, the gtk-decoration-layout setting is used. See the gtk:header-bar-decoration-layout function for information about the format of this string.
Default value: nil

decoration-layout-set

The decoration-layout-set property of type :boolean (Read / Write)
Set to true if the decoration-layout property is set.
Default value: false

has-subtitle

The has-subtitle property of type :boolean (Read / Write)
If true, reserve space for a subtitle, even if none is currently set.
Default value: true

show-close-button

The show-close-button property of type :boolean (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, for example a Close button will not be shown if the window can not be closed.
Default value: false

spacing

The spacing property of type :int (Read / Write)
The amount of space between children.
Allowed values: >= 0
Default value: 6

subtitle

The subtitle property of type :string (Read / Write)
The subtitle to display.
Default value: nil

title

The title property of type :string (Read / Write)
The title to display.
Default value: nil

Details

The gtk:header-bar widget is similar to a horizontal gtk:box widget. It allows children to be placed at the start or the end. In addition, it allows a title and subtitle to be displayed.

Figure: GtkHeaderBar

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 the gtk:header-bar-has-subtitle function.

The gtk:header-bar widget can add typical window frame controls, such as Minimize, Maximize and Close buttons, or the window icon.

Child Property Details

pack-type

The pack-type child property of type gtk:pack-type (Read / Write)
Whether the child is packed with reference to the start or end of the parent.
Default value: :start

position

The position child property of type :int (Read / Write)
The index of the child widget in the parent.
Allowed values: >= -1
Default value: 0

Class gtk:header-bar

Superclasses

Documented Subclasses

Direct Slots

Details

Child Property Details

Returned by

Slot Access Functions

Inherited Slot Access Functions

See also