offapi/com/sun/star/ui/dialogs/XFolderPicker.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFolderPicker.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ui_dialogs_XFolderPicker_idl__
  31 #define __com_sun_star_ui_dialogs_XFolderPicker_idl__
  32
  33 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_uno_XInterface_idl__
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ui_dialogs_XExecutableDialog_idl__
  42 #include <com/sun/star/ui/dialogs/XExecutableDialog.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module ui { module dialogs {
  48
  49 //=============================================================================
  50 /** Specifies a FolderPicker interface.
  51 */
  52
  53 published interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog
  54 {
  55     //-------------------------------------------------------------------------
  56     /** Sets the root directory that the FolderPicker should display.
  57         It is not specified which root directory the FolderPicker
  58         chooses if the specified root directory doesn't exist.
  59
  60         @param aDirectory
  61         Specifies the root directory in url format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
  62
  63         @throws com::sun::star::lang::IllegalArgumentException
  64         if the given url is invalid.
  65     */
  66     void setDisplayDirectory( [in] string aDirectory )
  67         raises( ::com::sun::star::lang::IllegalArgumentException );
  68
  69     //-------------------------------------------------------------------------
  70     /** Returns the root directory that the FolderPicker is showing. The
  71         return value is undefined if the client did not choose a root directory
  72         or the previously specified root directory doesn't exist.
  73
  74         @returns
  75         The directory in url format.
  76      */
  77     string getDisplayDirectory();
  78
  79     //-------------------------------------------------------------------------
  80     /** Returns the selected directory as url conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
  81
  82         @returns
  83         The selected directory as url if the user did close the dialog with ok
  84         else the returned value is undefined.
  85     */
  86     string getDirectory( );
  87
  88     //-------------------------------------------------------------------------
  89     /** The implementation may optionally show the given text as a description
  90         for the user within the dialog, e.g. "Please select a directory".
  91         If the client doesn't set a description the dialog may show a default
  92         description.
  93     */
  94     void setDescription( [in] string aDescription );
  95 };
  96
  97 //=============================================================================
  98
  99 }; }; }; }; };
 100
 101
 102 #endif
 103