:right-sidebar: True

StackPage
===================================================================

.. currentmodule:: gi.repository.Gtk





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


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



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



``GtkStackPage`` is an auxiliary class used by ``GtkStack``.





Methods
-------

.. rst-class:: interim-class

.. class:: StackPage
   :no-index:


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

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










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

      Returns the icon name of the page.










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

      Returns the name of the page.










   .. method:: get_needs_attention() -> bool

      Returns whether the page is marked as “needs 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

      Returns whether ``page`` is visible in its ``GtkStack``.

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










   .. method:: set_icon_name(setting: str) -> None

      Sets the icon name of the page.







      :param setting: the new value to set





   .. method:: set_name(setting: str) -> None

      Sets the name of the page.







      :param setting: the new value to set





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

      Sets whether the page is marked as “needs attention”.







      :param setting: the new value to set





   .. method:: set_title(setting: str) -> None

      Sets the page title.







      :param setting: the new value to set





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

      Sets whether underlines in the page title indicate mnemonics.







      :param setting: the new value to set





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

      Sets whether ``page`` is visible in its ``GtkStack``.







      :param visible: The new property value









Properties
----------

.. rst-class:: interim-class

.. class:: StackPage
   :no-index:
   

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

      The child that this page is for.







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

      The icon name of the child page.







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

      The name of the child page.







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

      Whether the page requires the user attention.

      This is used by the :obj:`~gi.repository.Gtk.StackSwitcher` to change the
      appearance of the corresponding button when a page needs
      attention and it is not the current one.







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

      The title of the child page.







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

      If set, an underline in the title indicates a mnemonic.







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

      Whether this page is visible.