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