diff options
| author | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-07-10 15:24:15 -0500 |
|---|---|---|
| committer | Timothy Pearson <kb9vqf@pearsoncomputing.net> | 2011-07-10 15:24:15 -0500 |
| commit | bd0f3345a938b35ce6a12f6150373b0955b8dd12 (patch) | |
| tree | 7a520322212d48ebcb9fbe1087e7fca28b76185c /doc/html/qwheelevent.html | |
| download | qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.tar.gz qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.zip | |
Add Qt3 development HEAD version
Diffstat (limited to 'doc/html/qwheelevent.html')
| -rw-r--r-- | doc/html/qwheelevent.html | 203 |
1 files changed, 203 insertions, 0 deletions
diff --git a/doc/html/qwheelevent.html b/doc/html/qwheelevent.html new file mode 100644 index 0000000..3ea9ef1 --- /dev/null +++ b/doc/html/qwheelevent.html @@ -0,0 +1,203 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qevent.cpp:479 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>QWheelEvent Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QWheelEvent Class Reference</h1> + +<p>The QWheelEvent class contains parameters that describe a wheel event. +<a href="#details">More...</a> +<p><tt>#include <<a href="qevent-h.html">qevent.h</a>></tt> +<p>Inherits <a href="qevent.html">QEvent</a>. +<p><a href="qwheelevent-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn><a href="#QWheelEvent"><b>QWheelEvent</b></a> ( const QPoint & pos, int delta, int state, Orientation orient = Vertical )</li> +<li class=fn><a href="#QWheelEvent-2"><b>QWheelEvent</b></a> ( const QPoint & pos, const QPoint & globalPos, int delta, int state, Orientation orient = Vertical )</li> +<li class=fn>int <a href="#delta"><b>delta</b></a> () const</li> +<li class=fn>const QPoint & <a href="#pos"><b>pos</b></a> () const</li> +<li class=fn>const QPoint & <a href="#globalPos"><b>globalPos</b></a> () const</li> +<li class=fn>int <a href="#x"><b>x</b></a> () const</li> +<li class=fn>int <a href="#y"><b>y</b></a> () const</li> +<li class=fn>int <a href="#globalX"><b>globalX</b></a> () const</li> +<li class=fn>int <a href="#globalY"><b>globalY</b></a> () const</li> +<li class=fn>ButtonState <a href="#state"><b>state</b></a> () const</li> +<li class=fn>Orientation <a href="#orientation"><b>orientation</b></a> () const</li> +<li class=fn>bool <a href="#isAccepted"><b>isAccepted</b></a> () const</li> +<li class=fn>void <a href="#accept"><b>accept</b></a> ()</li> +<li class=fn>void <a href="#ignore"><b>ignore</b></a> ()</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The QWheelEvent class contains parameters that describe a wheel event. +<p> +<p> Wheel events are sent to the widget under the mouse, and if that widget +does not handle the event they are sent to the focus widget. The rotation +distance is provided by <a href="#delta">delta</a>(). The functions <a href="#pos">pos</a>() and <a href="#globalPos">globalPos</a>() return +the mouse pointer location at the time of the event. +<p> A wheel event contains a special accept flag that indicates +whether the receiver wants the event. You should call +<a href="#accept">QWheelEvent::accept</a>() if you handle the wheel event; otherwise it +will be sent to the parent widget. +<p> The QWidget::setEnable() function can be used to enable or disable +mouse and keyboard events for a widget. +<p> The event handler <a href="qwidget.html#wheelEvent">QWidget::wheelEvent</a>() receives wheel events. +<p> <p>See also <a href="qmouseevent.html">QMouseEvent</a>, <a href="qwidget.html#grabMouse">QWidget::grabMouse</a>(), and <a href="events.html">Event Classes</a>. + +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="QWheelEvent"></a>QWheelEvent::QWheelEvent ( const <a href="qpoint.html">QPoint</a> & pos, int delta, int state, <a href="qt.html#Orientation-enum">Orientation</a> orient = Vertical ) +</h3> + +<p> Constructs a wheel event object. +<p> The <a href="#globalPos">globalPos</a>() is initialized to <a href="qcursor.html#pos">QCursor::pos</a>(), i.e. <em>pos</em>, +which is usually (but not always) right. Use the other constructor +if you need to specify the global position explicitly. <em>delta</em> +contains the rotation distance, <em>state</em> holds the keyboard +modifier flags at the time of the event and <em>orient</em> holds the +wheel's orientation. +<p> <p>See also <a href="#pos">pos</a>(), <a href="#delta">delta</a>(), and <a href="#state">state</a>(). + +<h3 class=fn><a name="QWheelEvent-2"></a>QWheelEvent::QWheelEvent ( const <a href="qpoint.html">QPoint</a> & pos, const <a href="qpoint.html">QPoint</a> & globalPos, int delta, int state, <a href="qt.html#Orientation-enum">Orientation</a> orient = Vertical ) +</h3> + +<p> Constructs a wheel event object. The position when the event +occurred is given in <em>pos</em> and <em>globalPos</em>. <em>delta</em> contains +the rotation distance, <em>state</em> holds the keyboard modifier flags +at the time of the event and <em>orient</em> holds the wheel's +orientation. +<p> <p>See also <a href="#pos">pos</a>(), <a href="#globalPos">globalPos</a>(), <a href="#delta">delta</a>(), and <a href="#state">state</a>(). + +<h3 class=fn>void <a name="accept"></a>QWheelEvent::accept () +</h3> + +<p> Sets the accept flag of the wheel event object. +<p> Setting the accept parameter indicates that the receiver of the +event wants the wheel event. Unwanted wheel events are sent to the +parent widget. +<p> The accept flag is set by default. +<p> <p>See also <a href="#ignore">ignore</a>(). + +<h3 class=fn>int <a name="delta"></a>QWheelEvent::delta () const +</h3> + +<p> Returns the distance that the wheel is rotated expressed in +multiples or divisions of the <em>wheel delta</em>, which is currently +defined to be 120. A positive value indicates that the wheel was +rotated forwards away from the user; a negative value indicates +that the wheel was rotated backwards toward the user. +<p> The <em>wheel delta</em> constant was defined to be 120 by wheel mouse +vendors to allow building finer-resolution wheels in the future, +including perhaps a freely rotating wheel with no notches. The +expectation is that such a device would send more messages per +rotation but with a smaller value in each message. + +<h3 class=fn>const <a href="qpoint.html">QPoint</a> & <a name="globalPos"></a>QWheelEvent::globalPos () const +</h3> + +<p> Returns the global position of the mouse pointer <em>at the time of the event</em>. This is important on asynchronous window systems +such as X11; whenever you move your widgets around in response to +mouse events, <a href="#globalPos">globalPos</a>() can differ a lot from the current +pointer position <a href="qcursor.html#pos">QCursor::pos</a>(). +<p> <p>See also <a href="#globalX">globalX</a>() and <a href="#globalY">globalY</a>(). + +<h3 class=fn>int <a name="globalX"></a>QWheelEvent::globalX () const +</h3> + +<p> Returns the global x-position of the mouse pointer at the time of +the event. +<p> <p>See also <a href="#globalY">globalY</a>() and <a href="#globalPos">globalPos</a>(). + +<h3 class=fn>int <a name="globalY"></a>QWheelEvent::globalY () const +</h3> + +<p> Returns the global y-position of the mouse pointer at the time of +the event. +<p> <p>See also <a href="#globalX">globalX</a>() and <a href="#globalPos">globalPos</a>(). + +<h3 class=fn>void <a name="ignore"></a>QWheelEvent::ignore () +</h3> + +<p> Clears the accept flag parameter of the wheel event object. +<p> Clearing the accept parameter indicates that the event receiver +does not want the wheel event. Unwanted wheel events are sent to +the parent widget. The accept flag is set by default. +<p> <p>See also <a href="#accept">accept</a>(). + +<h3 class=fn>bool <a name="isAccepted"></a>QWheelEvent::isAccepted () const +</h3> + +<p> Returns TRUE if the receiver of the event handles the wheel event; +otherwise returns FALSE. + +<h3 class=fn><a href="qt.html#Orientation-enum">Orientation</a> <a name="orientation"></a>QWheelEvent::orientation () const +</h3> + +<p> Returns the wheel's orientation. + +<h3 class=fn>const <a href="qpoint.html">QPoint</a> & <a name="pos"></a>QWheelEvent::pos () const +</h3> + +<p> Returns the position of the mouse pointer, relative to the widget +that received the event. +<p> If you move your widgets around in response to mouse +events, use <a href="#globalPos">globalPos</a>() instead of this function. +<p> <p>See also <a href="#x">x</a>(), <a href="#y">y</a>(), and <a href="#globalPos">globalPos</a>(). + +<h3 class=fn><a href="qt.html#ButtonState-enum">ButtonState</a> <a name="state"></a>QWheelEvent::state () const +</h3> + +<p> Returns the keyboard modifier flags of the event. +<p> The returned value is <a href="qt.html#ButtonState-enum">ShiftButton</a>, <a href="qt.html#ButtonState-enum">ControlButton</a>, and <a href="qt.html#ButtonState-enum">AltButton</a> OR'ed together. + +<h3 class=fn>int <a name="x"></a>QWheelEvent::x () const +</h3> + +<p> Returns the x-position of the mouse pointer, relative to the +widget that received the event. +<p> <p>See also <a href="#y">y</a>() and <a href="#pos">pos</a>(). + +<h3 class=fn>int <a name="y"></a>QWheelEvent::y () const +</h3> + +<p> Returns the y-position of the mouse pointer, relative to the +widget that received the event. +<p> <p>See also <a href="#x">x</a>() and <a href="#pos">pos</a>(). + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">Qt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>Qt 3.3.8</div> +</table></div></address></body> +</html> |