:right-sidebar: True

StatusPage
===================================================================

.. currentmodule:: gi.repository.Adw





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


Superclasses: :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`



A page used for empty/error states and similar use-cases.

.. image:: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/status-page.png

The ``AdwStatusPage`` widget can have an icon, a title, a description and a
custom widget which is displayed below them.

CSS nodes
--------------------------------------------------------------------------------

``AdwStatusPage`` has a main CSS node with name ``statuspage``\.

When setting an :obj:`~gi.repository.Adw.SpinnerPaintable` as :obj:`~gi.repository.Adw.StatusPage.props.paintable`\,
the main nodes gains the ``.spinner`` style class for a more compact
appearance.

Style classes
--------------------------------------------------------------------------------

``AdwStatusPage`` can use the
```.compact`` <style-classes.html#compact-status-page>`__ style class for when it
needs to fit into a small space such a sidebar or a popover, similar to when
using a spinner as the paintable.

.. image:: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/status-page-compact.png


Constructors
------------

.. rst-class:: interim-class

.. class:: StatusPage
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Gtk.Widget

      Creates a new ``AdwStatusPage``\.













Methods
-------

.. rst-class:: interim-class

.. class:: StatusPage
   :no-index:


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

      Gets the child widget of ``self``\.









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

      Gets the description markup for ``self``\.









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

      Gets the icon name for ``self``\.









   .. method:: get_paintable() -> ~gi.repository.Gdk.Paintable | None

      Gets the paintable for ``self``\.









   .. method:: get_title() -> str

      Gets the title for ``self``\.









   .. method:: set_child(child: ~gi.repository.Gtk.Widget | None = None) -> None

      Sets the child widget of ``self``\.






      :param child: the child widget




   .. method:: set_description(description: str | None = None) -> None

      Sets the description markup for ``self``\.

      The description is displayed below the title. It is parsed as Pango markup.






      :param description: the description




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

      Sets the icon name for ``self``\.

      Changing this will set :obj:`~gi.repository.Adw.StatusPage.props.paintable` to ``NULL``\.






      :param icon_name: the icon name




   .. method:: set_paintable(paintable: ~gi.repository.Gdk.Paintable | None = None) -> None

      Sets the paintable for ``self``\.

      Changing this will set :obj:`~gi.repository.Adw.StatusPage.props.icon_name` to ``NULL``\.






      :param paintable: the paintable




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

      Sets the title for ``self``\.

      The title is displayed below the icon. It is not parsed as Pango markup.






      :param title: the title








Properties
----------

.. rst-class:: interim-class

.. class:: StatusPage
   :no-index:
   

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

      The type of the None singleton.







   .. attribute:: props.description
      :type: str

      The type of the None singleton.







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

      The type of the None singleton.







   .. attribute:: props.paintable
      :type: ~gi.repository.Gdk.Paintable

      The type of the None singleton.







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

      The type of the None singleton.