Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: ui :: dialogs ::
interface XFilePicker
  Base Interfaces
      XFilePicker
      ┗ XExecutableDialog
  XExecutableDialog | (referenced interface's summary:) Specifies an interface for an executable dialog.
Description Specifies an interface for a FilePicker

Methods' Summary
setMultiSelectionMode | Enable/disable multi-selection mode
setDefaultName | Sets the default string that appears in the file name box of a FilePicker.
setDisplayDirectory | Sets the directory that the file dialog initially displays.
getDisplayDirectory | Returns the directory that the file dialog is currently showing or was last showing before closing the dialog with Ok. If the user did cancel the dialog, the returned value is undefined.
getFiles | Returns a sequence of the selected files including path information in URL format, conforming to Rfc1738.

Methods' Details
setMultiSelectionMode
void
setMultiSelectionMode( | [in] boolean | bMode );
Description Enable/disable multi-selection mode If the multi-selection mode is enabled, multiple files may be selected by the user else only one file selection at a time is possible Parameter bMode A value of true enables the multi-selection mode. A value of false disables the multi-selection mode, this is the default.
setDefaultName
void
setDefaultName( | [in] string | aName );
Description Sets the default string that appears in the file name box of a FilePicker. Parameter aName Specifies the default file name, displayed when the FilePicker is shown. The implementation may accept any string, and does not have to check for a valid file name or if the file really exists.
setDisplayDirectory
void
setDisplayDirectory( | [in] string | aDirectory )
raises( | ::com::sun::star::lang::IllegalArgumentException );
Description Sets the directory that the file dialog initially displays. Parameter aDirectory Specifies the initial directory in URL format. The given URL must conform to Rfc1738). Throws com::sun::star::lang::IllegalArgumentException if the URL is invalid (doesn't conform to Rfc1738).
getDisplayDirectory
string
getDisplayDirectory();
Description Returns the directory that the file dialog is currently showing or was last showing before closing the dialog with Ok. If the user did cancel the dialog, the returned value is undefined. Returns The directory in URL format, must conform to Rfc1738.
getFiles
sequence< string >
getFiles();
Description Returns a sequence of the selected files including path information in URL format, conforming to Rfc1738. If the user closed the dialog with cancel an empty sequence will be returned. If the dialog is in execution mode and a single file is selected the complete URL of this file will be returned. If the dialog is in execution mode and multiple files are selected an empty sequence will be returned. If the dialog is in execution mode and the selected file name is false or any other error occurs an empty sequence will be returned. Returns The complete path of the file or directory currently selected in URL format. There are two different cases: Multi-selection is disabled: The first and only entry of the sequence contains the complete path/filename in URL format. Multi-selection is enabled: If only one file is selected, the first entry of the sequence contains the complete path/filename in URL format. If multiple files are selected, the first entry of the sequence contains the path in URL format, and the other entries contains the names of the selected files without path information. Notes for the implementation of a FileSave dialog:If there exists a checkbox "Automatic File Extension" which is checked and a valid filter is currently selected the dialog may automatically add an extension to the selected file name.

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.