blob: 2265ecab2346e1f090dfd3f752d681fff7c8c501 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/*************************************************************************
*
* 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
|
