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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Id: MouseEvent.xml,v 1.1.1.1 2001/11/26 22:34:22 lpadovan Exp $ -->
<!-- MouseEvent interface -->
<interface name="MouseEvent" inherits="UIEvent" id="Events-MouseEvent"
since="DOM Level 2">
<descr>
<p>The <code>MouseEvent</code> interface provides specific contextual
information associated with Mouse events.</p>
<p>The <code>detail</code> attribute inherited from <code>UIEvent</code>
indicates the number of times a mouse button has been pressed and
released over the same screen location during a user action. The
attribute value is 1 when the user begins this action and increments by 1
for each full sequence of pressing and releasing. If the user moves the
mouse between the mousedown and mouseup the value will be set to 0,
indicating that no click is occurring.</p>
<p>In the case of nested elements mouse events are always targeted at the
most deeply nested element. Ancestors of the targeted element may use
bubbling to obtain notification of mouse events which occur within its
descendent elements.</p>
</descr>
<attribute type="long" name="screenX" readonly="yes"
id="Events-MouseEvent-screenX">
<descr>
<p>The horizontal coordinate at which the
event occurred relative to the origin of the screen coordinate
system.</p>
</descr>
</attribute>
<attribute type="long" name="screenY" readonly="yes"
id="Events-MouseEvent-screenY">
<descr>
<p>The vertical coordinate at which the
event occurred relative to the origin of the screen coordinate
system.</p>
</descr>
</attribute>
<attribute type="long" name="clientX" readonly="yes"
id="Events-MouseEvent-clientX">
<descr>
<p>The horizontal coordinate at which the
event occurred relative to the DOM implementation's client area.</p>
</descr>
</attribute>
<attribute type="long" name="clientY" readonly="yes"
id="Events-MouseEvent-clientY">
<descr>
<p>The vertical coordinate at which the
event occurred relative to the DOM implementation's client area.</p>
</descr>
</attribute>
<attribute type="boolean" name="ctrlKey" readonly="yes"
id="Events-MouseEvent-ctrlKey">
<descr>
<p>Used to indicate whether the 'ctrl' key was depressed
during the firing of the event.</p>
</descr>
</attribute>
<attribute type="boolean" name="shiftKey" readonly="yes"
id="Events-MouseEvent-shiftKey">
<descr>
<p>Used to indicate whether the 'shift' key was depressed
during the firing of the event.</p>
</descr>
</attribute>
<attribute type="boolean" name="altKey" readonly="yes"
id="Events-MouseEvent-altKey">
<descr>
<p>Used to indicate whether the 'alt' key was depressed
during the firing of the event. On some platforms this key may map to
an alternative key name.</p>
</descr>
</attribute>
<attribute type="boolean" name="metaKey" readonly="yes"
id="Events-MouseEvent-metaKey">
<descr>
<p>Used to indicate whether the 'meta' key was depressed
during the firing of the event. On some platforms this key may map to
an alternative key name.</p>
</descr>
</attribute>
<attribute type="unsigned short" name="button" readonly="yes"
id="Events-MouseEvent-button">
<descr>
<p>During mouse events caused by the depression or release of a mouse
button, <code>button</code> is used to indicate which mouse button
changed state. The values for <code>button</code> range from zero to indicate
the left button of the mouse, one to indicate the middle button if present, and
two to indicate the right button. For mice configured for left handed use in which
the button actions are reversed the values are instead read from right to left.</p>
</descr>
</attribute>
<attribute type="EventTarget" name="relatedTarget" readonly="yes"
id="Events-MouseEvent-relatedTarget">
<descr>
<p>Used to identify a secondary <code>EventTarget</code> related
to a UI event. Currently this attribute is used with the mouseover event to indicate the
<code>EventTarget</code> which the pointing device exited and with the mouseout event to indicate the
<code>EventTarget</code> which the pointing device entered.</p>
</descr>
</attribute>
<method name="initMouseEvent" id="Events-Event-initMouseEvent">
<descr>
<p>The <code>initMouseEvent</code> method is used to initialize the value of a <code>MouseEvent</code> created through
the <code>DocumentEvent</code> interface. This method may only be called before the <code>MouseEvent</code> has
been dispatched via the <code>dispatchEvent</code> method, though it may be called multiple times during that
phase if necessary. If called multiple times, the final invocation takes precedence.</p>
</descr>
<parameters>
<param name="typeArg" type="DOMString" attr="in">
<descr><p>Specifies the event type.</p>
</descr>
</param>
<param name="canBubbleArg" type="boolean" attr="in">
<descr><p>Specifies whether or not the event can bubble.</p>
</descr>
</param>
<param name="cancelableArg" type="boolean" attr="in">
<descr><p>Specifies whether or not the event's default
action can be prevented.</p>
</descr>
</param>
<param name="viewArg" type="views::AbstractView" attr="in">
<descr><p>Specifies the <code>Event</code>'s
<code>AbstractView</code>.</p>
</descr>
</param>
<param name="detailArg" type="long" attr="in">
<descr><p>Specifies the <code>Event</code>'s mouse click count.</p>
</descr>
</param>
<param name="screenXArg" type="long" attr="in">
<descr><p>Specifies the <code>Event</code>'s screen x coordinate</p>
</descr>
</param>
<param name="screenYArg" type="long" attr="in">
<descr><p>Specifies the <code>Event</code>'s screen y coordinate</p>
</descr>
</param>
<param name="clientXArg" type="long" attr="in">
<descr><p>Specifies the <code>Event</code>'s client x coordinate</p>
</descr>
</param>
<param name="clientYArg" type="long" attr="in">
<descr><p>Specifies the <code>Event</code>'s client y coordinate</p>
</descr>
</param>
<param name="ctrlKeyArg" type="boolean" attr="in">
<descr><p>Specifies whether or not control key was depressed during
the <code>Event</code>.</p>
</descr>
</param>
<param name="altKeyArg" type="boolean" attr="in">
<descr><p>Specifies whether or not alt key was depressed during the
<code>Event</code>.</p>
</descr>
</param>
<param name="shiftKeyArg" type="boolean" attr="in">
<descr><p>Specifies whether or not shift key was depressed during the
<code>Event</code>.</p>
</descr>
</param>
<param name="metaKeyArg" type="boolean" attr="in">
<descr><p>Specifies whether or not meta key was depressed during the
<code>Event</code>.</p>
</descr>
</param>
<param name="buttonArg" type="unsigned short" attr="in">
<descr><p>Specifies the <code>Event</code>'s mouse button.</p>
</descr>
</param>
<param name="relatedTargetArg" type="EventTarget" attr="in">
<descr><p>Specifies the <code>Event</code>'s related <code>EventTarget</code>.</p>
</descr>
</param>
</parameters>
<returns type="void">
<descr><p></p></descr>
</returns>
<raises>
<!-- No exceptions -->
</raises>
</method>
</interface>
|