Class: Gtk::HeaderBar

Inherits:
Widget
  • Object
show all
Defined in:
(unknown)

Overview

GtkHeaderBar is a widget for creating custom title bars for windows.

An example GtkHeaderBar

GtkHeaderBar is similar to a horizontal GtkCenterBox. It allows children to be placed at the start or the end. In addition, it allows the window title 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.

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

GtkHeaderBar as GtkBuildable

The GtkHeaderBar implementation of the GtkBuildable interface supports adding children at the start or end sides by specifying “start” or “end” as the “type” attribute of a <child> element, or setting the title widget by specifying “title” value.

By default the GtkHeaderBar uses a GtkLabel displaying the title of the window it is contained in as the title widget, equivalent to the following UI definition:

<object class="GtkHeaderBar">
  <property name="title-widget">
    <object class="GtkLabel">
      <property name="label" translatable="yes">Label</property>
      <property name="single-line-mode">True</property>
      <property name="ellipsize">end</property>
      <property name="width-chars">5</property>
      <style>
        <class name="title"/>
      </style>
    </object>
  </property>
</object>

CSS nodes

headerbar
╰── windowhandle
    ╰── box
        ├── box.start
        │   ├── windowcontrols.start
        │   ╰── [other children]
        ├── [Title Widget]
        ╰── box.end
            ├── [other children]
            ╰── windowcontrols.end

A GtkHeaderBar's CSS node is called headerbar. It contains a windowhandle subnode, which contains a box subnode, which contains two box subnodes at the start and end of the header bar, as well as a center node that represents the title.

Each of the boxes contains a windowcontrols subnode, see [classGtk.WindowControls] for details, as well as other children.

Accessibility

GtkHeaderBar uses the %GTK_ACCESSIBLE_ROLE_GROUP role.

Instance Method Summary collapse

Methods inherited from Widget

#accessible_role, #accessible_role=, #action_set_enabled, #activate, #activate_action, #activate_action_variant, #activate_default, #activate_signal, #activate_signal=, #activate_signal_from_name=, #add_binding, #add_binding_action, #add_binding_signal, #add_controller, #add_css_class, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child_full, #can_focus, #can_focus=, #can_focus?, #can_target, #can_target=, #can_target?, #child_focus, #child_visible, #child_visible=, #clipboard, #compute_bounds, #compute_expand, #compute_point, #compute_transform, #contains, #create_pango_context, #create_pango_layout, #css_classes, #css_classes=, #css_name, #css_name=, #cursor, #cursor=, #cursor_from_name=, default_direction, default_direction=, #direction, #direction=, #display, #dispose_template, #drag_check_threshold, #error_bell, #first_child, #focus_child, #focus_child=, #focus_on_click, #focus_on_click=, #focus_on_click?, #focusable, #focusable=, #focusable?, #font_map, #font_map=, #font_options, #font_options=, #frame_clock, #get_allocation, #get_ancestor, #get_color, #get_preferred_size, #get_size, #get_size_request, #get_template_child, #grab_focus, #halign, #halign=, #has_css_class, #has_default, #has_default=, #has_default?, #has_focus, #has_focus=, #has_focus?, #has_tooltip, #has_tooltip=, #has_tooltip?, #has_visible_focus, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_after, #insert_before, #install_action, #install_property_action, #is_ancestor, #is_drawable, #is_focus, #is_sensitive, #is_visible, #keynav_failed, #last_child, #layout_manager, #layout_manager=, #layout_manager_type, #layout_manager_type=, #list_mnemonic_labels, #map, #mapped, #margin_bottom, #margin_bottom=, #margin_end, #margin_end=, #margin_start, #margin_start=, #margin_top, #margin_top=, #measure, #mnemonic_activate, #name, #name=, #native, #next_sibling, #observe_children, #observe_controllers, #opacity, #opacity=, #overflow, #overflow=, #pango_context, #parent, #parent=, #pick, #prev_sibling, #primary_clipboard, #query_action, #queue_allocate, #queue_draw, #queue_resize, #realize, #realized, #receives_default, #receives_default=, #receives_default?, #remove_controller, #remove_css_class, #remove_mnemonic_label, #remove_tick_callback, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_size_request, #set_state_flags, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #template=, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #trigger_tooltip_query, #unmap, #unparent, #unrealize, #unset_state_flags, #valign, #valign=, #vexpand, #vexpand=, #vexpand?, #vexpand_set, #vexpand_set=, #vexpand_set?, #visible, #visible=, #visible?, #width, #width_request, #width_request=

Constructor Details

#initialize ⇒ Gtk::Widget

Creates a new GtkHeaderBar widget.

Instance Method Details

#decoration_layout ⇒ String

The decoration layout for buttons.

If this property is not set, the [propertyGtk.Settings:gtk-decoration-layout] setting is used.

Returns:

  • (String) —

    decoration-layout

#decoration_layout=(decoration_layout) ⇒ String

The decoration layout for buttons.

If this property is not set, the [propertyGtk.Settings:gtk-decoration-layout] setting is used.

Parameters:

  • decoration_layout (String)

Returns:

  • (String) —

    decoration-layout

  • (String) —

    decoration-layout

#pack_end(child) ⇒ nil

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

Parameters:

  • child (Gtk::Widget) —

    the GtkWidget to be added to bar

Returns:

  • (nil)

#pack_start(child) ⇒ nil

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

Parameters:

  • child (Gtk::Widget) —

    the GtkWidget to be added to bar

Returns:

  • (nil)

#remove(child) ⇒ nil

Removes a child from the GtkHeaderBar.

The child must have been added with [methodGtk.HeaderBar.pack_start], [methodGtk.HeaderBar.pack_end] or [methodGtk.HeaderBar.set_title_widget].

Parameters:

Returns:

  • (nil)

#show_title_buttons ⇒ Boolean

Returns whether this header bar shows the standard window title buttons.

Returns:

  • (Boolean) —

    true if title buttons are shown

#show_title_buttons=(show_title_buttons) ⇒ Boolean

Whether to show title buttons like close, minimize, maximize.

Which buttons are actually shown and where is determined by the [propertyGtk.HeaderBar:decoration-layout] property, and by the state of the window (e.g. a close button will not be shown if the window can't be closed).

Parameters:

  • show_title_buttons (Boolean)

Returns:

  • (Boolean) —

    show-title-buttons

  • (Boolean) —

    show-title-buttons

#show_title_buttons? ⇒ Boolean

Whether to show title buttons like close, minimize, maximize.

Which buttons are actually shown and where is determined by the [propertyGtk.HeaderBar:decoration-layout] property, and by the state of the window (e.g. a close button will not be shown if the window can't be closed).

Returns:

  • (Boolean) —

    show-title-buttons

#title_widget ⇒ Gtk::Widget

Returns title-widget.

Returns:

#title_widget=(title_widget) ⇒ Gtk::Widget

Parameters:

Returns: