mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 00:25:27 +00:00
148 lines
5.3 KiB
Plaintext
148 lines
5.3 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIFile;
|
|
interface nsIURI;
|
|
interface nsIDOMWindow;
|
|
interface nsISimpleEnumerator;
|
|
|
|
[scriptable, uuid(f2c0e216-5d07-4df4-bbcb-37683077ae7e)]
|
|
interface nsIFilePicker : nsISupports
|
|
{
|
|
const short modeOpen = 0; // Load a file or directory
|
|
const short modeSave = 1; // Save a file or directory
|
|
const short modeGetFolder = 2; // Select a folder/directory
|
|
const short modeOpenMultiple= 3; // Load multiple files
|
|
|
|
const short returnOK = 0; // User hit Ok, process selection
|
|
const short returnCancel = 1; // User hit cancel, ignore selection
|
|
const short returnReplace = 2; // User acknowledged file already exists so ok to replace, process selection
|
|
|
|
const long filterAll = 0x001; // *.*
|
|
const long filterHTML = 0x002; // *.html; *.htm
|
|
const long filterText = 0x004; // *.txt
|
|
const long filterImages = 0x008; // *.jpe; *.jpg; *.jpeg; *.gif;
|
|
// *.png; *.bmp; *.ico; *.svg;
|
|
// *.svgz; *.tif; *.tiff; *.ai;
|
|
// *.drw; *.pct; *.psp; *.xcf;
|
|
// *.psd; *.raw
|
|
const long filterXML = 0x010; // *.xml
|
|
const long filterXUL = 0x020; // *.xul
|
|
const long filterApps = 0x040; // Applications (per-platform implementation)
|
|
const long filterAllowURLs = 0x080; // Allow URLs
|
|
const long filterAudio = 0x100; // *.aac; *.aif; *.flac; *.iff;
|
|
// *.m4a; *.m4b; *.mid; *.midi;
|
|
// *.mp3; *.mpa; *.mpc; *.oga;
|
|
// *.ogg; *.ra; *.ram; *.snd;
|
|
// *.wav; *.wma
|
|
const long filterVideo = 0x200; // *.avi; *.divx; *.flv; *.m4v;
|
|
// *.mkv; *.mov; *.mp4; *.mpeg;
|
|
// *.mpg; *.ogm; *.ogv; *.ogx;
|
|
// *.rm; *.rmvb; *.smil; *.webm;
|
|
// *.wmv; *.xvid
|
|
|
|
/**
|
|
* Initialize the file picker widget. The file picker is not valid until this
|
|
* method is called.
|
|
*
|
|
* @param parent nsIDOMWindow parent. This dialog will be dependent
|
|
* on this parent. parent must be non-null.
|
|
* @param title The title for the file widget
|
|
* @param mode load, save, or get folder
|
|
*
|
|
*/
|
|
void init(in nsIDOMWindow parent, in AString title, in short mode);
|
|
|
|
/**
|
|
* Append to the filter list with things from the predefined list
|
|
*
|
|
* @param filters mask of filters i.e. (filterAll | filterHTML)
|
|
*
|
|
*/
|
|
void appendFilters(in long filterMask);
|
|
|
|
/**
|
|
* Add a filter
|
|
*
|
|
* @param title name of the filter
|
|
* @param filter extensions to filter -- semicolon and space separated
|
|
*
|
|
*/
|
|
void appendFilter(in AString title,
|
|
in AString filter);
|
|
|
|
/**
|
|
* The filename that should be suggested to the user as a default. This should
|
|
* include the extension.
|
|
*
|
|
* @throws NS_ERROR_FAILURE on attempts to get
|
|
*/
|
|
attribute AString defaultString;
|
|
|
|
/**
|
|
* 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 AString defaultExtension;
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* Set the directory that the file open/save dialog initially displays
|
|
*
|
|
* @param displayDirectory the name of the directory
|
|
*
|
|
*/
|
|
attribute nsIFile displayDirectory;
|
|
|
|
|
|
/**
|
|
* Get the nsIFile for the file or directory.
|
|
*
|
|
* @return Returns the file currently selected
|
|
*/
|
|
readonly attribute nsIFile file;
|
|
|
|
/**
|
|
* Get the nsIURI for the file or directory.
|
|
*
|
|
* @return Returns the file currently selected
|
|
*/
|
|
readonly attribute nsIURI fileURL;
|
|
|
|
/**
|
|
* Get the enumerator for the selected files
|
|
* only works in the modeOpenMultiple mode
|
|
*
|
|
* @return Returns the files currently selected
|
|
*/
|
|
readonly attribute nsISimpleEnumerator files;
|
|
|
|
/**
|
|
* Controls whether the chosen file(s) should be added to the system's recent
|
|
* documents list. This attribute will be ignored if the system has no "Recent
|
|
* Docs" concept, or if the application is in private browsing mode (in which
|
|
* case the file will not be added). Defaults to true.
|
|
*/
|
|
attribute boolean addToRecentDocs;
|
|
|
|
/**
|
|
* Show File Dialog. The dialog is displayed modally.
|
|
*
|
|
* @return returnOK if the user selects OK, returnCancel if the user selects cancel
|
|
*
|
|
*/
|
|
short show();
|
|
};
|