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