← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qhelpevent.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-08-24 04:09:09 UTC
  • Revision ID: james.westby@ubuntu.com-20050824040909-xmxe9jfr4a0w5671
Tags: upstream-4.0.0
Import upstream version 4.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qhelpevent.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<!-- /tmp/qt-4.0.0-espenr-1119621036935/qt-x11-opensource-desktop-4.0.0/src/gui/kernel/qevent.cpp -->
 
6
<head>
 
7
    <title>Qt 4.0: QHelpEvent Class Reference</title>
 
8
    <style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
 
9
a:link { color: #004faf; text-decoration: none }
 
10
a:visited { color: #672967; text-decoration: none }
 
11
td.postheader { font-family: sans-serif }
 
12
tr.address { font-family: sans-serif }
 
13
body { background: #ffffff; color: black; }</style>
 
14
</head>
 
15
<body>
 
16
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
17
<tr>
 
18
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></td>
 
19
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="annotated.html"><font color="#004faf">Annotated</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
 
20
<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QHelpEvent Class Reference</h1>
 
21
<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>
 
22
<pre>#include &lt;QHelpEvent&gt;</pre><p>Part of the <a href="qtgui.html">QtGui</a> module.</p>
 
23
<p>Inherits <a href="qevent.html">QEvent</a>.</p>
 
24
<ul>
 
25
<li><a href="qhelpevent-members.html">List of all members, including inherited members</a></li>
 
26
</ul>
 
27
<a name="public-functions"></a>
 
28
<h3>Public Functions</h3>
 
29
<ul>
 
30
<li><div class="fn"/><b><a href="qhelpevent.html#QHelpEvent">QHelpEvent</a></b> ( Type <i>type</i>, const QPoint &amp; <i>pos</i>, const QPoint &amp; <i>globalPos</i> )</li>
 
31
<li><div class="fn"/>const QPoint &amp; <b><a href="qhelpevent.html#globalPos">globalPos</a></b> () const</li>
 
32
<li><div class="fn"/>int <b><a href="qhelpevent.html#globalX">globalX</a></b> () const</li>
 
33
<li><div class="fn"/>int <b><a href="qhelpevent.html#globalY">globalY</a></b> () const</li>
 
34
<li><div class="fn"/>const QPoint &amp; <b><a href="qhelpevent.html#pos">pos</a></b> () const</li>
 
35
<li><div class="fn"/>int <b><a href="qhelpevent.html#x">x</a></b> () const</li>
 
36
<li><div class="fn"/>int <b><a href="qhelpevent.html#y">y</a></b> () const</li>
 
37
</ul>
 
38
<ul>
 
39
<li><div class="fn"/>6 public functions inherited from <a href="qevent.html#public-functions">QEvent</a></li>
 
40
</ul>
 
41
<h3>Additional Inherited Members</h3>
 
42
<ul>
 
43
<li><div class="fn"/>1 property inherited from <a href="qevent.html#properties">QEvent</a></li>
 
44
</ul>
 
45
<a name="details"></a>
 
46
<hr />
 
47
<h2>Detailed Description</h2>
 
48
<p>The QHelpEvent class provides an event that is used to request helpful information about a particular point in a widget.</p>
 
49
<p>This event can be intercepted in applications to provide tooltips or &quot;What's This?&quot; 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>
 
50
<p>See also <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>
 
51
<hr />
 
52
<h2>Member Function Documentation</h2>
 
53
<h3 class="fn"><a name="QHelpEvent"></a>QHelpEvent::QHelpEvent ( <a href="qevent.html#Type-enum">Type</a> <i>type</i>, const <a href="qpoint.html">QPoint</a> &amp; <i>pos</i>, const <a href="qpoint.html">QPoint</a> &amp; <i>globalPos</i> )</h3>
 
54
<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>
 
55
<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>
 
56
<p>See also <a href="qhelpevent.html#pos">pos</a>() and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
 
57
<h3 class="fn"><a name="globalPos"></a>const <a href="qpoint.html">QPoint</a> &amp; QHelpEvent::globalPos () const</h3>
 
58
<p>Returns the mouse cursor position when the event was generated in global coordinates.</p>
 
59
<p>See also <a href="qhelpevent.html#pos">pos</a>(), <a href="qhelpevent.html#globalX">globalX</a>(), and <a href="qhelpevent.html#globalY">globalY</a>().</p>
 
60
<h3 class="fn"><a name="globalX"></a>int QHelpEvent::globalX () const</h3>
 
61
<p>Same as <a href="qhelpevent.html#globalPos">globalPos</a>().<a href="qhelpevent.html#x">x</a>().</p>
 
62
<p>See also <a href="qhelpevent.html#x">x</a>(), <a href="qhelpevent.html#globalY">globalY</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
 
63
<h3 class="fn"><a name="globalY"></a>int QHelpEvent::globalY () const</h3>
 
64
<p>Same as <a href="qhelpevent.html#globalPos">globalPos</a>().<a href="qhelpevent.html#y">y</a>().</p>
 
65
<p>See also <a href="qhelpevent.html#y">y</a>(), <a href="qhelpevent.html#globalX">globalX</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
 
66
<h3 class="fn"><a name="pos"></a>const <a href="qpoint.html">QPoint</a> &amp; QHelpEvent::pos () const</h3>
 
67
<p>Returns the mouse cursor position when the event was generated, relative to the widget to which the event is dispatched.</p>
 
68
<p>See also <a href="qhelpevent.html#globalPos">globalPos</a>(), <a href="qhelpevent.html#x">x</a>(), and <a href="qhelpevent.html#y">y</a>().</p>
 
69
<h3 class="fn"><a name="x"></a>int QHelpEvent::x () const</h3>
 
70
<p>Same as <a href="qhelpevent.html#pos">pos</a>().x().</p>
 
71
<p>See also <a href="qhelpevent.html#y">y</a>(), <a href="qhelpevent.html#pos">pos</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
 
72
<h3 class="fn"><a name="y"></a>int QHelpEvent::y () const</h3>
 
73
<p>Same as <a href="qhelpevent.html#pos">pos</a>().y().</p>
 
74
<p>See also <a href="qhelpevent.html#x">x</a>(), <a href="qhelpevent.html#pos">pos</a>(), and <a href="qhelpevent.html#globalPos">globalPos</a>().</p>
 
75
<p /><address><hr /><div align="center">
 
76
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
77
<td width="30%">Copyright &copy; 2005 <a href="trolltech.html">Trolltech</a></td>
 
78
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
79
<td width="30%" align="right"><div align="right">Qt 4.0.0</div></td>
 
80
</tr></table></div></address></body>
 
81
</html>