widget/nsIFilePicker.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 interface nsIFile;
  10 interface nsIURI;
  11 interface mozIDOMWindowProxy;
  12 interface nsISimpleEnumerator;
  13
  14 [scriptable, function, uuid(0d79adad-b244-49A5-9997-2a8cad93fc44)]
  15 interface nsIFilePickerShownCallback : nsISupports
  16 {
  17  /**
  18   * Callback which is called when a filepicker is shown and a result
  19   * is returned.
  20   *
  21   * @param aResult One of returnOK, returnCancel, or returnReplace
  22   */
  23   void done(in short aResult);
  24 };
  25
  26 [scriptable, uuid(9285b984-02d3-46b4-9514-7da8c471a747)]
  27 interface nsIFilePicker : nsISupports
  28 {
  29   const short modeOpen        = 0;              // Load a file or directory
  30   const short modeSave        = 1;              // Save a file or directory
  31   const short modeGetFolder   = 2;              // Select a folder/directory
  32   const short modeOpenMultiple= 3;              // Load multiple files
  33
  34   const short returnOK        = 0;              // User hit Ok, process selection
  35   const short returnCancel    = 1;              // User hit cancel, ignore selection
  36   const short returnReplace   = 2;              // User acknowledged file already exists so ok to replace, process selection
  37
  38   const long filterAll        = 0x001;          // *.*
  39   const long filterHTML       = 0x002;          // *.html; *.htm
  40   const long filterText       = 0x004;          // *.txt
  41   const long filterImages     = 0x008;          // *.jpe; *.jpg; *.jpeg; *.gif;
  42                                                 // *.png; *.bmp; *.ico; *.svg;
  43                                                 // *.svgz; *.tif; *.tiff; *.ai;
  44                                                 // *.drw; *.pct; *.psp; *.xcf;
  45                                                 // *.psd; *.raw
  46   const long filterXML        = 0x010;          // *.xml
  47   const long filterXUL        = 0x020;          // *.xul
  48   const long filterApps       = 0x040;          // Applications (per-platform implementation)
  49   const long filterAllowURLs  = 0x080;          // Allow URLs
  50   const long filterAudio      = 0x100;          // *.aac; *.aif; *.flac; *.iff;
  51                                                 // *.m4a; *.m4b; *.mid; *.midi;
  52                                                 // *.mp3; *.mpa; *.mpc; *.oga;
  53                                                 // *.ogg; *.ra; *.ram; *.snd;
  54                                                 // *.wav; *.wma
  55   const long filterVideo      = 0x200;          // *.avi; *.divx; *.flv; *.m4v;
  56                                                 // *.mkv; *.mov; *.mp4; *.mpeg;
  57                                                 // *.mpg; *.ogm; *.ogv; *.ogx;
  58                                                 // *.rm; *.rmvb; *.smil; *.webm;
  59                                                 // *.wmv; *.xvid
  60
  61  /**
  62   * Initialize the file picker widget.  The file picker is not valid until this
  63   * method is called.
  64   *
  65   * @param      parent   mozIDOMWindow parent.  This dialog will be dependent
  66   *                      on this parent. parent must be non-null.
  67   * @param      title    The title for the file widget
  68   * @param      mode     load, save, or get folder
  69   *
  70   */
  71   void init(in mozIDOMWindowProxy parent, in AString title, in short mode);
  72
  73  /**
  74   * Append to the  filter list with things from the predefined list
  75   *
  76   * @param      filters  mask of filters i.e. (filterAll | filterHTML)
  77   *
  78   */
  79   void appendFilters(in long filterMask);
  80
  81  /**
  82   * Add a filter
  83   *
  84   * @param      title    name of the filter
  85   * @param      filter   extensions to filter -- semicolon and space separated
  86   *
  87   */
  88   void appendFilter(in AString title,
  89                     in AString filter);
  90
  91  /**
  92   * The filename that should be suggested to the user as a default. This should
  93   * include the extension.
  94   *
  95   * @throws NS_ERROR_FAILURE on attempts to get
  96   */
  97   attribute AString defaultString;
  98
  99  /**
 100   * The extension that should be associated with files of the type we
 101   * want to work with.  On some platforms, this extension will be
 102   * automatically appended to filenames the user enters, if needed.
 103   */
 104   attribute AString defaultExtension;
 105
 106  /**
 107   * The filter which is currently selected in the File Picker dialog
 108   *
 109   * @return Returns the index (0 based) of the selected filter in the filter list.
 110   */
 111   attribute long filterIndex;
 112
 113  /**
 114   * Set the directory that the file open/save dialog initially displays
 115   * Note that, if displaySpecialDirectory has been already set, this value will
 116   * be ignored.
 117   *
 118   * @param      displayDirectory  the name of the directory
 119   *
 120   */
 121   attribute nsIFile displayDirectory;
 122
 123  /**
 124   * Set the directory that the file open/save dialog initially displays using
 125   * one of the special name as such as 'Desk', 'TmpD', and so on.
 126   * Note that, if displayDirectory has been already set, this value will be
 127   * ignored.
 128   *
 129   * @param      displaySpecialDirectory  the name of the special directory
 130   *
 131   */
 132   attribute AString displaySpecialDirectory;
 133
 134
 135  /**
 136   * Get the nsIFile for the file or directory.
 137   *
 138   * @return Returns the file currently selected
 139   */
 140   readonly attribute nsIFile file;
 141
 142  /**
 143   * Get the nsIURI for the file or directory.
 144   *
 145   * @return Returns the file currently selected
 146   */
 147   readonly attribute nsIURI fileURL;
 148
 149  /**
 150   * Get the enumerator for the selected files
 151   * only works in the modeOpenMultiple mode
 152   *
 153   * @return Returns the files currently selected
 154   */
 155   readonly attribute nsISimpleEnumerator files;
 156
 157  /**
 158   * Get the DOM File or the DOM Directory
 159   *
 160   * @return Returns the file or directory currently selected DOM object.
 161   */
 162   readonly attribute nsISupports domFileOrDirectory;
 163
 164  /**
 165   * Get the enumerator for the selected files or directories
 166   * only works in the modeOpenMultiple mode
 167   *
 168   * @return Returns the files/directories currently selected as DOM object.
 169   */
 170   readonly attribute nsISimpleEnumerator domFileOrDirectoryEnumerator;
 171
 172  /**
 173   * Controls whether the chosen file(s) should be added to the system's recent
 174   * documents list. This attribute will be ignored if the system has no "Recent
 175   * Docs" concept, or if the application is in private browsing mode (in which
 176   * case the file will not be added). Defaults to true.
 177   */
 178   attribute boolean addToRecentDocs;
 179
 180  /**
 181   * Opens the file dialog asynchrounously.
 182   * The passed in object's done method will be called upon completion.
 183   */
 184   void open(in nsIFilePickerShownCallback aFilePickerShownCallback);
 185
 186  /**
 187   * The picker's mode, as set by the 'mode' argument passed to init()
 188   * (one of the modeOpen et. al. constants specified above).
 189   */
 190   readonly attribute short mode;
 191
 192   /**
 193    * If set to non-empty string, the nsIFilePicker implementation
 194    * may use okButtonLabel as the label for the button the user uses to accept
 195    * file selection.
 196    */
 197   attribute AString okButtonLabel;
 198 };