<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /tmp/qt-4.2.1-harald-1161357942206/qt-x11-opensource-src-4.2.1/src/gui/kernel/qtooltip.cpp -->
<head>
<title>Qt 4.2: QToolTip Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></td>
<td width="1"> </td><td class="postheader" 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="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">QToolTip Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1>
<p>The QToolTip class provides tooltips (balloon help) for any widget. <a href="#details">More...</a></p>
<pre> #include <QToolTip></pre><ul>
<li><a href="qtooltip-members.html">List of all members, including inherited members</a></li>
<li><a href="qtooltip-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="static-public-members"></a>
<h3>Static Public Members</h3>
<ul>
<li><div class="fn"/>QFont <b><a href="qtooltip.html#font">font</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qtooltip.html#hideText">hideText</a></b> ()</li>
<li><div class="fn"/>QPalette <b><a href="qtooltip.html#palette">palette</a></b> ()</li>
<li><div class="fn"/>void <b><a href="qtooltip.html#setFont">setFont</a></b> ( const QFont & <i>font</i> )</li>
<li><div class="fn"/>void <b><a href="qtooltip.html#setPalette">setPalette</a></b> ( const QPalette & <i>palette</i> )</li>
<li><div class="fn"/>void <b><a href="qtooltip.html#showText">showText</a></b> ( const QPoint & <i>pos</i>, const QString & <i>text</i>, QWidget * <i>w</i>, const QRect & <i>rect</i> )</li>
<li><div class="fn"/>void <b><a href="qtooltip.html#showText-2">showText</a></b> ( const QPoint & <i>pos</i>, const QString & <i>text</i>, QWidget * <i>w</i> = 0 )</li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QToolTip class provides tooltips (balloon help) for any widget.</p>
<p>The tip is a short piece of text reminding the user of the widget's function. It is drawn immediately below the given position in a distinctive black-on-yellow color combination. The tip can be any <a href="qtextedit.html">rich text</a> formatted string.</p>
<p>Rich text formatted tips implictely do word breaking, unless specified differently with <tt><p style='white-space:pre'></tt>.</p>
<p>The simplest and most common way to set a widget's tooltip is by calling its <a href="qwidget.html#toolTip-prop">QWidget::setToolTip</a>() function.</p>
<p>It is also possible to show different tooltips for different regions of a widget, by using a <a href="qhelpevent.html">QHelpEvent</a> of type <a href="qevent.html#Type-enum">QEvent::ToolTip</a>. Intercept the help event in your widget's <a href="qwidget.html#event">event()</a> function and call <a href="qtooltip.html#showText">QToolTip::showText</a>() with the text you want to display. The <a href="widgets-tooltips.html">Tooltips</a> example illustrates this technique.</p>
<p>Note that if you want to show tooltips in an item view, the model/view architecture provides functionality to set an item's tootip, e.g., the <a href="qtablewidgetitem.html#setToolTip">QTableWidgetItem::setToolTip</a>() function. But if you want to provide custom tooltips in an item view you must intercept the help event in the <a href="qabstractitemview.html#viewportEvent">QAbstractItemView::viewportEvent</a>() function instead.</p>
<p>The default tooltip color and font can be customized with <a href="qtooltip.html#setPalette">setPalette</a>() and <a href="qtooltip.html#setFont">setFont</a>().</p>
<p>See also <a href="qwidget.html#toolTip-prop">QWidget::toolTip</a>, <a href="qaction.html#toolTip-prop">QAction::toolTip</a>, and <a href="widgets-tooltips.html">Tooltips Example</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="font"></a><a href="qfont.html">QFont</a> QToolTip::font () <tt> [static]</tt></h3>
<p>Returns the font used to render tooltips.</p>
<p>This function was introduced in Qt 4.2.</p>
<p>See also <a href="qtooltip.html#setFont">setFont</a>().</p>
<h3 class="fn"><a name="hideText"></a>void QToolTip::hideText () <tt> [static]</tt></h3>
<p>Hides the tool tip. This is the same as calling <a href="qtooltip.html#showText">showText</a>() with an empty string.</p>
<p>This function was introduced in Qt 4.2.</p>
<p>See also <a href="qtooltip.html#showText">showText</a>().</p>
<h3 class="fn"><a name="palette"></a><a href="qpalette.html">QPalette</a> QToolTip::palette () <tt> [static]</tt></h3>
<p>Returns the palette used to render tooltips.</p>
<p>See also <a href="qtooltip.html#setPalette">setPalette</a>().</p>
<h3 class="fn"><a name="setFont"></a>void QToolTip::setFont ( const <a href="qfont.html">QFont</a> & <i>font</i> ) <tt> [static]</tt></h3>
<p>Sets the <i>font</i> used to render tooltips.</p>
<p>This function was introduced in Qt 4.2.</p>
<p>See also <a href="qtooltip.html#font">font</a>().</p>
<h3 class="fn"><a name="setPalette"></a>void QToolTip::setPalette ( const <a href="qpalette.html">QPalette</a> & <i>palette</i> ) <tt> [static]</tt></h3>
<p>Sets the <i>palette</i> used to render tooltips.</p>
<p>This function was introduced in Qt 4.2.</p>
<p>See also <a href="qtooltip.html#palette">palette</a>().</p>
<h3 class="fn"><a name="showText"></a>void QToolTip::showText ( const <a href="qpoint.html">QPoint</a> & <i>pos</i>, const <a href="qstring.html">QString</a> & <i>text</i>, <a href="qwidget.html">QWidget</a> * <i>w</i>, const <a href="qrect.html">QRect</a> & <i>rect</i> ) <tt> [static]</tt></h3>
<p>Shows <i>text</i> as a tool tip, at global position <i>pos</i>. If you specify a non-empty rect the tip will be hidden as soon as you move your cursor out of this area.</p>
<p>The <i>rect</i> is in the coordinates of the widget you specify with <i>w</i>. If the <i>rect</i> is not empty you must specify a widget. Otherwise this argument can be 0 but it is used to determine the appropriate screen on multi-head systems.</p>
<p>If <i>text</i> is empty the tool tip is hidden. If the text is the same as the currently shown tooltip, the tip will <i>not</i> move. You can force moving by first hiding the tip with an empty text, and then showing the new tip at the new position.</p>
<h3 class="fn"><a name="showText-2"></a>void QToolTip::showText ( const <a href="qpoint.html">QPoint</a> & <i>pos</i>, const <a href="qstring.html">QString</a> & <i>text</i>, <a href="qwidget.html">QWidget</a> * <i>w</i> = 0 ) <tt> [static]</tt></h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>This is analogous to calling QToolTip::showText(<i>pos</i>, <i>text</i>, <i>w</i>, QRect())</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="add"></a>void QToolTip::add ( <a href="qwidget.html">QWidget</a> * <i>widget</i>, const <a href="qstring.html">QString</a> & <i>text</i> ) <tt> [static]</tt></h3>
<p>Use <a href="qwidget.html#toolTip-prop">QWidget::setToolTip</a>() instead.</p>
<p>For example, if you have code like</p>
<pre><font color="#404040"> tip->add(widget, text);</font></pre>
<p>you can rewrite it as</p>
<pre> widget->setToolTip(text);</pre>
<h3 class="fn"><a name="add-2"></a>void QToolTip::add ( <a href="qwidget.html">QWidget</a> * <i>widget</i>, const <a href="qrect.html">QRect</a> & <i>rect</i>, const <a href="qstring.html">QString</a> & <i>text</i> ) <tt> [static]</tt></h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>Intercept the <a href="qevent.html#Type-enum">QEvent::ToolTip</a> events in your widget's <a href="qwidget.html#event">QWidget::event</a>() function and call <a href="qtooltip.html#showText">QToolTip::showText</a>() with the text you want to display. The <a href="widgets-tooltips.html">Tooltips</a> example illustrates this technique.</p>
<h3 class="fn"><a name="remove"></a>void QToolTip::remove ( <a href="qwidget.html">QWidget</a> * <i>widget</i> ) <tt> [static]</tt></h3>
<p>Use <a href="qwidget.html#toolTip-prop">QWidget::setToolTip</a>() instead.</p>
<p>For example, if you have code like</p>
<pre><font color="#404040"> tip->remove(widget);</font></pre>
<p>you can rewrite it as</p>
<pre> widget->setToolTip("");</pre>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2006 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.2.1</div></td>
</tr></table></div></address></body>
</html>
