.. _org.freedesktop.impl.portal.Wallpaper:

=====================================
 Wallpaper
=====================================

-----------
Description
-----------

.. _org.freedesktop.impl.portal.Wallpaper Description:

Portal for setting the desktop's Wallpaper

This simple interface lets sandboxed applications set the user's
desktop background picture.



.. _org.freedesktop.impl.portal.Wallpaper Methods:

-------
Methods
-------

.. _org.freedesktop.impl.portal.Wallpaper.SetWallpaperURI:

org.freedesktop.impl.portal.Wallpaper.SetWallpaperURI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

::

    SetWallpaperURI (
      IN handle o,
      IN app_id s,
      IN parent_window s,
      IN uri s,
      IN options a{sv},
      OUT response u
    )



Asks to set a given picture as the desktop background picture.

The following options are supported:

* ``show-preview`` (``b``)

  Whether to show a preview of the picture. Note that the portal may
  decide to show a preview even if this option is not set

* ``set-on`` (``s``)

  Where to set the wallpaper. Possible values are `background`,
  `lockscreen` or `both`.



handle
  Object path to export the Request object at

app_id
  App id of the application

parent_window
  Identifier for the application window, see :doc:`window-identifiers`

uri
  The picture file URI

options
  Options that influence the behavior of the portal

response
  Numberic response