<?xml version="1.0"?> <!-- Copyright (C) 2015 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: Alexander Larsson <alexl@redhat.com> --> <node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd" name="/"> <!-- org.freedesktop.impl.portal.FileChooser: @short_description: File chooser portal backend interface The FileChooser portal allows sandboxed applications to ask the user for access to files outside the sandbox. The portal backend will present the user with a file chooser dialog. --> <interface name="org.freedesktop.impl.portal.FileChooser"> <!-- OpenFile: @handle: Object path for the #org.freedesktop.impl.portal.Request object representing this call @app_id: App id of the application @parent_window: Identifier for the application window, see <link linkend="parent_window">Common Conventions</link> @title: Title for the file chooser dialog @options: Vardict with optional further information @response: Numeric response @results: Vardict with the results of the call Presents a file chooser dialog to the user to open one or more files. Supported keys in the @options vardict include: <variablelist> <varlistentry> <term>accept_label s</term> <listitem><para> The label for the accept button. Mnemonic underlines are allowed. </para></listitem> </varlistentry> <varlistentry> <term>modal b</term> <listitem><para> Whether to make the dialog modal. Default is yes. </para></listitem> </varlistentry> <varlistentry> <term>multiple b</term> <listitem><para> Whether to allow selection of multiple files. Default is no. </para></listitem> </varlistentry> <varlistentry> <term>directory b</term> <listitem><para> Whether to select for folders instead of files. Default is to select files. </para></listitem> </varlistentry> <varlistentry> <term>filters a(sa(us))</term> <listitem><para> A list of serialized file filters. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> <varlistentry> <term>current_filter (sa(us))</term> <listitem><para> Request that this filter be set by default at dialog creation. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> <varlistentry> <term>choices a(ssa(ss)s)</term> <listitem><para> A list of serialized combo boxes. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> </variablelist> The following results get returned via the @results vardict: <variablelist> <varlistentry> <term>uris as</term> <listitem><para> An array of strings containing the uris of the selected files. </para></listitem> </varlistentry> <varlistentry> <term>choices a(ss)</term> <listitem><para> An array of pairs of strings, corresponding to the passed-in choices. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> <varlistentry> <term>current_filter (sa(us))</term> <listitem> <para> The filter that was selected. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para> </listitem> </varlistentry> <varlistentry> <term>writable b</term> <listitem><para> Whether the file is opened with write access. Default is no. </para></listitem> </varlistentry> </variablelist> --> <method name="OpenFile"> <arg type="o" name="handle" direction="in"/> <arg type="s" name="app_id" direction="in"/> <arg type="s" name="parent_window" direction="in"/> <arg type="s" name="title" direction="in"/> <annotation name="org.qtproject.QtDBus.QtTypeName.In4" value="QVariantMap"/> <arg type="a{sv}" name="options" direction="in"/> <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> <!-- SaveFile: @handle: Object path for the #org.freedesktop.impl.portal.Request object representing this call @app_id: App id of the application @parent_window: Identifier for the application window, see <link linkend="parent_window">Common Conventions</link> @title: Title for the file chooser dialog @options: Vardict with optional further information @response: Numeric response @results: Vardict with the results of the call Presents a file chooser dialog to the user to save a file. Supported keys in the @options vardict include: <variablelist> <varlistentry> <term>accept_label s</term> <listitem><para> The label for the accept button. Mnemonic underlines are allowed. </para></listitem> </varlistentry> <varlistentry> <term>modal b</term> <listitem><para> Whether to make the dialog modal. Default is yes. </para></listitem> </varlistentry> <varlistentry> <term>multiple b</term> <listitem><para> Whether to allow selection of multiple files. Default is no. </para></listitem> </varlistentry> <varlistentry> <term>filters a(sa(us))</term> <listitem><para> A list of serialized file filters. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> <varlistentry> <term>current_filter (sa(us))</term> <listitem><para> Request that this filter be set by default at dialog creation. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> <varlistentry> <term>choices a(ssa(ss)s)</term> <listitem><para> A list of serialized combo boxes. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> <varlistentry> <term>current_name s</term> <listitem><para> A suggested filename. </para></listitem> </varlistentry> <varlistentry> <term>current_folder ay</term> <listitem><para> A suggested folder to save the file in. </para></listitem> </varlistentry> <varlistentry> <term>current_file ay</term> <listitem><para> The current file (when saving an existing file). </para></listitem> </varlistentry> </variablelist> The following results get returned via the @results vardict: <variablelist> <varlistentry> <term>uris as</term> <listitem><para> An array of strings containing the uri of the selected file. </para></listitem> </varlistentry> <varlistentry> <term>choices a(ss)</term> <listitem><para> An array of pairs of strings, corresponding to the passed-in choices. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> <varlistentry> <term>current_filter (sa(us))</term> <listitem> <para> The filter that was selected. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para> </listitem> </varlistentry> </variablelist> --> <method name="SaveFile"> <arg type="o" name="handle" direction="in"/> <arg type="s" name="app_id" direction="in"/> <arg type="s" name="parent_window" direction="in"/> <arg type="s" name="title" direction="in"/> <annotation name="org.qtproject.QtDBus.QtTypeName.In4" value="QVariantMap"/> <arg type="a{sv}" name="options" direction="in"/> <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> <!-- SaveFiles: @parent_window: Identifier for the application window, see <link linkend="parent_window">Common Conventions</link> @title: Title for the file chooser dialog @options: Vardict with optional further information @handle: Object path for the #org.freedesktop.portal.Request object representing this call Asks for a folder as a location to save one or more files. The names of the files will be used as-is and appended to the selected folder's path in the list of returned files. If the selected folder already contains a file with one of the given names, the portal may prompt or take some other action to construct a unique file name and return that instead. Supported keys in the @options vardict include: <variablelist> <varlistentry> <term>handle_token s</term> <listitem><para> A string that will be used as the last element of the @handle. Must be a valid object path element. See the #org.freedesktop.portal.Request documentation for more information about the @handle. </para></listitem> </varlistentry> <varlistentry> <term>accept_label s</term> <listitem><para> Label for the accept button. Mnemonic underlines are allowed. </para></listitem> </varlistentry> <varlistentry> <term>modal b</term> <listitem><para> Whether the dialog should be modal. Default is yes. </para></listitem> </varlistentry> <varlistentry> <term>choices a(ssa(ss)s)</term> <listitem><para> List of serialized combo boxes. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> <varlistentry> <term>current_folder ay</term> <listitem> <para> Suggested folder to save the files in. The byte array is expected to be null-terminated. </para> </listitem> </varlistentry> <varlistentry> <term>files aay</term> <listitem> <para> An array of file names to be saved. The array and byte arrays are expected to be null-terminated. </para> </listitem> </varlistentry> </variablelist> The following results get returned via the #org.freedesktop.portal.Request::Response signal: <variablelist> <varlistentry> <term>uris as</term> <listitem><para> An array of strings containing the uri corresponding to each file given by @options, in the same order. Note that the file names may have changed, for example if a file with the same name in the selected folder already exists. </para></listitem> </varlistentry> <varlistentry> <term>choices a(ss)</term> <listitem><para> An array of pairs of strings, corresponding to the passed-in choices. See org.freedesktop.portal.FileChooser.OpenFile() for details. </para></listitem> </varlistentry> </variablelist> --> <method name="SaveFiles"> <arg type="o" name="handle" direction="in"/> <arg type="s" name="app_id" direction="in"/> <arg type="s" name="parent_window" direction="in"/> <arg type="s" name="title" direction="in"/> <annotation name="org.qtproject.QtDBus.QtTypeName.In4" value="QVariantMap"/> <arg type="a{sv}" name="options" direction="in"/> <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> </interface> </node>