:right-sidebar: True

ViewStackPage
===================================================================

.. currentmodule:: gi.repository.Adw





.. class:: ViewStackPage(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`



An auxiliary class used by :obj:`~gi.repository.Adw.ViewStack`\.




Methods
-------

.. rst-class:: interim-class

.. class:: ViewStackPage
   :no-index:


   .. method:: get_badge_number() -> int

      Gets the badge number for this page.









   .. method:: get_child() -> ~gi.repository.Gtk.Widget

      Gets the stack child to which ``self`` belongs.









   .. method:: get_icon_name() -> str | None

      Gets the icon name of the page.









   .. method:: get_name() -> str | None

      Gets the name of the page.









   .. method:: get_needs_attention() -> bool

      Gets whether the page requires the user attention.









   .. method:: get_title() -> str | None

      Gets the page title.









   .. method:: get_use_underline() -> bool

      Gets whether underlines in the page title indicate mnemonics.









   .. method:: get_visible() -> bool

      Gets whether ``self`` is visible in its ``AdwViewStack``\.

      This is independent from the :obj:`~gi.repository.Gtk.Widget.props.visible`
      property of its widget.









   .. method:: set_badge_number(badge_number: int) -> None

      Sets the badge number for this page.

      :obj:`~gi.repository.Adw.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 :obj:`~gi.repository.Adw.ViewStack{age}.props.needs_attention`\.






      :param badge_number: the new value to set




   .. method:: set_icon_name(icon_name: str | None = None) -> None

      Sets the icon name of the page.






      :param icon_name: the icon name




   .. method:: set_name(name: str | None = None) -> None

      Sets the name of the page.






      :param name: the page name




   .. method:: set_needs_attention(needs_attention: bool) -> None

      Sets whether the page requires the user attention.

      :obj:`~gi.repository.Adw.ViewSwitcher` will display it as a dot next to the page icon.






      :param needs_attention: the new value to set




   .. method:: set_title(title: str | None = None) -> None

      Sets the page title.






      :param title: the page title




   .. method:: set_use_underline(use_underline: bool) -> None

      Sets whether underlines in the page title indicate mnemonics.






      :param use_underline: the new value to set




   .. method:: set_visible(visible: bool) -> None

      Sets whether ``page`` is visible in its ``AdwViewStack``\.

      This is independent from the :obj:`~gi.repository.Gtk.Widget.props.visible` property of
      :obj:`~gi.repository.Adw.ViewStackPage.props.child`\.






      :param visible: whether ``self`` is visible








Properties
----------

.. rst-class:: interim-class

.. class:: ViewStackPage
   :no-index:
   

   .. attribute:: props.badge_number
      :type: int

      The type of the None singleton.







   .. attribute:: props.child
      :type: ~gi.repository.Gtk.Widget

      The type of the None singleton.







   .. attribute:: props.icon_name
      :type: str

      The type of the None singleton.







   .. attribute:: props.name
      :type: str

      The type of the None singleton.







   .. attribute:: props.needs_attention
      :type: bool

      The type of the None singleton.







   .. attribute:: props.title
      :type: str

      The type of the None singleton.







   .. attribute:: props.use_underline
      :type: bool

      The type of the None singleton.







   .. attribute:: props.visible
      :type: bool

      The type of the None singleton.