/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */


module com { module sun { module star { module ui { module dialogs {

/** Specifies a FolderPicker interface.
*/

published interface XFolderPicker: com::sun::star::ui::dialogs::XExecutableDialog
{
    /** Sets the root directory that the FolderPicker should display.
        It is not specified which root directory the FolderPicker
        chooses if the specified root directory doesn't exist.

        @param aDirectory
        Specifies the root directory in url format, conforming to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.

        @throws com::sun::star::lang::IllegalArgumentException
        if the given url is invalid.
    */
    void setDisplayDirectory( [in] string aDirectory )
        raises( ::com::sun::star::lang::IllegalArgumentException );

    /** Returns the root directory that the FolderPicker is showing. The
        return value is undefined if the client did not choose a root directory
        or the previously specified root directory doesn't exist.

        @returns
        The directory in url format.
     */
    string getDisplayDirectory();

    /** Returns the selected directory as url conforming to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>.

        @returns
        The selected directory as url if the user did close the dialog with Ok
        else the returned value is undefined.
    */
    string getDirectory( );

    /** The implementation may optionally show the given text as a description
        for the user within the dialog, e.g. "Please select a directory".
        If the client doesn't set a description the dialog may show a default
        description.
    */
    void setDescription( [in] string aDescription );
};


}; }; }; }; };


/* vim:set shiftwidth=4 softtabstop=4 expandtab: */