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

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