<?xml version="1.0"?>
<!--
 Copyright (C) 2019 Red Hat, Inc.

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2 of the License, or (at your option) any later version.

 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with this library. If not, see <http://www.gnu.org/licenses/>.

 Author: Felipe Borges <feborges@redhat.com>
-->

<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
  <!--
      org.freedesktop.portal.Wallpaper:
      @short_description: Portal for setting the desktop's Wallpaper

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

      This documentation describes version 1 of this interface.
  -->
  <interface name="org.freedesktop.portal.Wallpaper">
    <!--
        SetWallpaperURI:
        @parent_window: Identifier for the application window, see <link linkend="parent_window">Common Conventions</link>
        @uri: The picture file uri
        @options: Options that influence the behavior of the portal
        @handle: Object path for the #org.freedesktop.portal.Request object representing this call

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

        Note that file: uris are explicitly not supported here. To use a local image file as
        background, use the org.freedesktop.portal.Wallpaper.SetWallpaperFile() method.

        Supported keys in the @options vardict include:
        <variablelist>
          <varlistentry>
            <term>show-preview b</term>
            <listitem><para>
             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
            </para></listitem>
          </varlistentry>
          <varlistentry>
            <term>set-on s</term>
            <listitem><para>
              where to set the wallpaper. Possible values are 'background', 'lockscreen' or 'both'
            </para></listitem>
          </varlistentry>
        </variablelist>
    -->
    <method name="SetWallpaperURI">
      <arg type="s" name="parent_window" direction="in"/>
      <arg type="s" name="uri" direction="in"/>
      <arg type="a{sv}" name="options" direction="in"/>
      <arg type="o" name="handle" direction="out"/>
    </method>

    <!--
        SetWallpaperFile:
        @parent_window: Identifier for the application window, see <link linkend="parent_window">Common Conventions</link>
        @fd: File descriptor for the file to open
        @options: Options that influence the behavior of the portal
        @handle: Object path for the #org.freedesktop.portal.Request object representing this call

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

        Supported keys in the @options vardict include:
        <variablelist>
          <varlistentry>
            <term>show-preview b</term>
            <listitem><para>
             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
            </para></listitem>
          </varlistentry>
          <varlistentry>
            <term>set-on s</term>
            <listitem><para>
              where to set the wallpaper. Possible values are 'background', 'lockscreen' or 'both'
            </para></listitem>
          </varlistentry>
        </variablelist>
    -->
    <method name="SetWallpaperFile">
      <annotation name="org.gtk.GDBus.C.UnixFD" value="true"/>
      <arg type="s" name="parent_window" direction="in"/>
      <arg type="h" name="fd" direction="in"/>
      <arg type="a{sv}" name="options" direction="in"/>
      <arg type="o" name="handle" direction="out"/>
    </method>

    <property name="version" type="u" access="read"/>
  </interface>
</node>
