summaryrefslogtreecommitdiffstats
path: root/doc/html/qtooltipgroup.html
blob: 4d3b3b536b5b1957beb5c197dc1c67c1d88ce7f4 (plain)
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<!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/widgets/qtooltip.cpp:1096 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QToolTipGroup 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&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;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>QToolTipGroup Class Reference</h1>

<p>The QToolTipGroup class collects tool tips into related groups.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qtooltip-h.html">qtooltip.h</a>&gt;</tt>
<p>Inherits <a href="qobject.html">QObject</a>.
<p><a href="qtooltipgroup-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QToolTipGroup"><b>QToolTipGroup</b></a> ( QObject&nbsp;*&nbsp;parent, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
<li class=fn><a href="#~QToolTipGroup"><b>~QToolTipGroup</b></a> ()</li>
<li class=fn>bool <a href="#delay"><b>delay</b></a> () const</li>
<li class=fn>bool <a href="#enabled"><b>enabled</b></a> () const</li>
</ul>
<h2>Public Slots</h2>
<ul>
<li class=fn>void <a href="#setDelay"><b>setDelay</b></a> ( bool )</li>
<li class=fn>void <a href="#setEnabled"><b>setEnabled</b></a> ( bool )</li>
</ul>
<h2>Signals</h2>
<ul>
<li class=fn>void <a href="#showTip"><b>showTip</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;longText )</li>
<li class=fn>void <a href="#removeTip"><b>removeTip</b></a> ()</li>
</ul>
<h2>Properties</h2>
<ul>
<li class=fn>bool <a href="#delay-prop"><b>delay</b></a>&nbsp;- whether the display of the group text is delayed</li>
<li class=fn>bool <a href="#enabled-prop"><b>enabled</b></a>&nbsp;- whether tool tips in the group are enabled</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QToolTipGroup class collects tool tips into related groups.
<p> 
<p> Tool tips can display <em>two</em> texts: one in the tip and
(optionally) one that is typically in a <a href="qstatusbar.html">status
    bar</a>. QToolTipGroup provides a way to link tool tips to
this status bar.
<p> QToolTipGroup has practically no API; it is only used as an
argument to <a href="qtooltip.html">QToolTip</a>'s member functions, for example like this:
<p> <pre>
        QToolTipGroup * grp = new QToolTipGroup( this, "tool tip relay" );
        <a href="qobject.html#connect">connect</a>( grp, SIGNAL(<a href="#showTip">showTip</a>(const <a href="qstring.html">QString</a>&amp;)),
                 myLabel, SLOT(setText(const <a href="qstring.html">QString</a>&amp;)) );
        <a href="qobject.html#connect">connect</a>( grp, SIGNAL(<a href="#removeTip">removeTip</a>()),
                 myLabel, SLOT(clear()) );
        QToolTip::<a href="qtooltip.html#add">add</a>( giraffeButton, "feed giraffe",
                       grp, "Give the giraffe a meal" );
        QToolTip::<a href="qtooltip.html#add">add</a>( gorillaButton, "feed gorilla",
                       grp, "Give the gorilla a meal" );
    </pre>
 
<p> This example makes the object myLabel (which you must supply)
display (one assumes, though you can make myLabel do anything, of
course) the strings "Give the giraffe a meal" and "Give the
gorilla a meal" while the relevant tool tips are being displayed.
<p> Deleting a tool tip group removes the tool tips in it.
<p>See also <a href="helpsystem.html">Help System</a>.

<hr><h2>Member Function Documentation</h2>
<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 )
</h3>
Constructs a tool tip group called <em>name</em>, with parent <em>parent</em>.

<h3 class=fn><a name="~QToolTipGroup"></a>QToolTipGroup::~QToolTipGroup ()
</h3>
Destroys this tool tip group and all tool tips in it.

<h3 class=fn>bool <a name="delay"></a>QToolTipGroup::delay () const
</h3><p>Returns TRUE if the display of the group text is delayed; otherwise returns FALSE.
See the <a href="qtooltipgroup.html#delay-prop">"delay"</a> property for details.
<h3 class=fn>bool <a name="enabled"></a>QToolTipGroup::enabled () const
</h3><p>Returns TRUE if tool tips in the group are enabled; otherwise returns FALSE.
See the <a href="qtooltipgroup.html#enabled-prop">"enabled"</a> property for details.
<h3 class=fn>void <a name="removeTip"></a>QToolTipGroup::removeTip ()<tt> [signal]</tt>
</h3>

<p> This signal is emitted when a tool tip in this group is hidden.
See the QToolTipGroup documentation for an example of use.
<p> <p>See also <a href="#showTip">showTip</a>().

<p>Example: <a href="helpsystem-example.html#x2696">helpsystem/mainwindow.cpp</a>.
<h3 class=fn>void <a name="setDelay"></a>QToolTipGroup::setDelay ( bool )<tt> [slot]</tt>
</h3><p>Sets whether the display of the group text is delayed.
See the <a href="qtooltipgroup.html#delay-prop">"delay"</a> property for details.
<h3 class=fn>void <a name="setEnabled"></a>QToolTipGroup::setEnabled ( bool )<tt> [slot]</tt>
</h3><p>Sets whether tool tips in the group are enabled.
See the <a href="qtooltipgroup.html#enabled-prop">"enabled"</a> property for details.
<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>
</h3>

<p> This signal is emitted when one of the tool tips in the group is
displayed. <em>longText</em> is the extra text for the displayed tool
tip.
<p> <p>See also <a href="#removeTip">removeTip</a>().

<p>Example: <a href="helpsystem-example.html#x2697">helpsystem/mainwindow.cpp</a>.
<hr><h2>Property Documentation</h2>
<h3 class=fn>bool <a name="delay-prop"></a>delay</h3>
<p>This property holds whether the display of the group text is delayed.
<p>If set to TRUE (the default), the group text is displayed at the
same time as the tool tip. Otherwise, the group text is displayed
immediately when the cursor enters the widget.

<p>Set this property's value with <a href="#setDelay">setDelay</a>() and get this property's value with <a href="#delay">delay</a>().
<h3 class=fn>bool <a name="enabled-prop"></a>enabled</h3>
<p>This property holds whether tool tips in the group are enabled.
<p>This property's default is TRUE.

<p>Set this property's value with <a href="#setEnabled">setEnabled</a>() and get this property's value with <a href="#enabled">enabled</a>().
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 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 &copy; 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>