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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module ui { module dialogs {
  22
  23 /** Specifies a FolderPicker interface.
  24 */
  25
  26 published interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog
  27 {
  28     /** Sets the root directory that the FolderPicker should display.
  29         It is not specified which root directory the FolderPicker
  30         chooses if the specified root directory doesn't exist.
  31
  32         @param aDirectory
  33         Specifies the root directory in url format, conforming to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
  34
  35         @throws com::sun::star::lang::IllegalArgumentException
  36         if the given url is invalid.
  37     */
  38     void setDisplayDirectory( [in] string aDirectory )
  39         raises( ::com::sun::star::lang::IllegalArgumentException );
  40
  41     /** Returns the root directory that the FolderPicker is showing. The
  42         return value is undefined if the client did not choose a root directory
  43         or the previously specified root directory doesn't exist.
  44
  45         @returns
  46         The directory in url format.
  47      */
  48     string getDisplayDirectory();
  49
  50     /** Returns the selected directory as url conforming to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.
  51
  52         @returns
  53         The selected directory as url if the user did close the dialog with Ok
  54         else the returned value is undefined.
  55     */
  56     string getDirectory( );
  57
  58     /** The implementation may optionally show the given text as a description
  59         for the user within the dialog, e.g. "Please select a directory".
  60         If the client doesn't set a description the dialog may show a default
  61         description.
  62     */
  63     void setDescription( [in] string aDescription );
  64 };
  65
  66
  67 }; }; }; }; };
  68
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */