:right-sidebar: True

ToastOverlay
===================================================================

.. currentmodule:: gi.repository.Adw





.. class:: ToastOverlay(**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`



:Constructors:

::

    ToastOverlay(**properties)
    new() -> Gtk.Widget



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

.. rst-class:: interim-class

.. class:: ToastOverlay
   :no-index:


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

      Creates a new ``AdwToastOverlay``.














Methods
-------

.. rst-class:: interim-class

.. class:: ToastOverlay
   :no-index:


   .. method:: add_toast(toast: ~gi.repository.Adw.Toast) -> None

      Displays ``toast``.

      Only one toast can be shown at a time; if a toast is already being displayed,
      either ``toast`` or the original toast will be placed in a queue, depending on
      the priority of ``toast``. See :obj:`~gi.repository.Adw.Toast.props.priority`.

      If called on a toast that's already displayed, its timeout will be reset.

      If called on a toast currently in the queue, the toast will be bumped
      forward to be shown as soon as possible.







      :param toast: a toast





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

      Gets the child widget of ``self``.










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

      Sets the child widget of ``self``.







      :param child: the child widget









Properties
----------

.. rst-class:: interim-class

.. class:: ToastOverlay
   :no-index:
   

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

      The child widget.