1 files changed, 107 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl
new file mode 100644
index 000000000..17b56cc34
--- /dev/null
+++ b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl
@@ -0,0 +1,107 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_ui_dialogs_XFilePicker_idl__
+#define __com_sun_star_ui_dialogs_XFilePicker_idl__
+
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
+
+
+module com { module sun { module star { module ui { module dialogs {
+
+/** Specifies an interface for a FilePicker
+*/
+
+published interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog
+{
+
+    /** Enable/disable multi-selection mode
+
+        <p>If the multi-selection mode is enabled, multiple files
+        may be selected by the user else only one file selection at a time is possible</p>
+
+        @param bMode
+        <p>A value of `TRUE` enables the multi-selection mode.</p>
+        <p>A value of `FALSE` disables the multi-selection mode, this is the default.</p>
+    */
+    void setMultiSelectionMode( [in] boolean bMode );
+
+    /** Sets the default string that appears in the file name box of a FilePicker.
+
+        @param aName
+        <p> Specifies the default file name, displayed when the FilePicker
+            is shown. The implementation may accept any string, and does not
+            have to check for a valid file name or if the file really exists.
+        </p>
+    */
+    void setDefaultName( [in] string aName );
+
+    /** Sets the directory that the file dialog initially displays.
+
+        @param aDirectory
+        Specifies the initial directory in URL format. The given URL must
+        conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>).
+
+        @throws com::sun::star::lang::IllegalArgumentException
+        if the URL is invalid (doesn't conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>).
+    */
+    void setDisplayDirectory( [in] string aDirectory )
+        raises( ::com::sun::star::lang::IllegalArgumentException );
+
+    /** Returns the directory that the file dialog is currently showing or
+        was last showing before closing the dialog with Ok. If the user
+        did cancel the dialog, the returned value is undefined.
+
+        @returns
+        The directory in URL format, must conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
+     */
+    string getDisplayDirectory();
+
+    /** Returns a sequence of the selected files including path information in
+        URL format, conforming to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
+
+        <p>If the user closed the dialog with cancel an empty sequence will be
+        returned.</p>
+        <br/>
+        <p>If the dialog is in execution mode and a single file is selected
+        the complete URL of this file will be returned.</p>
+        <p>If the dialog is in execution mode and the selected file name is false
+        or any other error occurs an empty sequence will be returned.</p>
+
+        @returns
+        <p> The complete path of the file or directory currently selected
+            in URL format. This always returns only the first entry of the sequence.
+            <br/>
+            <p><strong>Notes for the implementation of a FileSave dialog:</strong>If there exists
+            a checkbox "Automatic File Extension" which is checked and a valid filter is currently selected
+            the dialog may automatically add an extension to the selected file name.</p>
+        </p>
+        @deprecated use com::sun::star::ui::dialogs::XFilePicker2::getSelectedFiles instead
+    */
+    sequence< string > getFiles();
+};
+
+
+}; }; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */