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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ui_dialogs_XFilePicker2_idl__
  29 #define __com_sun_star_ui_dialogs_XFilePicker2_idl__
  30
  31 #ifndef __com_sun_star_ui_dialogs_XFilePicker_idl__
  32 #include <com/sun/star/ui/dialogs/XFilePicker.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module ui { module dialogs {
  38
  39 //=============================================================================
  40 /** extends file picker interface to workaround some design problems.
  41 */
  42 interface XFilePicker2 : ::com::sun::star::ui::dialogs::XFilePicker
  43 {
  44     //-------------------------------------------------------------------------
  45     /** Returns a sequence of the selected files including path information in
  46         URL format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
  47
  48         <p>If the user closed the dialog with cancel an empty sequence will be returned.</p>
  49         <br/>
  50
  51         <p>If the user closed the dialog with OK a list of all selected files will be returned.</p>
  52
  53         @attention
  54         <p>
  55         Instead to the method getFiles() of base interface XFilePicker the new method return
  56         full qualified URL's for every selected file.
  57         </p>
  58
  59         @returns
  60         <p>A list of all selected file as complete URL's.</p>
  61         <br/>
  62
  63         <p><strong>Notes for the implementation of a FileSave dialog:</strong>If there exists
  64         a checkbox "Automatic File Extension" which is checked and a valid filter is currently selected
  65         the dialog may automatically add an extension to the selected file name(s).</p>
  66     */
  67     sequence< string > getSelectedFiles();
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; }; };
  73
  74 #endif
  75