diff options
Diffstat (limited to 'offapi/com/sun/star/ui/dialogs/XFilePicker.idl')
| -rw-r--r-- | offapi/com/sun/star/ui/dialogs/XFilePicker.idl | 90 |
1 files changed, 49 insertions, 41 deletions
diff --git a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl index 4b1d84ce004f..a97401d50df7 100644 --- a/offapi/com/sun/star/ui/dialogs/XFilePicker.idl +++ b/offapi/com/sun/star/ui/dialogs/XFilePicker.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFilePicker.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-02 12:09:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:42 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,34 +78,32 @@ module com { module sun { module star { module ui { module dialogs { //============================================================================= -/** specifies an interface for a filepicker +/** Specifies an interface for a FilePicker */ interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog { //------------------------------------------------------------------------- - /** enable/disable multiselection mode + /** Enable/disable multiselection mode <p>If the multiselection mode is enabled, multiple files - may be selected else only one selection is possible</p> + may be selected bz the user else only one file selection at a time is possible</p> @param bMode - True enables multiselection mode, - False disables multiselection mode. This is the default - value + <p>A value of <TRUE/> enables the multiselection mode.</p> + <p>A value of <FALSE/> disables the multiselection mode, this is the default.</p> */ void setMultiSelectionMode( [in] boolean bMode ); //------------------------------------------------------------------------- - /** Sets the default string that appears in the edit field of the FilePicker - dialog where the user may enter a file name. + /** Sets the default string that appears in the file name box of a FilePicker. @param aName - <p> 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, if the file exists, etc. - </p> + <p> 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. + </p> */ void setDefaultName( [in] string aName ); @@ -113,11 +111,11 @@ interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog /** Sets the directory that the file dialog initially displays. @param aDirectory - Specifies the initial directory in URL format. The given URL has to - follow the rules of rfc1738. + Specifies the initial directory in URL format. The given URL must be + conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). @throws com::sun::star::lang::IllegalArgumentException - If the URL is invalid (doesn't conform to rfc1738). + if the URL is invalid (doesn't conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>). */ void setDisplayDirectory( [in] string aDirectory ) raises( ::com::sun::star::lang::IllegalArgumentException ); @@ -128,41 +126,45 @@ interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog did cancel the dialog, the returned value is undefined. @returns - The directory in URL format. + The directory in URL format, must be conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. */ string getDisplayDirectory(); //------------------------------------------------------------------------- /** Returns a sequence of the selected files including path information in - URL format. + URL format, conform to <a href="http://www.w3.org/Addressing/rfc1738.txt">Rfc1738</a>. <p>If the user closed the dialog with cancel an empty sequence will be - returned. - - <p>If the dialog is in execution mode only a single file URL will be - returned or an empty sequence, if multiple files have been selected, or - the current selected file is not a valid file name or any other error - occurs. -<!-- JRH: please check and clarify the previous paragraph --> + returned.</p> + <br/> + <p>If the dialog is in execution mode and a single file is selected + the complete URL of this file will be returned.</p> + <p>If the dialog is in execution mode and multiple files are selected + an empty sequence will be returned.</p> + <p>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.</p> @returns <p> The complete path of the file or directory currently selected in URL format. There are two different cases: - 1. Multiselection is disabled: - The first and only entry of the sequence contains the complete - path/filename in URL format. - - 2. Multiselection 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 one of the selected - file names. - - <p>Notes for the implementation of a FileSave dialog: If there exists - a checkbox "Automatic File Extension" and it is checked the dialog should - automatically add an extension to the file name, if one is selected in the - filter listbox.</p> + <ol> + <li>Multiselection is disabled: + The first and only entry of the sequence contains the complete + path/filename in URL format.</li> + + <li>Multiselection 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.</li> + </ol> + + <br/> + + <p><strong>Notes for the implementation of a FileSave dialog:</strong>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.</p> </p> */ sequence< string > getFiles(); @@ -175,6 +177,12 @@ interface XFilePicker: com::sun::star::ui::dialogs::XExecutableDialog /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2.2.1 2002/01/30 11:44:29 tra + #97073#reviewd + + Revision 1.2 2001/11/02 12:09:19 mi + proofreading and corrections from Richard Holt + Revision 1.1 2001/08/30 10:20:36 tra #88584#moved from drafts |