Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: ui :: dialogs ::

interface XFolderPicker
Base Interfaces
XFolderPicker
┗ XExecutableDialog
XExecutableDialog
(referenced interface's summary:)
Specifies an interface for an executable dialog.
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  aDirectory )
raises( ::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 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 © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.