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#ifndef __com_sun_star_ui_dialogs_XFolderPicker_idl__
28#define __com_sun_star_ui_dialogs_XFolderPicker_idl__
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34#ifndef __com_sun_star_uno_XInterface_idl__
35#include <com/sun/star/uno/XInterface.idl>
36#endif
37
38#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__
39#include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module ui { module dialogs {
45
46//=============================================================================
47/** Specifies a FolderPicker interface.
48*/
49
50published interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog
51{
52	//-------------------------------------------------------------------------
53	/**	Sets the root directory that the FolderPicker should display.
54		It is not specified which root directory the FolderPicker
55		chooses if the specified root directory doesn't exist.
56
57		@param aDirectory
58		Specifies the root directory in url format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
59
60		@throws	com::sun::star::lang::IllegalArgumentException
61		if the given url is invalid.
62	*/
63	void setDisplayDirectory( [in] string aDirectory )
64		raises( ::com::sun::star::lang::IllegalArgumentException );
65
66	//-------------------------------------------------------------------------
67	/**	Returns the root directory that the FolderPicker is showing. The
68		return value is undefined if the client did not choose a root directory
69		or the previously specified root directory doesn't exist.
70
71		@returns
72		The directory in url format.
73	 */
74	string getDisplayDirectory();
75
76	//-------------------------------------------------------------------------
77	/** Returns the selected directory as url conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
78
79		@returns
80		The selected directory as url if the user did close the dialog with ok
81		else the returned value is undefined.
82	*/
83	string getDirectory( );
84
85	//-------------------------------------------------------------------------
86	/** The implementation may optionally show the given text as a description
87		for the user within the dialog, e.g. "Please select a directory".
88		If the client doesn't set a description the dialog may show a default
89		description.
90	*/
91	void setDescription( [in] string aDescription );
92};
93
94//=============================================================================
95
96}; }; }; }; };
97
98
99#endif
100
101