<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>DOM.MouseEvent</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.4 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>MouseEvent Class Reference</h1>
<code>from PyKDE4.khtml import *</code>
<p>
Inherits: DOM.UIEvent → DOM.Event<br />
Namespace: DOM.MouseEvent<br />
<h2>Detailed Description</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>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#MouseEvent">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#MouseEvent">__init__</a> (self, <a href="../khtml/DOM.MouseEvent.html">DOM.MouseEvent</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#MouseEvent">__init__</a> (self, <a href="../khtml/DOM.Event.html">DOM.Event</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#altKey">altKey</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#button">button</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#clientX">clientX</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#clientY">clientY</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ctrlKey">ctrlKey</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#initMouseEvent">initMouseEvent</a> (self, <a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> typeArg, bool canBubbleArg, bool cancelableArg, <a href="../khtml/DOM.AbstractView.html">DOM.AbstractView</a> viewArg, long detailArg, long screenXArg, long screenYArg, long clientXArg, long clientYArg, bool ctrlKeyArg, bool altKeyArg, bool shiftKeyArg, bool metaKeyArg, long buttonArg, <a href="../khtml/DOM.Node.html">DOM.Node</a> relatedTargetArg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#metaKey">metaKey</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#relatedTarget">relatedTarget</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#screenX">screenX</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#screenY">screenY</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#shiftKey">shiftKey</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="MouseEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="MouseEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../khtml/DOM.MouseEvent.html">DOM.MouseEvent</a> </td>
<td class="paramname"><em>other</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="MouseEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../khtml/DOM.Event.html">DOM.Event</a> </td>
<td class="paramname"><em>other</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="altKey"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool altKey</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><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></div></div><a class="anchor" name="button"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long button</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><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></div></div><a class="anchor" name="clientX"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long clientX</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The horizontal coordinate at which the event occurred relative to the
DOM implementation's client area.
</p></div></div><a class="anchor" name="clientY"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long clientY</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The vertical coordinate at which the event occurred relative to the DOM
implementation's client area.
</p></div></div><a class="anchor" name="ctrlKey"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool ctrlKey</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Used to indicate whether the 'ctrl' key was depressed during the firing
of the event.
</p></div></div><a class="anchor" name="initMouseEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> initMouseEvent</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> </td>
<td class="paramname"><em>typeArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>canBubbleArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>cancelableArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../khtml/DOM.AbstractView.html">DOM.AbstractView</a> </td>
<td class="paramname"><em>viewArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>detailArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>screenXArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>screenYArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>clientXArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>clientYArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>ctrlKeyArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>altKeyArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shiftKeyArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>metaKeyArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>buttonArg</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../khtml/DOM.Node.html">DOM.Node</a> </td>
<td class="paramname"><em>relatedTargetArg</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><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><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>typeArg</em> </td><td> Specifies the event type.
</td></tr>
<tr><td></td><td valign="top"><em>canBubbleArg</em> </td><td> Specifies whether or not the event can bubble.
</td></tr>
<tr><td></td><td valign="top"><em>cancelableArg</em> </td><td> Specifies whether or not the event's default action can be prevented.
</td></tr>
<tr><td></td><td valign="top"><em>viewArg</em> </td><td> Specifies the Event's AbstractView.
</td></tr>
<tr><td></td><td valign="top"><em>detailArg</em> </td><td> Specifies the Event's mouse click count.
</td></tr>
<tr><td></td><td valign="top"><em>screenXArg</em> </td><td> Specifies the Event's screen x coordinate
</td></tr>
<tr><td></td><td valign="top"><em>screenYArg</em> </td><td> Specifies the Event's screen y coordinate
</td></tr>
<tr><td></td><td valign="top"><em>clientXArg</em> </td><td> Specifies the Event's client x coordinate
</td></tr>
<tr><td></td><td valign="top"><em>clientYArg</em> </td><td> Specifies the Event's client y coordinate
</td></tr>
<tr><td></td><td valign="top"><em>ctrlKeyArg</em> </td><td> Specifies whether or not control key was depressed during the Event.
</td></tr>
<tr><td></td><td valign="top"><em>altKeyArg</em> </td><td> Specifies whether or not alt key was depressed during the Event.
</td></tr>
<tr><td></td><td valign="top"><em>shiftKeyArg</em> </td><td> Specifies whether or not shift key was depressed during the Event.
</td></tr>
<tr><td></td><td valign="top"><em>metaKeyArg</em> </td><td> Specifies whether or not meta key was depressed during the Event.
</td></tr>
<tr><td></td><td valign="top"><em>buttonArg</em> </td><td> Specifies the Event's mouse button.
</td></tr>
<tr><td></td><td valign="top"><em>relatedTargetArg</em> </td><td> Specifies the Event's related EventTarget.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="metaKey"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool metaKey</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><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></div></div><a class="anchor" name="relatedTarget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../khtml/DOM.Node.html">DOM.Node</a> relatedTarget</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><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></div></div><a class="anchor" name="screenX"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long screenX</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The horizontal coordinate at which the event occurred relative to the
origin of the screen coordinate system.
</p></div></div><a class="anchor" name="screenY"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long screenY</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The vertical coordinate at which the event occurred relative to the
origin of the screen coordinate system.
</p></div></div><a class="anchor" name="shiftKey"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool shiftKey</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Used to indicate whether the 'shift' key was depressed during the firing
of the event.
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
694
