<HTML>
<HEAD>
<TITLE>class MouseEvent</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class MouseEvent</h1>
</TD>
<TD valign="top" align="right" colspan="1">
Introduced in DOM Level 2
<small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="DOM.html">DOM</A>::MouseEvent</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="dom2__events_h.html">dom2_events.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="DOM__UIEvent.html">DOM::UIEvent</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-DOM__MouseEvent.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI> <b><A HREF="#ref1">MouseEvent</A></b> ()
</LI>
<LI> <b><A HREF="#ref2">MouseEvent</A></b> (const MouseEvent &other)
</LI>
<LI> <b><A HREF="#ref3">MouseEvent</A></b> (const Event &other)
</LI>
<LI>MouseEvent & <b><A HREF="#ref4">operator = </A></b> (const MouseEvent &other)
</LI>
<LI>MouseEvent & <b><A HREF="#ref5">operator = </A></b> (const Event &other)
</LI>
<LI>virtual <b><A HREF="#ref6">~MouseEvent</A></b> ()
</LI>
<LI>long <b><A HREF="#ref7">screenX</A></b> () const
</LI>
<LI>long <b><A HREF="#ref8">screenY</A></b> () const
</LI>
<LI>long <b><A HREF="#ref9">clientX</A></b> () const
</LI>
<LI>long <b><A HREF="#ref10">clientY</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref11">ctrlKey</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref12">shiftKey</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref13">altKey</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref14">metaKey</A></b> () const
</LI>
<LI>unsigned short <b><A HREF="#ref15">button</A></b> () const
</LI>
<LI>Node <b><A HREF="#ref16">relatedTarget</A></b> () const
</LI>
<LI>void <b><A HREF="#ref17">initMouseEvent</A></b> (const DOMString &typeArg,
bool canBubbleArg,
bool cancelableArg,
const AbstractView &viewArg,
long detailArg,
long screenXArg,
long screenYArg,
long clientXArg,
long clientYArg,
bool ctrlKeyArg,
bool altKeyArg,
bool shiftKeyArg,
bool metaKeyArg,
unsigned short buttonArg,
const Node &relatedTargetArg)
</LI>
</ul><h4>Protected Methods</h4><ul><LI> <b><A HREF="#ref18">MouseEvent</A></b> (MouseEventImpl *impl)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Introduced in DOM Level 2
</p>
<p> The MouseEvent interface provides specific contextual information associated
with Mouse events.
</p>
<p> The detail attribute inherited from UIEvent 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>
<p> </p>
<A NAME="MouseEvent"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>MouseEvent</strong> ()
<br></td><td align="right"><h3><strong>MouseEvent</strong></h3></td></tr></table><p></p><A NAME="MouseEvent"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>MouseEvent</strong> (const MouseEvent &other)
<br></td><td align="right"><h3><strong>MouseEvent</strong></h3></td></tr></table><p></p><A NAME="MouseEvent"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>MouseEvent</strong> (const Event &other)
<br></td><td align="right"><h3><strong>MouseEvent</strong></h3></td></tr></table><p></p><A NAME="operator%20=%20"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>MouseEvent & <strong>operator = </strong> (const MouseEvent &other)
<br></td><td align="right"><h3><strong>operator = </strong></h3></td></tr></table><p></p><p>Reimplemented from <A HREF="DOM__UIEvent.html#operator%20=%20">UIEvent</A>.</p>
<A NAME="operator%20=%20"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>MouseEvent & <strong>operator = </strong> (const Event &other)
<br></td><td align="right"><h3><strong>operator = </strong></h3></td></tr></table><p></p><p>Reimplemented from <A HREF="DOM__UIEvent.html#operator%20=%20">UIEvent</A>.</p>
<A NAME="~MouseEvent"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~MouseEvent</strong> ()
<br></td><td align="right"><h3><strong>~MouseEvent</strong></h3></td></tr></table><p> <small>[virtual]</small></p><A NAME="screenX"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>long <strong>screenX</strong> ()
<br></td><td align="right"><h3><strong>screenX</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
The horizontal coordinate at which the event occurred relative to the
origin of the screen coordinate system.
</p>
<p> </p>
<A NAME="screenY"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>long <strong>screenY</strong> ()
<br></td><td align="right"><h3><strong>screenY</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
The vertical coordinate at which the event occurred relative to the
origin of the screen coordinate system.
</p>
<p> </p>
<A NAME="clientX"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>long <strong>clientX</strong> ()
<br></td><td align="right"><h3><strong>clientX</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
The horizontal coordinate at which the event occurred relative to the
DOM implementation's client area.
</p>
<p> </p>
<A NAME="clientY"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>long <strong>clientY</strong> ()
<br></td><td align="right"><h3><strong>clientY</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
The vertical coordinate at which the event occurred relative to the DOM
implementation's client area.
</p>
<p> </p>
<A NAME="ctrlKey"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>ctrlKey</strong> ()
<br></td><td align="right"><h3><strong>ctrlKey</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Used to indicate whether the 'ctrl' key was depressed during the firing
of the event.
</p>
<A NAME="shiftKey"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>shiftKey</strong> ()
<br></td><td align="right"><h3><strong>shiftKey</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Used to indicate whether the 'shift' key was depressed during the firing
of the event.
</p>
<p> </p>
<A NAME="altKey"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>altKey</strong> ()
<br></td><td align="right"><h3><strong>altKey</strong></h3></td></tr></table><p> <small>[const]</small></p><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>
<p> </p>
<A NAME="metaKey"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>metaKey</strong> ()
<br></td><td align="right"><h3><strong>metaKey</strong></h3></td></tr></table><p> <small>[const]</small></p><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>
<p> </p>
<A NAME="button"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned short <strong>button</strong> ()
<br></td><td align="right"><h3><strong>button</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
During mouse events caused by the depression or release of a mouse
button, button is used to indicate which mouse button changed state. The
values for button 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>
<p> </p>
<A NAME="relatedTarget"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>Node <strong>relatedTarget</strong> ()
<br></td><td align="right"><h3><strong>relatedTarget</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Used to identify a secondary EventTarget related to a UI event.
Currently this attribute is used with the mouseover event to indicate
the EventTarget which the pointing device exited and with the mouseout
event to indicate the EventTarget which the pointing device entered.
</p>
<p> </p>
<A NAME="initMouseEvent"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>initMouseEvent</strong> (const DOMString &typeArg,
bool canBubbleArg,
bool cancelableArg,
const AbstractView &viewArg,
long detailArg,
long screenXArg,
long screenYArg,
long clientXArg,
long clientYArg,
bool ctrlKeyArg,
bool altKeyArg,
bool shiftKeyArg,
bool metaKeyArg,
unsigned short buttonArg,
const Node &relatedTargetArg)
<br></td><td align="right"><h3><strong>initMouseEvent</strong></h3></td></tr></table><p></p><p>
The initMouseEvent method is used to initialize the value of a
MouseEvent created through the DocumentEvent interface. This method may
only be called before the MouseEvent has been dispatched via the
dispatchEvent method, though it may be called multiple times during that
phase if necessary. If called multiple times, the final invocation takes
precedence. Parameters
</p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p></p>
<p> </p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>typeArg</i></TD><TD align="left" valign="top">Specifies the event type.
</TD></TR>
<TR><TD align="left" valign="top"><i>canBubbleArg</i></TD><TD align="left" valign="top">Specifies whether or not the event can bubble.
</TD></TR>
<TR><TD align="left" valign="top"><i>cancelableArg</i></TD><TD align="left" valign="top">Specifies whether or not the event's default action can be prevented.
</TD></TR>
<TR><TD align="left" valign="top"><i>viewArg</i></TD><TD align="left" valign="top">Specifies the Event's AbstractView.
</TD></TR>
<TR><TD align="left" valign="top"><i>detailArg</i></TD><TD align="left" valign="top">Specifies the Event's mouse click count.
</TD></TR>
<TR><TD align="left" valign="top"><i>screenXArg</i></TD><TD align="left" valign="top">Specifies the Event's screen x coordinate
</TD></TR>
<TR><TD align="left" valign="top"><i>screenYArg</i></TD><TD align="left" valign="top">Specifies the Event's screen y coordinate
</TD></TR>
<TR><TD align="left" valign="top"><i>clientXArg</i></TD><TD align="left" valign="top">Specifies the Event's client x coordinate
</TD></TR>
<TR><TD align="left" valign="top"><i>clientYArg</i></TD><TD align="left" valign="top">Specifies the Event's client y coordinate
</TD></TR>
<TR><TD align="left" valign="top"><i>ctrlKeyArg</i></TD><TD align="left" valign="top">Specifies whether or not control key was depressed during the Event.
</TD></TR>
<TR><TD align="left" valign="top"><i>altKeyArg</i></TD><TD align="left" valign="top">Specifies whether or not alt key was depressed during the Event.
</TD></TR>
<TR><TD align="left" valign="top"><i>shiftKeyArg</i></TD><TD align="left" valign="top">Specifies whether or not shift key was depressed during the Event.
</TD></TR>
<TR><TD align="left" valign="top"><i>metaKeyArg</i></TD><TD align="left" valign="top">Specifies whether or not meta key was depressed during the Event.
</TD></TR>
<TR><TD align="left" valign="top"><i>buttonArg</i></TD><TD align="left" valign="top">Specifies the Event's mouse button.
</TD></TR>
<TR><TD align="left" valign="top"><i>relatedTargetArg</i></TD><TD align="left" valign="top">Specifies the Event's related EventTarget.
</TD></TR>
</TABLE></P>
<A NAME="MouseEvent"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>MouseEvent</strong> (MouseEventImpl *impl)
<br></td><td align="right"><h3><strong>MouseEvent</strong></h3></td></tr></table><p> <small>[protected]</small></p><HR>
<table>
<tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:09:31 2002, using kdoc 2.0a53.</small></td></tr>
</table>
</BODY>
</HTML>
