Back to index

lightning-sunbird  0.9+nobinonly
nsIFilePicker.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the Mozilla browser.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Stuart Parmenter <pavlov@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsISupports.idl"
00041 
00042 interface nsILocalFile;
00043 interface nsIFileURL;
00044 interface nsIDOMWindow;
00045 interface nsISimpleEnumerator;
00046 
00047 [scriptable, uuid(80faf095-c807-4558-a2cc-185ed70754ea)]
00048 interface nsIFilePicker : nsISupports
00049 {
00050   const short modeOpen        = 0;              // Load a file or directory
00051   const short modeSave        = 1;              // Save a file or directory
00052   const short modeGetFolder   = 2;              // Select a folder/directory
00053   const short modeOpenMultiple= 3;              // Load multiple files
00054 
00055   const short returnOK        = 0;              // User hit Ok, process selection
00056   const short returnCancel    = 1;              // User hit cancel, ignore selection
00057   const short returnReplace   = 2;              // User acknowledged file already exists so ok to replace, process selection
00058 
00059   const long filterAll        = 0x01;           // *.*
00060   const long filterHTML       = 0x02;           // *.html; *.htm
00061   const long filterText       = 0x04;           // *.txt
00062   const long filterImages     = 0x08;           // *.png; *.gif; *.jpg; *.jpeg
00063   const long filterXML        = 0x10;           // *.xml
00064   const long filterXUL        = 0x20;           // *.xul
00065   const long filterApps       = 0x40;           // Applications (per-platform implementation)
00066 
00077   void init(in nsIDOMWindow parent, in AString title, in short mode);
00078 
00085   void appendFilters(in long filterMask);
00086 
00094   void appendFilter(in AString title,
00095                     in AString filter);
00096 
00102   attribute AString defaultString;
00103 
00109   attribute AString defaultExtension;
00110   
00116   attribute long filterIndex;
00117 
00124   attribute nsILocalFile displayDirectory;
00125 
00126 
00132   readonly attribute nsILocalFile file;
00133 
00139   readonly attribute nsIFileURL fileURL;
00140 
00147   readonly attribute nsISimpleEnumerator files;
00148 
00155   short show();
00156 };