1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_ui_dialogs_XFolderPicker_idl__ 24#define __com_sun_star_ui_dialogs_XFolderPicker_idl__ 25 26#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 27#include <com/sun/star/lang/IllegalArgumentException.idl> 28#endif 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__ 35#include <com/sun/star/ui/dialogs/XExecutableDialog.idl> 36#endif 37 38//============================================================================= 39 40module com { module sun { module star { module ui { module dialogs { 41 42//============================================================================= 43/** Specifies a FolderPicker interface. 44*/ 45 46published interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog 47{ 48 //------------------------------------------------------------------------- 49 /** Sets the root directory that the FolderPicker should display. 50 It is not specified which root directory the FolderPicker 51 chooses if the specified root directory doesn't exist. 52 53 @param aDirectory 54 Specifies the root directory in url format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. 55 56 @throws com::sun::star::lang::IllegalArgumentException 57 if the given url is invalid. 58 */ 59 void setDisplayDirectory( [in] string aDirectory ) 60 raises( ::com::sun::star::lang::IllegalArgumentException ); 61 62 //------------------------------------------------------------------------- 63 /** Returns the root directory that the FolderPicker is showing. The 64 return value is undefined if the client did not choose a root directory 65 or the previously specified root directory doesn't exist. 66 67 @returns 68 The directory in url format. 69 */ 70 string getDisplayDirectory(); 71 72 //------------------------------------------------------------------------- 73 /** Returns the selected directory as url conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. 74 75 @returns 76 The selected directory as url if the user did close the dialog with ok 77 else the returned value is undefined. 78 */ 79 string getDirectory( ); 80 81 //------------------------------------------------------------------------- 82 /** The implementation may optionally show the given text as a description 83 for the user within the dialog, e.g. "Please select a directory". 84 If the client doesn't set a description the dialog may show a default 85 description. 86 */ 87 void setDescription( [in] string aDescription ); 88}; 89 90//============================================================================= 91 92}; }; }; }; }; 93 94 95#endif 96 97