xref: /aoo41x/main/offapi/com/sun/star/ui/dialogs/XFolderPicker.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_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 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