dom/webidl/FakePluginTagInit.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  */
   6
   7 /**
   8  * A fake plugin is fundamentally identified by its handlerURI.
   9  *
  10  * In addition to that, a fake plugin registration needs to provide at least one
  11  * FakePluginMimeEntry so we'll know what types(s) the plugin is registered for.
  12  * Other information is optional, though having usable niceName is highly
  13  * recommended.
  14  */
  15 [GenerateInit]
  16 dictionary FakePluginTagInit {
  17   required DOMString handlerURI;
  18   required sequence<FakePluginMimeEntry> mimeEntries;
  19
  20   // The niceName should really be provided, and be unique, if possible; it can
  21   // be used as a key to persist state for this plug-in.
  22   DOMString niceName = "";
  23
  24   // Other things can be provided but don't really matter that much.
  25   DOMString fullPath = "";
  26   DOMString name = "";
  27   DOMString description = "";
  28   DOMString fileName = "";
  29   DOMString version = "";
  30
  31   /**
  32    * Optional script to run in a sandbox when instantiating a plugin. The script
  33    * runs in a sandbox with system principal in the process that contains the
  34    * element that instantiates the plugin (ie the EMBED or OBJECT element). The
  35    * sandbox global has a 'pluginElement' property that the script can use to
  36    * access the element that instantiates the plugin.
  37    */
  38   DOMString sandboxScript = "";
  39 };
  40
  41 /**
  42  * A single MIME entry for the fake plugin.
  43  */
  44 dictionary FakePluginMimeEntry {
  45   required DOMString type;
  46   DOMString description = "";
  47   DOMString extension = "";
  48 };