ViewStackPage

class ViewStackPage(**properties: Any)

Superclasses: Object

Implemented Interfaces: Accessible

An auxiliary class used by ViewStack.

Methods

class ViewStackPage

get_badge_number() → int

Gets the badge number for this page.

get_child() → Widget

Gets the stack child to which self belongs.

get_icon_name() → str | None

Gets the icon name of the page.

get_name() → str | None

Gets the name of the page.

get_needs_attention() → bool

Gets whether the page requires the user attention.

get_section_title() → str | None

Gets the section title for self.

Added in version 1.9.

get_starts_section() → bool

Gets whether self starts a section.

Added in version 1.9.

get_title() → str | None

Gets the page title.

get_use_underline() → bool

Gets whether underlines in the page title indicate mnemonics.

get_visible() → bool

Gets whether self is visible in its AdwViewStack.

This is independent from the visible property of its widget.

set_badge_number(badge_number: int) → None

Sets the badge number for this page.

ViewSwitcher can display it as a badge next to the page icon. It is commonly used to display a number of unread items within the page.

It can be used together with needs_attention.

Parameters:

badge_number – the new value to set

set_icon_name(icon_name: str | None = None) → None

Sets the icon name of the page.

Parameters:

icon_name – the icon name

set_name(name: str | None = None) → None

Sets the name of the page.

Parameters:

name – the page name

set_needs_attention(needs_attention: bool) → None

Sets whether the page requires the user attention.

ViewSwitcher will display it as a dot next to the page icon.

Parameters:

needs_attention – the new value to set

set_section_title(section_title: str | None = None) → None

Sets the section title for self.

Does nothing unless starts_section is set.

Added in version 1.9.

Parameters:

section_title – the section title

set_starts_section(starts_section: bool) → None

Sets whether self starts a section.

If set to TRUE, pages will have a section starting from this page.

If section_title is set, it should be used as a title for the section.

Added in version 1.9.

Parameters:

starts_section – whether self starts a section

set_title(title: str | None = None) → None

Sets the page title.

Parameters:

title – the page title

set_use_underline(use_underline: bool) → None

Sets whether underlines in the page title indicate mnemonics.

Parameters:

use_underline – the new value to set

set_visible(visible: bool) → None

Sets whether self is visible in its AdwViewStack.

This is independent from the visible property of child.

Parameters:

visible – whether self is visible

Properties

class ViewStackPage

props.badge_number: int

The badge number for this page.

ViewSwitcher can display it as a badge next to the page icon. It is commonly used to display a number of unread items within the page.

It can be used together with needs_attention.

props.child: Widget

The stack child to which the page belongs.

props.icon_name: str

The icon name of the child page.

props.name: str

The name of the child page.

props.needs_attention: bool

Whether the page requires the user attention.

ViewSwitcher will display it as a dot next to the page icon.

props.section_title: str

Section title for this page.

Does nothing unless starts_section is set.

Added in version 1.9.

props.starts_section: bool

Whether this page starts a section.

If set to TRUE, pages will have a section starting from this page.

If section_title is set, it should be used as a title for the section.

Added in version 1.9.

props.title: str

The title of the child page.

props.use_underline: bool

Whether an embedded underline in the title indicates a mnemonic.

props.visible: bool

Whether this page is visible.

This is independent from the visible property of child.