summaryrefslogtreecommitdiffstats
path: root/dom/html/nsIHTMLMenu.idl
diff options
context:
space:
mode:
Diffstat (limited to 'dom/html/nsIHTMLMenu.idl')
-rw-r--r--dom/html/nsIHTMLMenu.idl42
1 files changed, 42 insertions, 0 deletions
diff --git a/dom/html/nsIHTMLMenu.idl b/dom/html/nsIHTMLMenu.idl
new file mode 100644
index 000000000..254b4aa92
--- /dev/null
+++ b/dom/html/nsIHTMLMenu.idl
@@ -0,0 +1,42 @@
+/* -*- 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"
+
+interface nsIMenuBuilder;
+
+/**
+ * A private interface.
+ * All methods throw NS_ERROR_DOM_SECURITY_ERR if the caller is not chrome.
+ */
+
+[scriptable, uuid(d3d068d8-e223-4228-ba39-4d6df21ba616)]
+interface nsIHTMLMenu : nsISupports
+{
+ /**
+ * Creates and dispatches a trusted event named "show".
+ * The event is not cancelable and does not bubble.
+ * See http://www.whatwg.org/specs/web-apps/current-work/multipage/interactive-elements.html#context-menus
+ */
+ void sendShowEvent();
+
+ /**
+ * Creates a native menu builder. The builder type is dependent on menu type.
+ * Currently, it returns nsXULContextMenuBuilder for context menus.
+ * Toolbar menus are not yet supported (the method returns null).
+ */
+ nsIMenuBuilder createBuilder();
+
+ /*
+ * Builds a menu by iterating over menu children.
+ * See http://www.whatwg.org/specs/web-apps/current-work/multipage/interactive-elements.html#building-menus-and-toolbars
+ * The caller can use a native builder by calling createBuilder() or provide
+ * a custom builder that implements the nsIMenuBuilder interface.
+ * A custom builder can be used for example to build native context menus
+ * that are not defined using <menupopup>.
+ */
+ void build(in nsIMenuBuilder aBuilder);
+
+};