1999-11-15 12:32:51 +03:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
*
|
1999-11-15 13:19:00 +03:00
|
|
|
* The contents of this file are subject to the Mozilla Public
|
1999-11-15 12:32:51 +03:00
|
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
|
|
* except in compliance with the License. You may obtain a copy of
|
1999-11-15 13:19:00 +03:00
|
|
|
* the License at http://www.mozilla.org/MPL/
|
|
|
|
*
|
1999-11-15 12:32:51 +03:00
|
|
|
* Software distributed under the License is distributed on an "AS
|
|
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
|
|
* implied. See the License for the specific language governing
|
|
|
|
* rights and limitations under the License.
|
1999-11-15 13:19:00 +03:00
|
|
|
*
|
|
|
|
* The Original Code is the Mozilla browser.
|
|
|
|
*
|
1999-11-15 12:32:51 +03:00
|
|
|
* The Initial Developer of the Original Code is Netscape
|
1999-11-15 13:19:00 +03:00
|
|
|
* Communications Corporation. Portions created by Netscape are
|
|
|
|
* Copyright (C) 1999 Netscape Communications Corporation. All
|
1999-11-15 12:32:51 +03:00
|
|
|
* Rights Reserved.
|
1999-11-15 13:19:00 +03:00
|
|
|
*
|
1999-11-15 12:32:51 +03:00
|
|
|
* Contributor(s):
|
1999-11-15 13:19:00 +03:00
|
|
|
* Stuart Parmenter <pavlov@netscape.com>
|
1999-11-15 12:32:51 +03:00
|
|
|
*/
|
|
|
|
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
|
2001-07-16 06:40:48 +04:00
|
|
|
interface nsILocalFile;
|
|
|
|
interface nsIFileURL;
|
2000-09-01 05:54:35 +04:00
|
|
|
interface nsIDOMWindowInternal;
|
2002-09-07 09:23:45 +04:00
|
|
|
interface nsISimpleEnumerator;
|
1999-11-15 12:32:51 +03:00
|
|
|
|
|
|
|
[scriptable, uuid(c47de916-1dd1-11b2-8141-82507fa02b21)]
|
|
|
|
interface nsIFilePicker : nsISupports
|
|
|
|
{
|
2000-03-29 05:42:45 +04:00
|
|
|
const short modeOpen = 0; // Load a file or directory
|
1999-11-15 13:19:00 +03:00
|
|
|
const short modeSave = 1; // Save a file or directory
|
2001-12-09 04:36:47 +03:00
|
|
|
const short modeGetFolder = 2; // Select a folder/directory
|
2002-09-07 09:23:45 +04:00
|
|
|
const short modeOpenMultiple= 3; // Load multiple files
|
1999-11-15 12:32:51 +03:00
|
|
|
|
2001-12-09 04:36:47 +03:00
|
|
|
const short returnOK = 0; // User hit Ok, process selection
|
|
|
|
const short returnCancel = 1; // User hit cancel, ignore selection
|
1999-11-15 12:32:51 +03:00
|
|
|
const short returnReplace = 2; // User acknowledged file already exists so ok to replace, process selection
|
|
|
|
|
2000-03-23 10:41:09 +03:00
|
|
|
const long filterAll = 0x01; // *.*
|
|
|
|
const long filterHTML = 0x02; // *.html; *.htm
|
|
|
|
const long filterText = 0x04; // *.txt
|
|
|
|
const long filterImages = 0x08; // *.png; *.gif; *.jpg; *.jpeg
|
|
|
|
const long filterXML = 0x10; // *.xml
|
|
|
|
const long filterXUL = 0x20; // *.xul
|
2002-07-07 11:21:45 +04:00
|
|
|
const long filterApps = 0x40; // Applications (per-platform implementation)
|
2000-03-23 10:41:09 +03:00
|
|
|
|
1999-11-15 12:32:51 +03:00
|
|
|
/**
|
2000-03-23 10:52:28 +03:00
|
|
|
* Initialize the file widget.
|
1999-11-15 12:32:51 +03:00
|
|
|
*
|
2001-12-09 04:36:47 +03:00
|
|
|
* @param parent nsIDOMWindowInternal parent. This dialog should be dependent on this parent.
|
1999-11-15 12:32:51 +03:00
|
|
|
* @param title The title for the file widget
|
|
|
|
* @param mode load, save, or get folder
|
|
|
|
*
|
|
|
|
*/
|
2000-09-01 05:54:35 +04:00
|
|
|
void init(in nsIDOMWindowInternal parent, in wstring title, in short mode);
|
1999-11-15 12:32:51 +03:00
|
|
|
|
|
|
|
/**
|
2000-05-25 04:44:10 +04:00
|
|
|
* Append to the filter list with things from the predefined list
|
1999-11-15 12:32:51 +03:00
|
|
|
*
|
2000-03-23 10:41:09 +03:00
|
|
|
* @param filters mask of filters i.e. (filterAll | filterHTML)
|
1999-11-15 12:32:51 +03:00
|
|
|
*
|
|
|
|
*/
|
2000-05-25 04:44:10 +04:00
|
|
|
void appendFilters(in long filterMask);
|
1999-11-15 12:32:51 +03:00
|
|
|
|
|
|
|
/**
|
2000-03-23 10:41:09 +03:00
|
|
|
* Add a filter
|
1999-11-15 12:32:51 +03:00
|
|
|
*
|
2000-03-23 10:41:09 +03:00
|
|
|
* @param title name of the filter
|
2001-12-09 04:36:47 +03:00
|
|
|
* @param filter extensions to filter -- semicolon and space separated
|
1999-11-15 12:32:51 +03:00
|
|
|
*
|
|
|
|
*/
|
2000-03-23 10:41:09 +03:00
|
|
|
void appendFilter(in wstring title,
|
|
|
|
in wstring filter);
|
1999-11-15 12:32:51 +03:00
|
|
|
|
2002-02-20 10:50:52 +03:00
|
|
|
/**
|
|
|
|
* The filename that should be suggested to the user as a default.
|
|
|
|
*
|
|
|
|
* @throws NS_ERROR_FAILURE on attempts to get
|
|
|
|
*/
|
2000-05-23 02:19:00 +04:00
|
|
|
attribute wstring defaultString;
|
1999-11-15 12:32:51 +03:00
|
|
|
|
2002-02-20 10:50:52 +03:00
|
|
|
/**
|
|
|
|
* The extension that should be associated with files of the type we
|
|
|
|
* want to work with. On some platforms, this extension will be
|
|
|
|
* automatically appended to filenames the user enters, if needed.
|
|
|
|
*/
|
|
|
|
attribute wstring defaultExtension;
|
|
|
|
|
2001-12-12 07:17:26 +03:00
|
|
|
/**
|
|
|
|
* The filter which is currently selected in the File Picker dialog
|
|
|
|
*
|
|
|
|
* @return Returns the index (0 based) of the selected filter in the filter list.
|
|
|
|
*/
|
|
|
|
attribute long filterIndex;
|
|
|
|
|
1999-11-15 12:32:51 +03:00
|
|
|
/**
|
|
|
|
* Set the directory that the file open/save dialog initially displays
|
|
|
|
*
|
|
|
|
* @param displayDirectory the name of the directory
|
|
|
|
*
|
|
|
|
*/
|
2000-03-22 12:17:01 +03:00
|
|
|
attribute nsILocalFile displayDirectory;
|
1999-11-15 12:32:51 +03:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
2000-04-05 03:50:41 +04:00
|
|
|
* Get the nsILocalFile for the file or directory.
|
1999-11-15 12:32:51 +03:00
|
|
|
*
|
|
|
|
* @return Returns the file currently selected
|
|
|
|
*/
|
2000-03-22 12:17:01 +03:00
|
|
|
readonly attribute nsILocalFile file;
|
1999-11-15 12:32:51 +03:00
|
|
|
|
2000-04-05 03:50:41 +04:00
|
|
|
/**
|
|
|
|
* Get the nsIFileURL for the file or directory.
|
|
|
|
*
|
|
|
|
* @return Returns the file currently selected
|
|
|
|
*/
|
|
|
|
readonly attribute nsIFileURL fileURL;
|
|
|
|
|
2002-09-07 09:23:45 +04:00
|
|
|
/**
|
|
|
|
* Get the enumerator for the selected files
|
|
|
|
* only works in the modeOpenMultiple mode
|
|
|
|
*
|
|
|
|
* @return Returns the files currently selected
|
|
|
|
*/
|
|
|
|
readonly attribute nsISimpleEnumerator files;
|
|
|
|
|
1999-11-15 12:32:51 +03:00
|
|
|
/**
|
|
|
|
* Show File Dialog. The dialog is displayed modally.
|
|
|
|
*
|
1999-11-15 13:19:00 +03:00
|
|
|
* @return returnOK if the user selects OK, returnCancel if the user selects cancel
|
1999-11-15 12:32:51 +03:00
|
|
|
*
|
|
|
|
*/
|
1999-11-15 13:19:00 +03:00
|
|
|
short show();
|
1999-11-15 12:32:51 +03:00
|
|
|
};
|