RB.DisplayPageGroup¶

Page groups define sections of the display page tree. A page group consists of an internal name, a display name, and a category. The internal name can be used to locate a registered page group. The category is used to sort the page groups.

While RB.DisplayPageGroup is a subclass of RB.DisplayPage, by default page groups are never selectable so they have no content.

classmethod add_core_groups(shell, page_model)¶

Parameters:

shell (GObject.Object) – the RB.Shell
page_model (RB.DisplayPageModel) – the RB.DisplayPageModel

Registers core page groups.

classmethod get_by_id(id)¶

Parameters:: id (str) – name of page group to find
Returns:: existing page group, or None.
Return type:: RB.DisplayPageGroup

Locates a page group by name. If the page group has not been registered yet, returns None instead.

classmethod new(shell, id, name, category)¶

Parameters:

shell (GObject.Object) – the RB.Shell
id (str) – name of the page group (untranslated, used in code)
name (str) – display name of the page group (translated)
category (RB.DisplayPageGroupCategory) – category for the page group

Returns:

new page group

Return type:

RB.DisplayPageGroup

Creates a new page group object. The group will be registered before it is returned.

loaded()¶: Called when the page group is fully loaded, that is, all initial pages have been added.

Property Details¶

RB.DisplayPageGroup.props.category¶

Name:: category
Type:: RB.DisplayPageGroupType
Default Value:: RB.DisplayPageGroupType.FIXED
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Page group category that the group falls into

RB.DisplayPageGroup.props.id¶

Name:: id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Internal (untranslated) name for the page group

RB.DisplayPageGroup.props.loaded¶

Name:: loaded
Type:: bool
Default Value:: False
Flags:: READABLE

Whether the group is loaded