offapi/com/sun/star/ui/dialogs/XFilePicker2.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module ui { module dialogs {
  22
  23 /** extends file picker interface to workaround some design problems.
  24 */
  25 published interface XFilePicker2 : ::com::sun::star::ui::dialogs::XFilePicker
  26 {
  27     /** Returns a sequence of the selected files including path information in
  28         URL format, conforming to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
  29
  30         <p>If the user closed the dialog with cancel an empty sequence will be returned.</p>
  31         <br/>
  32
  33         <p>If the user closed the dialog with OK a list of all selected files will be returned.</p>
  34
  35         @attention
  36         <p>
  37         Instead to the method getFiles() of base interface XFilePicker the new method return
  38         full qualified URLs for every selected file.
  39         </p>
  40
  41         @returns
  42         <p>A list of all selected file as complete URLs.</p>
  43         <br/>
  44
  45         <p><strong>Notes for the implementation of a FileSave dialog:</strong>If there exists
  46         a checkbox "Automatic File Extension" which is checked and a valid filter is currently selected
  47         the dialog may automatically add an extension to the selected file name(s).</p>
  48     */
  49     sequence< string > getSelectedFiles();
  50 };
  51
  52
  53 }; }; }; }; };
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */