source: trunk/doc/html/qtooltipgroup.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added
File size: 7.6 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/widgets/qtooltip.cpp:1096 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QToolTipGroup Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QToolTipGroup Class Reference</h1>
33
34<p>The QToolTipGroup class collects tool tips into related groups.
35<a href="#details">More...</a>
36<p><tt>#include &lt;<a href="qtooltip-h.html">qtooltip.h</a>&gt;</tt>
37<p>Inherits <a href="qobject.html">QObject</a>.
38<p><a href="qtooltipgroup-members.html">List of all member functions.</a>
39<h2>Public Members</h2>
40<ul>
41<li class=fn><a href="#QToolTipGroup"><b>QToolTipGroup</b></a> ( QObject&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
42<li class=fn><a href="#~QToolTipGroup"><b>~QToolTipGroup</b></a> ()</li>
43<li class=fn>bool <a href="#delay"><b>delay</b></a> () const</li>
44<li class=fn>bool <a href="#enabled"><b>enabled</b></a> () const</li>
45</ul>
46<h2>Public Slots</h2>
47<ul>
48<li class=fn>void <a href="#setDelay"><b>setDelay</b></a> ( bool )</li>
49<li class=fn>void <a href="#setEnabled"><b>setEnabled</b></a> ( bool )</li>
50</ul>
51<h2>Signals</h2>
52<ul>
53<li class=fn>void <a href="#showTip"><b>showTip</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;longText )</li>
54<li class=fn>void <a href="#removeTip"><b>removeTip</b></a> ()</li>
55</ul>
56<h2>Properties</h2>
57<ul>
58<li class=fn>bool <a href="#delay-prop"><b>delay</b></a>&nbsp;- whether the display of the group text is delayed</li>
59<li class=fn>bool <a href="#enabled-prop"><b>enabled</b></a>&nbsp;- whether tool tips in the group are enabled</li>
60</ul>
61<hr><a name="details"></a><h2>Detailed Description</h2>
62
63
64The QToolTipGroup class collects tool tips into related groups.
65<p>
66<p> Tool tips can display <em>two</em> texts: one in the tip and
67(optionally) one that is typically in a <a href="qstatusbar.html">status
68 bar</a>. QToolTipGroup provides a way to link tool tips to
69this status bar.
70<p> QToolTipGroup has practically no API; it is only used as an
71argument to <a href="qtooltip.html">QToolTip</a>'s member functions, for example like this:
72<p> <pre>
73 QToolTipGroup * grp = new QToolTipGroup( this, "tool tip relay" );
74 <a href="qobject.html#connect">connect</a>( grp, SIGNAL(<a href="#showTip">showTip</a>(const <a href="qstring.html">QString</a>&amp;)),
75 myLabel, SLOT(setText(const <a href="qstring.html">QString</a>&amp;)) );
76 <a href="qobject.html#connect">connect</a>( grp, SIGNAL(<a href="#removeTip">removeTip</a>()),
77 myLabel, SLOT(clear()) );
78 QToolTip::<a href="qtooltip.html#add">add</a>( giraffeButton, "feed giraffe",
79 grp, "Give the giraffe a meal" );
80 QToolTip::<a href="qtooltip.html#add">add</a>( gorillaButton, "feed gorilla",
81 grp, "Give the gorilla a meal" );
82 </pre>
83
84<p> This example makes the object myLabel (which you must supply)
85display (one assumes, though you can make myLabel do anything, of
86course) the strings "Give the giraffe a meal" and "Give the
87gorilla a meal" while the relevant tool tips are being displayed.
88<p> Deleting a tool tip group removes the tool tips in it.
89<p>See also <a href="helpsystem.html">Help System</a>.
90
91<hr><h2>Member Function Documentation</h2>
92<h3 class=fn><a name="QToolTipGroup"></a>QToolTipGroup::QToolTipGroup ( <a href="qobject.html">QObject</a>&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )
93</h3>
94Constructs a tool tip group called <em>name</em>, with parent <em>parent</em>.
95
96<h3 class=fn><a name="~QToolTipGroup"></a>QToolTipGroup::~QToolTipGroup ()
97</h3>
98Destroys this tool tip group and all tool tips in it.
99
100<h3 class=fn>bool <a name="delay"></a>QToolTipGroup::delay () const
101</h3><p>Returns TRUE if the display of the group text is delayed; otherwise returns FALSE.
102See the <a href="qtooltipgroup.html#delay-prop">"delay"</a> property for details.
103<h3 class=fn>bool <a name="enabled"></a>QToolTipGroup::enabled () const
104</h3><p>Returns TRUE if tool tips in the group are enabled; otherwise returns FALSE.
105See the <a href="qtooltipgroup.html#enabled-prop">"enabled"</a> property for details.
106<h3 class=fn>void <a name="removeTip"></a>QToolTipGroup::removeTip ()<tt> [signal]</tt>
107</h3>
108
109<p> This signal is emitted when a tool tip in this group is hidden.
110See the QToolTipGroup documentation for an example of use.
111<p> <p>See also <a href="#showTip">showTip</a>().
112
113<p>Example: <a href="helpsystem-example.html#x2696">helpsystem/mainwindow.cpp</a>.
114<h3 class=fn>void <a name="setDelay"></a>QToolTipGroup::setDelay ( bool )<tt> [slot]</tt>
115</h3><p>Sets whether the display of the group text is delayed.
116See the <a href="qtooltipgroup.html#delay-prop">"delay"</a> property for details.
117<h3 class=fn>void <a name="setEnabled"></a>QToolTipGroup::setEnabled ( bool )<tt> [slot]</tt>
118</h3><p>Sets whether tool tips in the group are enabled.
119See the <a href="qtooltipgroup.html#enabled-prop">"enabled"</a> property for details.
120<h3 class=fn>void <a name="showTip"></a>QToolTipGroup::showTip ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;longText )<tt> [signal]</tt>
121</h3>
122
123<p> This signal is emitted when one of the tool tips in the group is
124displayed. <em>longText</em> is the extra text for the displayed tool
125tip.
126<p> <p>See also <a href="#removeTip">removeTip</a>().
127
128<p>Example: <a href="helpsystem-example.html#x2697">helpsystem/mainwindow.cpp</a>.
129<hr><h2>Property Documentation</h2>
130<h3 class=fn>bool <a name="delay-prop"></a>delay</h3>
131<p>This property holds whether the display of the group text is delayed.
132<p>If set to TRUE (the default), the group text is displayed at the
133same time as the tool tip. Otherwise, the group text is displayed
134immediately when the cursor enters the widget.
135
136<p>Set this property's value with <a href="#setDelay">setDelay</a>() and get this property's value with <a href="#delay">delay</a>().
137<h3 class=fn>bool <a name="enabled-prop"></a>enabled</h3>
138<p>This property holds whether tool tips in the group are enabled.
139<p>This property's default is TRUE.
140
141<p>Set this property's value with <a href="#setEnabled">setEnabled</a>() and get this property's value with <a href="#enabled">enabled</a>().
142<!-- eof -->
143<hr><p>
144This file is part of the <a href="index.html">Qt toolkit</a>.
145Copyright &copy; 1995-2007
146<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
147<table width=100% cellspacing=0 border=0><tr>
148<td>Copyright &copy; 2007
149<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
150<td align=right><div align=right>Qt 3.3.8</div>
151</table></div></address></body>
152</html>
Note: See TracBrowser for help on using the repository browser.