xref: /trunk/main/offapi/com/sun/star/ui/dialogs/XFilePicker2.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_ui_dialogs_XFilePicker2_idl__
#define __com_sun_star_ui_dialogs_XFilePicker2_idl__

#ifndef __com_sun_star_ui_dialogs_XFilePicker_idl__
#include <com/sun/star/ui/dialogs/XFilePicker.idl>
#endif

//=============================================================================

module com { module sun { module star { module ui { module dialogs {

//=============================================================================
/** extends file picker interface to workaround some design problems.
*/
interface XFilePicker2 : ::com::sun::star::ui::dialogs::XFilePicker
{
	//-------------------------------------------------------------------------
	/**	Returns a sequence of the selected files including path information in
		URL format, conform 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 user closed the dialog with OK a list of all selected files will be returned.</p>

        @attention
        <p>
        Instead to the method getFiles() of base interface XFilePicker the new method return
        full qualified URL's for every selected file.
        </p>

        @returns
		<p>A list of all selected file as complete URL's.</p>
        <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(s).</p>
	*/
	sequence< string > getSelectedFiles();
};

//=============================================================================

}; }; }; }; };

#endif