dom/html/nsIHTMLMenu.idl

   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
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 interface nsIMenuBuilder;
   9
  10 /**
  11  * A private interface.
  12  * All methods throw NS_ERROR_DOM_SECURITY_ERR if the caller is not chrome.
  13  */
  14
  15 [scriptable, uuid(d3d068d8-e223-4228-ba39-4d6df21ba616)]
  16 interface nsIHTMLMenu : nsISupports
  17 {
  18   /**
  19    * Creates and dispatches a trusted event named "show".
  20    * The event is not cancelable and does not bubble.
  21    * See http://www.whatwg.org/specs/web-apps/current-work/multipage/interactive-elements.html#context-menus
  22    */
  23   void sendShowEvent();
  24
  25   /**
  26    * Creates a native menu builder. The builder type is dependent on menu type.
  27    * Currently, it returns nsXULContextMenuBuilder for context menus.
  28    * Toolbar menus are not yet supported (the method returns null).
  29    */
  30   nsIMenuBuilder createBuilder();
  31
  32   /*
  33    * Builds a menu by iterating over menu children.
  34    * See http://www.whatwg.org/specs/web-apps/current-work/multipage/interactive-elements.html#building-menus-and-toolbars
  35    * The caller can use a native builder by calling createBuilder() or provide
  36    * a custom builder that implements the nsIMenuBuilder interface.
  37    * A custom builder can be used for example to build native context menus
  38    * that are not defined using <menupopup>.
  39    */
  40   void build(in nsIMenuBuilder aBuilder);
  41
  42 };