Handy.HeaderGroup¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gtk.Buildable (10)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`add_gtk_header_bar` (header_bar)
	`add_header_bar` (header_bar)
	`add_header_group` (header_group)
	`get_children` ()
	`get_decorate_all` ()
	`remove_child` (child)
	`remove_gtk_header_bar` (header_bar)
	`remove_header_bar` (header_bar)
	`remove_header_group` (header_group)
	`set_decorate_all` (decorate_all)

Virtual Methods¶

Inherited:: GObject.Object (7), Gtk.Buildable (10)

Properties¶

Name	Type	Flags	Short Description
`decorate-all`	`bool`	r/w/en	Whether the elements of the group should all receive the full decoration

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`update-decoration-layouts`	This signal is emitted before updating the decoration layouts.

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Handy.HeaderGroup(**kwargs)¶

Bases:: GObject.Object, Gtk.Buildable
Abstract:: No
Structure:: Handy.HeaderGroupClass

An object handling composite title bars.

The HdyHeaderGroup object handles the header bars of a composite title bar. It splits the window decoration across the header bars, giving the left side of the decorations to the leftmost header bar, and the right side of the decorations to the rightmost header bar. See [method`HeaderBar`.set_decoration_layout].

The [property`HeaderGroup`:py:data::decorate-all<Handy.HeaderGroup.props.decorate_all>] property can be used in conjunction with [property`Leaflet`:py:data::folded<Handy.HeaderGroup.props.folded>] when the title bar is split across the pages of a [class`Leaflet`] to automatically display the decorations on all the pages when the leaflet is folded.

You can nest header groups, which is convenient when you nest leaflets too:

```xml

</headerbars> </object>

</headerbars> </object> ```

New in version 1.0.

classmethod new()¶

Returns:: the newly created HdyHeaderGroup
Return type:: Handy.HeaderGroup

Creates a new HdyHeaderGroup.

New in version 1.0.

add_gtk_header_bar(header_bar)¶

Parameters:: header_bar (Gtk.HeaderBar) – the header bar to add

Adds header_bar to self.

When the widget is destroyed or no longer referenced elsewhere, it will be removed from the header group.

New in version 1.0.

add_header_bar(header_bar)¶

Parameters:: header_bar (Handy.HeaderBar) – the header bar to add

Adds header_bar to self.

When the widget is destroyed or no longer referenced elsewhere, it will be removed from the header group.

New in version 1.0.

add_header_group(header_group)¶

Parameters:: header_group (Handy.HeaderGroup) – the header group to add

Adds header_group to self.

When the nested group is no longer referenced elsewhere, it will be removed from the header group.

New in version 1.0.

get_children()¶

Returns:: the list of children
Return type:: [Handy.HeaderGroupChild]

Returns the list of children associated with self.

New in version 1.0.

get_decorate_all()¶

Returns:: whether the elements of the group should all receive the full decoration
Return type:: bool

Gets whether the elements of the group should all receive the full decoration.

New in version 1.0.

remove_child(child)¶

Parameters:: child (Handy.HeaderGroupChild) – the header group child to remove

Removes child from self.

New in version 1.0.

remove_gtk_header_bar(header_bar)¶

Parameters:: header_bar (Gtk.HeaderBar) – the header bar to remove

Removes header_bar from self.

New in version 1.0.

remove_header_bar(header_bar)¶

Parameters:: header_bar (Handy.HeaderBar) – the header bar to remove

Removes header_bar from self.

New in version 1.0.

remove_header_group(header_group)¶

Parameters:: header_group (Handy.HeaderGroup) – the header group to remove

Removes a nested HdyHeaderGroup from self.

New in version 1.0.

set_decorate_all(decorate_all)¶

Parameters:: decorate_all (bool) – whether the elements of the group should all receive the full decoration

Sets whether the elements of the group should all receive the full decoration.

New in version 1.0.

Signal Details¶

Handy.HeaderGroup.signals.update_decoration_layouts(header_group)¶

Signal Name:: update-decoration-layouts
Flags:: RUN_LAST
Parameters:: header_group (Handy.HeaderGroup) – The object which received the signal

This signal is emitted before updating the decoration layouts.

New in version 1.0.

Property Details¶

Handy.HeaderGroup.props.decorate_all¶

Name:: decorate-all
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the elements of the group should all receive the full decoration.

This is useful in conjunction with [property`Leaflet`:py:data::folded<Handy.HeaderGroup.props.folded>] when the leaflet contains the header bars of the group, as you want them all to display the complete decoration when the leaflet is folded.

New in version 1.0.