<?xml version="1.0"?>
<!--
 Copyright (C) 2022 Aleix Pol Gonzalez <aleixpol@kde.org>

 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: Aleix Pol Gonzalez <aleixpol@kde.org>
-->

<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
  <!--
      org.freedesktop.impl.portal.GlobalShortcut:
      @short_description: GlobalShortcut portal backend interface

      This portal lets applications register global shortcuts so they can
      act regardless of the system state upon an input event.

      This documentation describes version 1 of this interface.
  -->
  <interface name="org.freedesktop.impl.portal.GlobalShortcuts">
    <!--
        CreateSession:
        @handle: Object path for the #org.freedesktop.impl.portal.Request object representing this call
        @session_handle: Object path for the #org.freedesktop.impl.portal.Session object representing the session being created
        @app_id: App id of the application
        @options: Vardict with optional further information. See @org.freedesktop.portal.GlobalShortcuts.CreateSession
        @response: Numeric Request response
        @results: Vardict with the results of the call

        Create a global shortcuts session.

        The following results get returned via the #org.freedesktop.portal.Request::Response signal:
        <variablelist>
          <varlistentry>
            <term>session_id s</term>
            <listitem><para>
              The session id. A string representing the created global shortcuts session.
            </para></listitem>
          </varlistentry>
        </variablelist>
    -->
    <method name="CreateSession">
      <arg type="o" name="handle" direction="in"/>
      <arg type="o" name="session_handle" direction="in"/>
      <arg type="s" name="app_id" direction="in"/>
      <arg type="a{sv}" name="options" direction="in"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.In3" value="QVariantMap"/>
      <arg type="u" name="response" direction="out"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.Out1" value="QVariantMap"/>
      <arg type="a{sv}" name="results" direction="out"/>
    </method>

    <!--
        BindShortcuts:
        @handle: Object path for the #org.freedesktop.impl.portal.Request object representing this call
        @session_handle: Object path for the #org.freedesktop.impl.portal.Session object representing the session
        @shortcuts: The list of shortcuts to bind. See @org.freedesktop.portal.GlobalShortcuts.BindShortcuts
        @parent_window: Identifier for the application window, see <link linkend="parent_window">Common Conventions</link>
        @shortcuts: The identifier of the shortcuts we intend to register, empty for all shortcuts
        @results: Vardict with the results of the call

        Bind the shortcuts of this session. This will typically result the portal
        presenting a dialog letting the user configure shortcut triggers.

        The results get returned via the #org.freedesktop.portal.Request::Response
        signal. See org.freedesktop.portal.GlobalShortcuts.BindShortcuts() for the
        list of supported properties of shortcuts.
    -->
    <method name="BindShortcuts">
      <arg type="o" name="handle" direction="in"/>
      <arg type="o" name="session_handle" direction="in"/>
      <arg type="a(sa{sv})" name="shortcuts" direction="in"/>
      <arg type="s" name="parent_window" direction="in"/>
      <arg type="a{sv}" name="options" direction="in"/>
      <arg type="u" name="response" direction="out"/>
      <arg type="a{sv}" name="results" direction="out"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="QList&lt;QPair&lt;QString,QVariantMap&gt;&gt;"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.In4" value="QVariantMap"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.Out1" value="QVariantMap"/>
    </method>

    <!--
        ListShortcuts:
        @handle: Object path for the #org.freedesktop.impl.portal.Request object representing this call
        @session_handle: Object path for the #org.freedesktop.impl.portal.Session object representing the session
        @results: Vardict with the results of the call

        List shortcuts registered in the global shortcuts session.

        The following results get returned via the #org.freedesktop.portal.Request::Response signal:
        <variablelist>
          <varlistentry>
            <term>shortcuts a(sa{sv})</term>
            <listitem><para>
              A list of shortcuts.

              See the #org.freedesktop.portal.Request::Response signal of the
              org.freedesktop.portal.GlobalShortcuts.BindShortcuts() method for
              the list of supported properties of shortcuts.
            </para></listitem>
          </varlistentry>
      </variablelist>
    -->
    <method name="ListShortcuts">
      <arg type="o" name="handle" direction="in"/>
      <arg type="o" name="session_handle" direction="in"/>
      <arg type="u" name="response" direction="out"/>
      <arg type="a{sv}" name="results" direction="out"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.Out1" value="QVariantMap"/>
    </method>

    <!--
        Activated:
        @session_handle: Session that requested the shortcut
        @shortcut_id: the application-provided ID for the notification
        @timestamp: The timestamp, as seconds and microseconds since the Unix epoch.
        @options: Vardict with optional further information

        Emitted when a shortcut is activated.
    -->
    <signal name="Activated">
      <arg type="o" name="session_handle" direction="out"/>
      <arg type="s" name="shortcut_id" direction="out"/>
      <arg type="t" name="timestamp" direction="out"/>
      <arg type="a{sv}" name="options" direction="out"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.Out3" value="QVariantMap"/>
    </signal>

    <!--
        Deactivated:
        @session_handle: Session that requested the shortcut
        @shortcut_id: the application-provided ID for the notification
        @timestamp: The timestamp, as seconds and microseconds since the Unix epoch.
        @options: Vardict with optional further information

        Emitted when a shortcut is deactivated.
    -->
    <signal name="Deactivated">
      <arg type="o" name="session_handle" direction="out"/>
      <arg type="s" name="shortcut_id" direction="out"/>
      <arg type="t" name="timestamp" direction="out"/>
      <arg type="a{sv}" name="options" direction="out"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.Out3" value="QVariantMap"/>
    </signal>

    <!--
        ShortcutsChanged:
        @session_handle: Session that requested the shortcut
        @shortcuts: The list of changed shortcuts

        Emitted when shortcuts are changed.

        The results get returned via the #org.freedesktop.portal.Request::Response
        signal. See org.freedesktop.portal.GlobalShortcuts.BindShortcuts() for the
        list of supported properties of shortcuts.
    -->
    <signal name="ShortcutsChanged">
      <arg type="o" name="session_handle" direction="out"/>
      <arg type="a(sa{sv})" name="shortcuts" direction="out"/>
      <annotation name="org.qtproject.QtDBus.QtTypeName.Out1" value="QList&lt;QPair&lt;QString,QVariantMap&gt;&gt;"/>
    </signal>

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