DXR will be turned off on Tuesday, December 29th. It will redirect to Searchfox.
See the announcement on Discourse.

DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (c68fe15a81fc)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
/* -*- Mode: IDL; 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"

webidl Element;

/**
/**
 * An interface used to construct native toolbar or context menus from <menu>
 */

[scriptable, uuid(93F4A48F-D043-4F45-97FD-9771EA1AF976)]
interface nsIMenuBuilder : nsISupports
interface nsIMenuBuilder : nsISupports
{

  /**
   * Create the top level menu or a submenu. The implementation should create
   * a new context for this menu, so all subsequent methods will add new items
   * a new context for this menu, so all subsequent methods will add new items
   * to this newly created menu.
   */
  void openContainer(in AString aLabel);

  /**
  /**
   * Add a new menu item. All menu item details can be obtained from
   * the element. This method is not called for hidden elements or elements
   * with no or empty label. The icon should be loaded only if aCanLoadIcon
   * is true.
   */
  void addItemFor(in Element aElement,
                  in boolean aCanLoadIcon);


  /**
   * Create a new separator.
   */
  void addSeparator();


  /**
   * Remove last added separator.
   * Sometimes it's needed to remove last added separator, otherwise it's not
   * possible to implement the postprocessing in one pass.
   * See http://www.whatwg.org/specs/web-apps/current-work/multipage/interactive-elements.html#building-menus-and-toolbars
   * See http://www.whatwg.org/specs/web-apps/current-work/multipage/interactive-elements.html#building-menus-and-toolbars
   */
  void undoAddSeparator();

  /**
   * Set the context to the parent menu.
   * Set the context to the parent menu.
   */
  void closeContainer();

  /**
   * Returns a JSON string representing the menu hierarchy. For a context menu,
   * Returns a JSON string representing the menu hierarchy. For a context menu,
   * it will be of the form:
   *  {
   *    type: "menu",
   *    children: [
   *    children: [
   *      {
   *        type: "menuitem",
   *        label: "label",
   *        icon: "image.png"
   *      },
   *      },
   *      {
   *        type: "separator",
   *      },
   *    ];
   */
   */
  AString toJSONString();

  /**
  /**
   * Invoke the action of the menuitem with assigned id aGeneratedItemId.
   * Invoke the action of the menuitem with assigned id aGeneratedItemId.
   *
   * @param aGeneratedItemId the menuitem id
   */
   */
  void click(in AString aGeneratedItemId);
};