Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: ui :: dialogs ::
interface XFolderPicker
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XExecutableDialog
          |
          +-XFolderPicker
Description Specifies a FolderPicker interface.

Methods' Summary
setDisplayDirectory | 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.
getDisplayDirectory | 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.
getDirectory | Returns the selected directory as url conform to Rfc1738 .
setDescription | 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.

Methods' Details
setDisplayDirectory
void setDisplayDirectory( | [in] string raises( | aDirectory ) ::com::sun::star::lang::IllegalArgumentException );
Description 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. Parameter aDirectory Specifies the root directory in url format, conform to Rfc1738 . Throws com::sun::star::lang::IllegalArgumentException if the given url is invalid.
getDisplayDirectory
string getDisplayDirectory(); |  |
Description 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 the directory in url format.
getDirectory
string getDirectory(); |  |
Description Returns the selected directory as url conform to Rfc1738 . Returns The selected directory as url if the user did close the dialog with ok else the returned value is undefined.
setDescription
void setDescription( | [in] string | aDescription );
Description 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.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.