|
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 * The origin of this IDL file is |
|
7 * http://www.whatwg.org/specs/web-apps/current-work/#the-menu-element |
|
8 * http://www.whatwg.org/specs/web-apps/current-work/#other-elements,-attributes-and-apis |
|
9 * |
|
10 * © Copyright 2004-2011 Apple Computer, Inc., Mozilla Foundation, and |
|
11 * Opera Software ASA. You are granted a license to use, reproduce |
|
12 * and create derivative works of this document. |
|
13 */ |
|
14 |
|
15 interface MenuBuilder; |
|
16 |
|
17 // http://www.whatwg.org/specs/web-apps/current-work/#the-menu-element |
|
18 interface HTMLMenuElement : HTMLElement { |
|
19 [SetterThrows] |
|
20 attribute DOMString type; |
|
21 [SetterThrows] |
|
22 attribute DOMString label; |
|
23 }; |
|
24 |
|
25 // http://www.whatwg.org/specs/web-apps/current-work/#other-elements,-attributes-and-apis |
|
26 partial interface HTMLMenuElement { |
|
27 [SetterThrows] |
|
28 attribute boolean compact; |
|
29 }; |
|
30 |
|
31 // Mozilla specific stuff |
|
32 partial interface HTMLMenuElement { |
|
33 /** |
|
34 * Creates and dispatches a trusted event named "show". |
|
35 * The event is not cancelable and does not bubble. |
|
36 * See http://www.whatwg.org/specs/web-apps/current-work/multipage/interactive-elements.html#context-menus |
|
37 */ |
|
38 [ChromeOnly] |
|
39 void sendShowEvent(); |
|
40 |
|
41 /** |
|
42 * Creates a native menu builder. The builder type is dependent on menu type. |
|
43 * Currently, it returns nsXULContextMenuBuilder for context menus. |
|
44 * Toolbar menus are not yet supported (the method returns null). |
|
45 */ |
|
46 [ChromeOnly] |
|
47 MenuBuilder createBuilder(); |
|
48 |
|
49 /* |
|
50 * Builds a menu by iterating over menu children. |
|
51 * See http://www.whatwg.org/specs/web-apps/current-work/multipage/interactive-elements.html#building-menus-and-toolbars |
|
52 * The caller can use a native builder by calling createBuilder() or provide |
|
53 * a custom builder that implements the nsIMenuBuilder interface. |
|
54 * A custom builder can be used for example to build native context menus |
|
55 * that are not defined using <menupopup>. |
|
56 */ |
|
57 [ChromeOnly] |
|
58 void build(MenuBuilder aBuilder); |
|
59 }; |