diff options
Diffstat (limited to 'dom/webidl/XULPopupElement.webidl')
| -rw-r--r-- | dom/webidl/XULPopupElement.webidl | 205 |
1 files changed, 205 insertions, 0 deletions
diff --git a/dom/webidl/XULPopupElement.webidl b/dom/webidl/XULPopupElement.webidl new file mode 100644 index 0000000000..793b53c10f --- /dev/null +++ b/dom/webidl/XULPopupElement.webidl @@ -0,0 +1,205 @@ +/* -*- 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/. */ + +dictionary OpenPopupOptions { + // manner in which to anchor the popup to node + DOMString position = ""; + // horizontal offset + long x = 0; + // vertical offset + long y = 0; + // isContextMenu true for context menus, false for other popups + boolean isContextMenu = false; + // true if popup node attributes override position + boolean attributesOverride = false; + // triggerEvent the event that triggered this popup (mouse click for example) + Event? triggerEvent = null; +}; + +dictionary ActivateMenuItemOptions { + boolean altKey = false; + boolean metaKey = false; + boolean ctrlKey = false; + boolean shiftKey = false; + short button = 0; +}; + +typedef (DOMString or OpenPopupOptions) StringOrOpenPopupOptions; + +[ChromeOnly, + Exposed=Window] +interface XULPopupElement : XULElement +{ + [HTMLConstructor] constructor(); + + /** + * Open the popup relative to a specified node at a specific location. + * + * If the popup is already open, calling this method has no effect. + * + * The popup may be either anchored to another node or opened freely. + * To anchor a popup to a node, supply an anchor node and set the position + * to a string indicating the manner in which the popup should be anchored. + * Possible values for position are: + * before_start, before_end, after_start, after_end, + * start_before, start_after, end_before, end_after, + * overlap, after_pointer + * + * The anchor node does not need to be in the same document as the popup. + * + * If the attributesOverride argument is true, the popupanchor, popupalign + * and position attributes on the popup node override the position value + * argument. If attributesOverride is false, the attributes are only used + * if position is empty. + * + * For an anchored popup, the x and y arguments may be used to offset the + * popup from its anchored position by some distance, measured in CSS pixels. + * x increases to the right and y increases down. Negative values may also + * be used to move to the left and upwards respectively. + * + * Unanchored popups may be created by supplying null as the anchor node. + * An unanchored popup appears at the position specified by x and y, + * relative to the viewport of the document containing the popup node. In + * this case, position and attributesOverride are ignored. + * + * @param anchorElement the node to anchor the popup to, may be null + * @param options either options to use, or a string position + * @param x horizontal offset + * @param y vertical offset + * @param isContextMenu true for context menus, false for other popups + * @param attributesOverride true if popup node attributes override position + * @param triggerEvent the event that triggered this popup (mouse click for example) + */ + undefined openPopup(optional Element? anchorElement = null, + optional StringOrOpenPopupOptions options = {}, + optional long x = 0, + optional long y = 0, + optional boolean isContextMenu = false, + optional boolean attributesOverride = false, + optional Event? triggerEvent = null); + + /** + * Open the popup at a specific screen position specified by x and y. This + * position may be adjusted if it would cause the popup to be off of the + * screen. The x and y coordinates are measured in CSS pixels, and like all + * screen coordinates, are given relative to the top left of the primary + * screen. + * + * @param isContextMenu true for context menus, false for other popups + * @param x horizontal screen position + * @param y vertical screen position + * @param triggerEvent the event that triggered this popup (mouse click for example) + */ + undefined openPopupAtScreen(optional long x = 0, optional long y = 0, + optional boolean isContextMenu = false, + optional Event? triggerEvent = null); + + /** + * Open the popup anchored at a specific screen rectangle. This function is + * similar to openPopup except that that rectangle of the anchor is supplied + * rather than an element. The anchor rectangle arguments are screen + * coordinates. + * + * If the popup is already open, calling this method has no effect. + */ + undefined openPopupAtScreenRect(optional DOMString position = "", + optional long x = 0, + optional long y = 0, + optional long width = 0, + optional long height = 0, + optional boolean isContextMenu = false, + optional boolean attributesOverride = false, + optional Event? triggerEvent = null); + + /** + * Hide the popup if it is open. The cancel argument is used as a hint that + * the popup is being closed because it has been cancelled, rather than + * something being selected within the panel. + * + * @param cancel if true, then the popup is being cancelled. + */ + undefined hidePopup(optional boolean cancel = false); + + /** + * Activate the item itemElement. This is the recommended way to "click" a + * menuitem in automated tests that involve menus. + * Fires the command event for the item and then closes the menu. + * + * Throws an InvalidStateError if the menu is not currently open, or if the + * menuitem is not inside this menu, or if the menuitem is hidden. The menuitem + * may be an item in a submenu, but that submenu must be open. + * + * @param itemElement The menuitem to activate. + * @param options Which modifier keys and button should be set on the command + * event. + */ + [Throws] + undefined activateItem(Element itemElement, + optional ActivateMenuItemOptions options = {}); + + /** + * Attribute getter and setter for label. + */ + [SetterThrows] + attribute DOMString label; + + /** + * Attribute getter and setter for position. + */ + [SetterThrows] + attribute DOMString position; + + /** + * Returns the state of the popup: + * closed - the popup is closed + * open - the popup is open + * showing - the popup is in the process of being shown + * hiding - the popup is in the process of being hidden + */ + readonly attribute DOMString state; + + /** + * The node that triggered the popup. If the popup is not open, will return + * null. + */ + readonly attribute Node? triggerNode; + + /** + * Retrieve the anchor that was specified to openPopup or for menupopups in a + * menu, the parent menu. + */ + readonly attribute Element? anchorNode; + + /** + * Retrieve the screen rectangle of the popup, including the area occupied by + * any titlebar or borders present. + */ + DOMRect getOuterScreenRect(); + + /** + * Move the popup to a point on screen in CSS pixels. + */ + undefined moveTo(long left, long top); + + /** + * Move an open popup to the given anchor position. The arguments have the same + * meaning as the corresponding argument to openPopup. This method has no effect + * on popups that are not open. + */ + undefined moveToAnchor(optional Element? anchorElement = null, + optional DOMString position = "", + optional long x = 0, optional long y = 0, + optional boolean attributesOverride = false); + + /** + * Size the popup to the given dimensions + */ + undefined sizeTo(long width, long height); + + undefined setConstraintRect(DOMRectReadOnly rect); + + readonly attribute boolean isWaylandDragSource; + readonly attribute boolean isWaylandPopup; +}; |