HeaderBar
Object Hierarchy:
Description:
[ Version ( since = "1.0" ) ]
public class HeaderBar : Container, Implementor, Buildable
A title bar widget.
`HdyHeaderBar` is similar to [class@Gtk.HeaderBar] but is designed to fix some of its shortcomings for adaptive applications.
`HdyHeaderBar` doesn't force the custom title widget to be vertically centered, hence allowing it to fill up the whole height, which is e.g. needed for [class@ViewSwitcher].
When used in a mobile dialog, `HdyHeaderBar` will replace its window decorations by a back button allowing to close it. It doesn't have to be its direct child and you can use any complex contraption you like as the dialog's titlebar.
`HdyHeaderBar` can be used in window's content area rather than titlebar, and will still be draggable and will handle right click, middle click and double click as expected from a titlebar. This is particularly useful with [class@Window] or [class@ApplicationWindow].
CSS nodes
`HdyHeaderBar` has a single CSS node with name `headerbar`.
Content:
Properties:
- public CenteringPolicy centering_policy { get; set; }
The policy for aligning the center widget.
- public Widget custom_title { get; set; }
Custom title widget to display.
- public string decoration_layout { get; set; }
The decoration layout for buttons.
- public bool decoration_layout_set { get; set; }
Whether [property@HeaderBar:decoration-layout] is set.
- public bool has_subtitle { get; set; }
Whether to reserve space for a subtitle, even if none is currently set.
- public bool interpolate_size { get; set; }
Whether the size should smoothly change when changing between children.
- public bool show_close_button { get; set; }
Whether to show window decorations.
- public int spacing { get; set; }
The amount of space between children.
- public string subtitle { get; set; }
The subtitle to display.
- public string title { get; set; }
The title to display.
- public uint transition_duration { get; set; }
The transition duration, in milliseconds.
- public bool transition_running { get; }
Whether or not the transition is currently running.
Creation methods:
- public HeaderBar ()
Creates a new `HdyHeaderBar`.
Methods:
- public CenteringPolicy get_centering_policy ()
Gets the policy this follows to horizontally align its center widget.
- public unowned Widget? get_custom_title ()
Retrieves the custom title widget of the header.
- public unowned string get_decoration_layout ()
Gets the decoration layout.
- public bool get_has_subtitle ()
Gets whether space is reserved for a subtitle, regardless if one is currently set or not.
- public bool get_interpolate_size ()
Gets whether this should interpolate its size on visible child change.
- public bool get_show_close_button ()
Gets whether this header bar shows the standard window decorations.
- public unowned string? get_subtitle ()
Gets the subtitle of the header.
- public unowned string? get_title ()
Retrieves the title of the header.
- public uint get_transition_duration ()
Gets the amount of time that transitions between pages will take.
- public bool get_transition_running ()
Gets whether the this is currently in a transition from one page to another.
- public void pack_end (Widget child)
Adds
child
to this, packed with reference to the end of the this. - public void pack_start (Widget child)
Adds
child
to this, packed with reference to the start of the this. - public void set_centering_policy (CenteringPolicy centering_policy)
Sets the policy this must follow to horizontally align its center widget.
- public void set_custom_title (Widget? title_widget)
Sets a custom title for the header bar.
- public void set_decoration_layout (string? layout)
Sets the decoration layout for this header bar.
- public void set_has_subtitle (bool setting)
Sets whether space is reserved for a subtitle, even if none is currently set.
- public void set_interpolate_size (bool interpolate_size)
Sets whether this should interpolate its size on visible child change.
- public void set_show_close_button (bool setting)
Sets whether this header bar shows the standard window decorations.
- public void set_subtitle (string? subtitle)
Sets the subtitle of the header bar.
- public void set_title (string? title)
Sets the title of the [class@HeaderBar].
- public void set_transition_duration (uint duration)
Sets the duration that transitions between pages will take.
Inherited Members:
- accel_closures_changed
- activate
- add_accelerator
- add_device_events
- add_events
- add_mnemonic_label
- add_tick_callback
- adjust_baseline_allocation
- adjust_baseline_request
- adjust_size_allocation
- adjust_size_request
- app_paintable
- bind_template_callback_full
- bind_template_child_full
- button_press_event
- button_release_event
- can_activate_accel
- can_default
- can_focus
- child_focus
- child_notify
- class_path
- composite_child
- composited_changed
- compute_expand
- compute_expand_internal
- configure_event
- create_pango_context
- create_pango_layout
- damage_event
- delete_event
- destroy
- destroy_event
- destroyed
- device_is_shadowed
- direction_changed
- dispatch_child_properties_changed
- double_buffered
- drag_begin
- drag_data_delete
- drag_data_get
- drag_data_received
- drag_drop
- drag_end
- drag_failed
- drag_leave
- drag_motion
- draw
- draw_to_cairo_context
- ensure_style
- enter_notify_event
- error_bell
- event
- event_after
- events
- expand
- find_style_property
- focus
- focus_in_event
- focus_on_click
- focus_out_event
- freeze_child_notify
- get_accessible
- get_action_group
- get_allocated_baseline
- get_allocated_height
- get_allocated_size
- get_allocated_width
- get_allocation
- get_ancestor
- get_app_paintable
- get_can_default
- get_can_focus
- get_child_requisition
- get_child_visible
- get_clip
- get_clipboard
- get_composite_name
- get_css_name
- get_default_direction
- get_default_style
- get_device_enabled
- get_device_events
- get_direction
- get_display
- get_double_buffered
- get_events
- get_focus_on_click
- get_font_map
- get_font_options
- get_frame_clock
- get_halign
- get_has_tooltip
- get_has_window
- get_hexpand
- get_hexpand_set
- get_mapped
- get_margin_bottom
- get_margin_end
- get_margin_left
- get_margin_right
- get_margin_start
- get_margin_top
- get_modifier_mask
- get_modifier_style
- get_no_show_all
- get_opacity
- get_pango_context
- get_parent
- get_parent_window
- get_path
- get_pointer
- get_preferred_height
- get_preferred_height_and_baseline_for_width
- get_preferred_height_for_width
- get_preferred_height_for_width_internal
- get_preferred_height_internal
- get_preferred_size
- get_preferred_width
- get_preferred_width_for_height
- get_preferred_width_for_height_internal
- get_preferred_width_internal
- get_realized
- get_receives_default
- get_request_mode
- get_requisition
- get_root_window
- get_scale_factor
- get_screen
- get_sensitive
- get_settings
- get_size_request
- get_state
- get_state_flags
- get_style
- get_style_context
- get_support_multidevice
- get_template_child
- get_tooltip_markup
- get_tooltip_text
- get_tooltip_window
- get_toplevel
- get_valign
- get_valign_with_baseline
- get_vexpand
- get_vexpand_set
- get_visible
- get_visual
- get_window
- grab_broken_event
- grab_default
- grab_focus
- grab_notify
- halign
- has_default
- has_focus
- has_grab
- has_rc_style
- has_screen
- has_tooltip
- has_visible_focus
- height_request
- hexpand
- hexpand_set
- hide
- hide_on_delete
- hierarchy_changed
- in_destruction
- init_template
- input_shape_combine_region
- insert_action_group
- install_style_property
- install_style_property_parser
- intersect
- is_ancestor
- is_composited
- is_drawable
- is_focus
- is_sensitive
- is_toplevel
- is_visible
- key_press_event
- key_release_event
- keynav_failed
- leave_notify_event
- list_accel_closures
- list_action_prefixes
- list_mnemonic_labels
- list_style_properties
- map
- map_event
- margin
- margin_bottom
- margin_end
- margin_left
- margin_right
- margin_start
- margin_top
- mnemonic_activate
- modify_base
- modify_bg
- modify_cursor
- modify_fg
- modify_font
- modify_style
- modify_text
- motion_notify_event
- move_focus
- name
- no_show_all
- opacity
- override_background_color
- override_color
- override_cursor
- override_font
- override_symbolic_color
- parent
- parent_set
- path
- pop_composite_child
- popup_menu
- property_notify_event
- proximity_in_event
- proximity_out_event
- push_composite_child
- query_tooltip
- queue_allocate
- queue_compute_expand
- queue_draw
- queue_draw_area
- queue_draw_region
- queue_resize
- queue_resize_no_redraw
- realize
- receives_default
- region_intersect
- register_window
- remove_accelerator
- remove_mnemonic_label
- remove_tick_callback
- render_icon
- render_icon_pixbuf
- reparent
- reset_rc_styles
- reset_style
- scale_factor
- screen_changed
- scroll_event
- selection_clear_event
- selection_get
- selection_notify_event
- selection_received
- selection_request_event
- send_expose
- send_focus_change
- sensitive
- set_accel_path
- set_accessible_role
- set_accessible_type
- set_allocation
- set_app_paintable
- set_can_default
- set_can_focus
- set_child_visible
- set_clip
- set_composite_name
- set_connect_func
- set_css_name
- set_default_direction
- set_device_enabled
- set_device_events
- set_direction
- set_double_buffered
- set_events
- set_focus_on_click
- set_font_map
- set_font_options
- set_halign
- set_has_tooltip
- set_has_window
- set_hexpand
- set_hexpand_set
- set_mapped
- set_margin_bottom
- set_margin_end
- set_margin_left
- set_margin_right
- set_margin_start
- set_margin_top
- set_no_show_all
- set_opacity
- set_parent
- set_parent_window
- set_realized
- set_receives_default
- set_redraw_on_allocate
- set_sensitive
- set_size_request
- set_state
- set_state_flags
- set_style
- set_support_multidevice
- set_template
- set_template_from_resource
- set_tooltip_markup
- set_tooltip_text
- set_tooltip_window
- set_valign
- set_vexpand
- set_vexpand_set
- set_visible
- set_visual
- set_window
- shape_combine_region
- show
- show_all
- show_help
- show_now
- size_allocate
- size_allocate_with_baseline
- size_request
- state_changed
- state_flags_changed
- style
- style_attach
- style_get
- style_get_property
- style_get_valist
- style_set
- style_updated
- thaw_child_notify
- tooltip_markup
- tooltip_text
- touch_event
- translate_coordinates
- trigger_tooltip_query
- unmap
- unmap_event
- unparent
- unrealize
- unregister_window
- unset_state_flags
- valign
- vexpand
- vexpand_set
- visibility_notify_event
- visible
- width_request
- window_state_event