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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qevent.cpp -->
<title>Qt 4.8: QHelpEvent Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QHelpEvent</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QHelpEvent Class Reference</h1>
<!-- $$$QHelpEvent-brief -->
<p>The QHelpEvent class provides an event that is used to request helpful information about a particular point in a widget. <a href="#details">More...</a></p>
<!-- @@@QHelpEvent -->
<pre class="cpp"> <span class="preprocessor">#include <QHelpEvent></span></pre><p><b>Inherits: </b><a href="qevent.html">QEvent</a>.</p>
<ul>
<li><a href="qhelpevent-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#QHelpEvent">QHelpEvent</a></b> ( Type <i>type</i>, const QPoint & <i>pos</i>, const QPoint & <i>globalPos</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QPoint & </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#globalPos">globalPos</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#globalX">globalX</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#globalY">globalY</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QPoint & </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#pos">pos</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#x">x</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qhelpevent.html#y">y</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">6 public functions inherited from <a href="qevent.html#public-functions">QEvent</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qevent.html#properties">QEvent</a></li>
<li class="fn">1 static public member inherited from <a href="qevent.html#static-public-members">QEvent</a></li>
</ul>
<a name="details"></a>
<!-- $$$QHelpEvent-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QHelpEvent class provides an event that is used to request helpful information about a particular point in a widget.</p>
<p>This event can be intercepted in applications to provide tooltips or "What's This?" help for custom widgets. The <a href="qevent.html#type">type</a>() can be either <a href="qevent.html#Type-enum">QEvent::ToolTip</a> or <a href="qevent.html#Type-enum">QEvent::WhatsThis</a>.</p>
</div>
<p><b>See also </b><a href="qtooltip.html">QToolTip</a>, <a href="qwhatsthis.html">QWhatsThis</a>, <a href="qstatustipevent.html">QStatusTipEvent</a>, and <a href="qwhatsthisclickedevent.html">QWhatsThisClickedEvent</a>.</p>
<!-- @@@QHelpEvent -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QHelpEvent[overload1]$$$QHelpEventTypeconstQPoint&constQPoint& -->
<h3 class="fn"><a name="QHelpEvent"></a>QHelpEvent::<span class="name">QHelpEvent</span> ( <span class="type"><a href="qevent.html#Type-enum">Type</a></span> <i>type</i>, const <span class="type"><a href="qpoint.html">QPoint</a></span> & <i>pos</i>, const <span class="type"><a href="qpoint.html">QPoint</a></span> & <i>globalPos</i> )</h3>
<p>Constructs a help event with the given <i>type</i> corresponding to the widget-relative position specified by <i>pos</i> and the global position specified by <i>globalPos</i>.</p>
<p><i>type</i> must be either <a href="qevent.html#Type-enum">QEvent::ToolTip</a> or <a href="qevent.html#Type-enum">QEvent::WhatsThis</a>.</p>
<p><b>See also </b><a href="qhelpevent.html#pos">pos</a>() and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@QHelpEvent -->
<!-- $$$globalPos[overload1]$$$globalPos -->
<h3 class="fn"><a name="globalPos"></a>const <span class="type"><a href="qpoint.html">QPoint</a></span> & QHelpEvent::<span class="name">globalPos</span> () const</h3>
<p>Returns the mouse cursor position when the event was generated in global coordinates.</p>
<p><b>See also </b><a href="qhelpevent.html#pos">pos</a>(), <a href="qhelpevent.html#globalX">globalX</a>(), and <a href="qhelpevent.html#globalY">globalY</a>().</p>
<!-- @@@globalPos -->
<!-- $$$globalX[overload1]$$$globalX -->
<h3 class="fn"><a name="globalX"></a><span class="type">int</span> QHelpEvent::<span class="name">globalX</span> () const</h3>
<p>Same as <a href="qhelpevent.html#globalPos">globalPos</a>().<a href="qhelpevent.html#x">x</a>().</p>
<p><b>See also </b><a href="qhelpevent.html#x">x</a>(), <a href="qhelpevent.html#globalY">globalY</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@globalX -->
<!-- $$$globalY[overload1]$$$globalY -->
<h3 class="fn"><a name="globalY"></a><span class="type">int</span> QHelpEvent::<span class="name">globalY</span> () const</h3>
<p>Same as <a href="qhelpevent.html#globalPos">globalPos</a>().<a href="qhelpevent.html#y">y</a>().</p>
<p><b>See also </b><a href="qhelpevent.html#y">y</a>(), <a href="qhelpevent.html#globalX">globalX</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@globalY -->
<!-- $$$pos[overload1]$$$pos -->
<h3 class="fn"><a name="pos"></a>const <span class="type"><a href="qpoint.html">QPoint</a></span> & QHelpEvent::<span class="name">pos</span> () const</h3>
<p>Returns the mouse cursor position when the event was generated, relative to the widget to which the event is dispatched.</p>
<p><b>See also </b><a href="qhelpevent.html#globalPos">globalPos</a>(), <a href="qhelpevent.html#x">x</a>(), and <a href="qhelpevent.html#y">y</a>().</p>
<!-- @@@pos -->
<!-- $$$x[overload1]$$$x -->
<h3 class="fn"><a name="x"></a><span class="type">int</span> QHelpEvent::<span class="name">x</span> () const</h3>
<p>Same as <a href="qhelpevent.html#pos">pos</a>().x().</p>
<p><b>See also </b><a href="qhelpevent.html#y">y</a>(), <a href="qhelpevent.html#pos">pos</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@x -->
<!-- $$$y[overload1]$$$y -->
<h3 class="fn"><a name="y"></a><span class="type">int</span> QHelpEvent::<span class="name">y</span> () const</h3>
<p>Same as <a href="qhelpevent.html#pos">pos</a>().y().</p>
<p><b>See also </b><a href="qhelpevent.html#x">x</a>(), <a href="qhelpevent.html#pos">pos</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
<!-- @@@y -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|