dom/webidl/XULElement.webidl

   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
   7 interface XULControllers;
   8
   9 [ChromeOnly,
  10  Exposed=Window]
  11 interface XULElement : Element {
  12   [HTMLConstructor] constructor();
  13
  14   // Layout properties
  15   [SetterThrows]
  16   attribute DOMString flex;
  17
  18   // Properties for hiding elements.
  19   attribute boolean hidden;
  20   attribute boolean collapsed;
  21
  22   // Property for hooking up to broadcasters
  23   [SetterThrows]
  24   attribute DOMString observes;
  25
  26   // Properties for hooking up to popups
  27   [SetterThrows]
  28   attribute DOMString menu;
  29   [SetterThrows]
  30   attribute DOMString contextMenu;
  31   [SetterThrows]
  32   attribute DOMString tooltip;
  33
  34   // Width/height properties
  35   [SetterThrows]
  36   attribute DOMString width;
  37   [SetterThrows]
  38   attribute DOMString height;
  39   [SetterThrows]
  40   attribute DOMString minWidth;
  41   [SetterThrows]
  42   attribute DOMString minHeight;
  43   [SetterThrows]
  44   attribute DOMString maxWidth;
  45   [SetterThrows]
  46   attribute DOMString maxHeight;
  47
  48   // Position properties for
  49   // * popups - these are screen coordinates
  50   // * other elements - these are client coordinates relative to parent stack.
  51   [SetterThrows]
  52   attribute DOMString left;
  53   [SetterThrows]
  54   attribute DOMString top;
  55
  56   // Return the screen coordinates of the element.
  57   readonly attribute long screenX;
  58   readonly attribute long screenY;
  59
  60   // Tooltip
  61   [SetterThrows]
  62   attribute DOMString tooltipText;
  63
  64   // Properties for images
  65   [SetterThrows]
  66   attribute DOMString src;
  67
  68   attribute boolean allowEvents;
  69
  70   [Throws, ChromeOnly]
  71   readonly attribute XULControllers             controllers;
  72
  73   [NeedsCallerType]
  74   void                      click();
  75   void                      doCommand();
  76
  77   // Returns true if this is a menu-type element that has a menu
  78   // frame associated with it.
  79   boolean hasMenu();
  80
  81   // If this is a menu-type element, opens or closes the menu
  82   // depending on the argument passed.
  83   void openMenu(boolean open);
  84 };
  85
  86 XULElement includes GlobalEventHandlers;
  87 XULElement includes HTMLOrForeignElement;
  88 XULElement includes ElementCSSInlineStyle;
  89 XULElement includes TouchEventHandlers;
  90 XULElement includes OnErrorEventHandlerForNodes;