TabPage

class TabPage(**properties: Any)

Superclasses: Object

Implemented Interfaces: Accessible

An auxiliary class used by TabView.

Methods

class TabPage

get_child() → Widget: Gets the child of self.

get_icon() → Icon | None: Gets the icon of self.

get_indicator_activatable() → bool: Gets whether the indicator of self is activatable.

get_indicator_icon() → Icon | None: Gets the indicator icon of self.

get_indicator_tooltip() → str: Gets the tooltip of the indicator icon of self.

Added in version 1.2.

get_keyword() → str | None: Gets the search keyword of self.

Added in version 1.3.

get_live_thumbnail() → bool: Gets whether to live thumbnail is enabled self.

Added in version 1.3.

get_loading() → bool: Gets whether self is loading.

get_needs_attention() → bool: Gets whether self needs attention.

get_parent() → TabPage | None

Gets the parent page of self.

See add_page and close_page.

get_pinned() → bool

Gets whether self is pinned.

See set_page_pinned.

get_selected() → bool: Gets whether self is selected.

get_thumbnail_xalign() → float: Gets the horizontal alignment of the thumbnail for self.

Added in version 1.3.

get_thumbnail_yalign() → float: Gets the vertical alignment of the thumbnail for self.

Added in version 1.3.

get_title() → str: Gets the title of self.

get_tooltip() → str | None: Gets the tooltip of self.

invalidate_thumbnail() → None

Invalidates thumbnail for self.

If an TabOverview is open, the thumbnail representing self will be immediately updated. Otherwise it will be update when opening the overview.

Does nothing if live_thumbnail is set to TRUE.

Properties

class TabPage

props.child: Widget: The child of the page.

props.icon: Icon

The icon of the page.

TabBar and TabOverview display the icon next to the title, unless loading is set to TRUE.

AdwTabBar also won’t show the icon if the page is pinned and [propertyTabPage:indicator-icon] is set.

props.indicator_activatable: bool

Whether the indicator icon is activatable.

If set to TRUE, indicator_activated will be emitted when the indicator icon is clicked.

If indicator_icon is not set, does nothing.

props.indicator_icon: Icon

An indicator icon for the page.

A common use case is an audio or camera indicator in a web browser.

TabBar will show it at the beginning of the tab, alongside icon representing icon or loading spinner.

If the page is pinned, the indicator will be shown instead of icon or spinner.

TabOverview will show it at the at the top part of the thumbnail.

indicator_tooltip can be used to set the tooltip on the indicator icon.

If indicator_activatable is set to TRUE, the indicator icon can act as a button.

props.indicator_tooltip: str

The tooltip of the indicator icon.

The tooltip can be marked up with the Pango text markup language.

See indicator_icon.

Added in version 1.2.

props.keyword: str

The search keyboard of the page.

TabOverview can search pages by their keywords in addition to their titles and tooltips.

Keywords allow to include e.g. page URLs into tab search in a web browser.

Added in version 1.3.

props.live_thumbnail: bool

Whether to enable live thumbnail for this page.

When set to TRUE, the page’s thumbnail in TabOverview will update immediately when the page is redrawn or resized.

If it’s set to FALSE, the thumbnail will only be live when the page is selected, and otherwise it will be static and will only update when invalidate_thumbnail or invalidate_thumbnails is called.

Added in version 1.3.

props.loading: bool

Whether the page is loading.

If set to TRUE, TabBar and TabOverview will display a spinner in place of icon.

If the page is pinned and indicator_icon is set, loading status will not be visible with AdwTabBar.

props.needs_attention: bool

Whether the page needs attention.

TabBar will display a line under the tab representing the page if set to TRUE. If the tab is not visible, the corresponding edge of the tab bar will be highlighted.

TabOverview will display a dot in the corner of the thumbnail if set to TRUE.

TabButton will display a dot if any of the pages that aren’t selected have this property set to TRUE.

props.parent: TabPage

The parent page of the page.

See add_page and close_page.

props.pinned: bool

Whether the page is pinned.

See set_page_pinned.

props.selected: bool: Whether the page is selected.

props.thumbnail_xalign: float

The horizontal alignment of the page thumbnail.

If the page is so wide that TabOverview can’t display it completely and has to crop it, horizontal alignment will determine which part of the page will be visible.

For example, 0.5 means the center of the page will be visible, 0 means the start edge will be visible and 1 means the end edge will be visible.

The default horizontal alignment is 0.

Added in version 1.3.

props.thumbnail_yalign: float

The vertical alignment of the page thumbnail.

If the page is so tall that TabOverview can’t display it completely and has to crop it, vertical alignment will determine which part of the page will be visible.

For example, 0.5 means the center of the page will be visible, 0 means the top edge will be visible and 1 means the bottom edge will be visible.

The default vertical alignment is 0.

Added in version 1.3.

props.title: str

The title of the page.

TabBar will display it in the center of the tab unless it’s pinned, and will use it as a tooltip unless tooltip is set.

TabOverview will display it below the thumbnail unless it’s pinned, or inside the card otherwise, and will use it as a tooltip unless tooltip is set.

props.tooltip: str

The tooltip of the page.

The tooltip can be marked up with the Pango text markup language.

If not set, TabBar and TabOverview will use title as a tooltip instead.