diff options
Diffstat (limited to 'doc/html/qtooltipgroup.html')
| -rw-r--r-- | doc/html/qtooltipgroup.html | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/doc/html/qtooltipgroup.html b/doc/html/qtooltipgroup.html new file mode 100644 index 000000000..fb4e80b0a --- /dev/null +++ b/doc/html/qtooltipgroup.html @@ -0,0 +1,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>TQToolTipGroup 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>TQToolTipGroup Class Reference</h1> + +<p>The TQToolTipGroup class collects tool tips into related groups. +<a href="#details">More...</a> +<p><tt>#include <<a href="qtooltip-h.html">qtooltip.h</a>></tt> +<p>Inherits <a href="qobject.html">TQObject</a>. +<p><a href="qtooltipgroup-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn><a href="#TQToolTipGroup"><b>TQToolTipGroup</b></a> ( TQObject * parent, const char * name = 0 )</li> +<li class=fn><a href="#~TQToolTipGroup"><b>~TQToolTipGroup</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 TQString & 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> - whether the display of the group text is delayed</li> +<li class=fn>bool <a href="#enabled-prop"><b>enabled</b></a> - whether tool tips in the group are enabled</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +The TQToolTipGroup 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>. TQToolTipGroup provides a way to link tool tips to +this status bar. +<p> TQToolTipGroup has practically no API; it is only used as an +argument to <a href="qtooltip.html">TQToolTip</a>'s member functions, for example like this: +<p> <pre> + TQToolTipGroup * grp = new TQToolTipGroup( this, "tool tip relay" ); + <a href="qobject.html#connect">connect</a>( grp, SIGNAL(<a href="#showTip">showTip</a>(const <a href="qstring.html">TQString</a>&)), + myLabel, SLOT(setText(const <a href="qstring.html">TQString</a>&)) ); + <a href="qobject.html#connect">connect</a>( grp, SIGNAL(<a href="#removeTip">removeTip</a>()), + myLabel, SLOT(clear()) ); + TQToolTip::<a href="qtooltip.html#add">add</a>( giraffeButton, "feed giraffe", + grp, "Give the giraffe a meal" ); + TQToolTip::<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="TQToolTipGroup"></a>TQToolTipGroup::TQToolTipGroup ( <a href="qobject.html">TQObject</a> * parent, const char * name = 0 ) +</h3> +Constructs a tool tip group called <em>name</em>, with parent <em>parent</em>. + +<h3 class=fn><a name="~TQToolTipGroup"></a>TQToolTipGroup::~TQToolTipGroup () +</h3> +Destroys this tool tip group and all tool tips in it. + +<h3 class=fn>bool <a name="delay"></a>TQToolTipGroup::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>TQToolTipGroup::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>TQToolTipGroup::removeTip ()<tt> [signal]</tt> +</h3> + +<p> This signal is emitted when a tool tip in this group is hidden. +See the TQToolTipGroup 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>TQToolTipGroup::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>TQToolTipGroup::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>TQToolTipGroup::showTip ( const <a href="qstring.html">TQString</a> & 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">TQt 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>TQt 3.3.8</div> +</table></div></address></body> +</html> |