/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XFolderPicker.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 08:40:58 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_ui_dialogs_XFolderPicker_idl__
#define __com_sun_star_ui_dialogs_XFolderPicker_idl__

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__
#include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
#endif

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

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

//=============================================================================
/** Specifies a FolderPicker interface.
*/
 
published interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog
{
	//-------------------------------------------------------------------------
	/**	Sets the root directory that the FolderPicker should display.
		It is not specified which root directory the FolderPicker 
		chooses if the specified root directory doesn't exist.
		
		@param aDirectory
		Specifies the root directory in url format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. 
		
		@throws	com::sun::star::lang::IllegalArgumentException
		if the given url is invalid.
	*/
	void setDisplayDirectory( [in] string aDirectory )
		raises( ::com::sun::star::lang::IllegalArgumentException );

	//-------------------------------------------------------------------------
	/**	Returns the root directory that the FolderPicker is showing. The 
		return value is undefined if the client did not choose a root directory 
		or the previously specified root directory doesn't exist.

		@returns 
		The the directory in url format.
	 */
	string getDisplayDirectory();

	//-------------------------------------------------------------------------
	/** Returns the selected directory as url conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
		
		@returns
		The selected directory as url if the user did close the dialog with ok
		else the returned value is undefined.
	*/
	string getDirectory( );

	//-------------------------------------------------------------------------
	/** The implementation may optionally show the given text as a description 
		for the user within the dialog, e.g. "Please select a directory". 
		If the client doesn't set a description the dialog may show a default 
		description.
	*/
	void setDescription( [in] string aDescription );
};

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

}; }; }; }; };


#endif

