<?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">
<!-- /builddir/build/BUILD/libqxt/src/gui/qxttooltip.cpp -->
<head>
<title>QxtToolTip Class Reference</title>
<link href="stylesheet.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://libqxt.org"><img src="images/qxt-logo.png" width="50" height="40" align="left" 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="modules.html"><font color="#004faf">Modules</font></a> · <a href="classes.html"><font color="#004faf">Classes</font></a> · <a href="namespaces.html"><font color="#004faf">Namespaces</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QxtToolTip Class Reference<br /><span class="small-subtitle">[<a href="qxtgui.html">QxtGui</a> module]</span>
</h1>
<p>The QxtToolTip class provides means for showing any arbitrary widget as a tooltip. <a href="#details">More...</a></p>
<pre> #include <QxtToolTip></pre><ul>
<li><a href="qxttooltip-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="static-public-members"></a>
<h3>Static Public Members</h3>
<ul>
<li><div class="fn"></div>void <b><a href="qxttooltip.html#hide">hide</a></b> ()</li>
<li><div class="fn"></div>int <b><a href="qxttooltip.html#margin">margin</a></b> ()</li>
<li><div class="fn"></div>qreal <b><a href="qxttooltip.html#opacity">opacity</a></b> ()</li>
<li><div class="fn"></div>void <b><a href="qxttooltip.html#setMargin">setMargin</a></b> ( int <i>margin</i> )</li>
<li><div class="fn"></div>void <b><a href="qxttooltip.html#setOpacity">setOpacity</a></b> ( qreal <i>level</i> )</li>
<li><div class="fn"></div>void <b><a href="qxttooltip.html#setToolTip">setToolTip</a></b> ( QWidget * <i>parent</i>, QWidget * <i>tooltip</i>, const QRect & <i>rect</i> = QRect() )</li>
<li><div class="fn"></div>void <b><a href="qxttooltip.html#setToolTipRect">setToolTipRect</a></b> ( QWidget * <i>parent</i>, const QRect & <i>rect</i> )</li>
<li><div class="fn"></div>void <b><a href="qxttooltip.html#show">show</a></b> ( const QPoint & <i>pos</i>, QWidget * <i>tooltip</i>, QWidget * <i>parent</i> = 0, const QRect & <i>rect</i> = QRect() )</li>
<li><div class="fn"></div>QWidget * <b><a href="qxttooltip.html#toolTip">toolTip</a></b> ( QWidget * <i>parent</i> )</li>
<li><div class="fn"></div>QRect <b><a href="qxttooltip.html#toolTipRect">toolTipRect</a></b> ( QWidget * <i>parent</i> )</li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QxtToolTip class provides means for showing any arbitrary widget as a tooltip.</p>
<p>QxtToolTip provides means for showing any arbitrary widget as a tooltip.</p>
<p><b>Note:</b> The rich text support of <a href="http://doc.qtsoftware.com/4.5/qtooltip.html">QToolTip</a> already makes it possible to show heavily customized tooltips with lists, tables, embedded images and such. However, for example dynamically created images like thumbnails cause problems. Basically the only way is to dump the thumbnail to a temporary file to be able to embed it into HTML. This is where QxtToolTip steps in. A generated thumbnail may simply be set on a <a href="http://doc.qtsoftware.com/4.5/qlabel.html">QLabel</a> which is then shown as a tooltip. Yet another use case is a tooltip with dynamically changing content.</p>
<p align="center"><img src="images/qxttooltip.png" alt=""QxtToolTip in action."" /></p><p><b>Warning:</b> Added tooltip widgets remain in the memory for the lifetime of the application or until they are removed/deleted. Do NOT flood your application up with lots of complex tooltip widgets or it will end up being a resource hog. <a href="http://doc.qtsoftware.com/4.5/qtooltip.html">QToolTip</a> is sufficient for most of the cases!</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="hide"></a>void QxtToolTip::hide () <tt> [static]</tt></h3>
<p>Hides the tooltip.</p>
<p>See also <a href="qxttooltip.html#show">show</a>().</p>
<h3 class="fn"><a name="margin"></a>int QxtToolTip::margin () <tt> [static]</tt></h3>
<p>Returns the margin of the tooltip.</p>
<p>See also <a href="qxttooltip.html#setMargin">setMargin</a>().</p>
<h3 class="fn"><a name="opacity"></a><a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qreal-typedef">qreal</a> QxtToolTip::opacity () <tt> [static]</tt></h3>
<p>Returns the opacity level of the tooltip.</p>
<p>See also <a href="qxttooltip.html#setOpacity">setOpacity</a>() and <a href="http://doc.qtsoftware.com/4.5/qwidget.html#windowOpacity-prop">QWidget::windowOpacity</a>().</p>
<h3 class="fn"><a name="setMargin"></a>void QxtToolTip::setMargin ( int <i>margin</i> ) <tt> [static]</tt></h3>
<p>Sets the <i>margin</i> of the tooltip.</p>
<p>The default value is <a href="http://doc.qtsoftware.com/4.5/qstyle.html#PixelMetric-enum">QStyle::PM_ToolTipLabelFrameWidth</a>.</p>
<p>See also <a href="qxttooltip.html#margin">margin</a>().</p>
<h3 class="fn"><a name="setOpacity"></a>void QxtToolTip::setOpacity ( <a href="http://doc.qtsoftware.com/4.5/qtglobal.html#qreal-typedef">qreal</a> <i>level</i> ) <tt> [static]</tt></h3>
<p>Sets the opacity <i>level</i> of the tooltip.</p>
<p>The default value is <a href="http://doc.qtsoftware.com/4.5/qstyle.html#StyleHint-enum">QStyle::SH_ToolTipLabel_Opacity</a>.</p>
<p>See also <a href="qxttooltip.html#opacity">opacity</a>() and <a href="http://doc.qtsoftware.com/4.5/qwidget.html#windowOpacity-prop">QWidget::setWindowOpacity</a>().</p>
<h3 class="fn"><a name="setToolTip"></a>void QxtToolTip::setToolTip ( <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>parent</i>, <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>tooltip</i>, const <a href="http://doc.qtsoftware.com/4.5/qrect.html">QRect</a> & <i>rect</i> = QRect() ) <tt> [static]</tt></h3>
<p>Sets the <i>tooltip</i> to be shown for <i>parent</i>. An optional <i>rect</i> may also be passed.</p>
<p>See also <a href="qxttooltip.html#toolTip">toolTip</a>().</p>
<h3 class="fn"><a name="setToolTipRect"></a>void QxtToolTip::setToolTipRect ( <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>parent</i>, const <a href="http://doc.qtsoftware.com/4.5/qrect.html">QRect</a> & <i>rect</i> ) <tt> [static]</tt></h3>
<p>Sets the <i>rect</i> on which tooltip is shown for <i>parent</i>.</p>
<p>See also <a href="qxttooltip.html#toolTipRect">toolTipRect</a>().</p>
<h3 class="fn"><a name="show"></a>void QxtToolTip::show ( const <a href="http://doc.qtsoftware.com/4.5/qpoint.html">QPoint</a> & <i>pos</i>, <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>tooltip</i>, <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>parent</i> = 0, const <a href="http://doc.qtsoftware.com/4.5/qrect.html">QRect</a> & <i>rect</i> = QRect() ) <tt> [static]</tt></h3>
<p>Shows the <i>tooltip</i> at <i>pos</i> for <i>parent</i> at <i>rect</i>.</p>
<p>See also <a href="qxttooltip.html#hide">hide</a>().</p>
<h3 class="fn"><a name="toolTip"></a><a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * QxtToolTip::toolTip ( <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>parent</i> ) <tt> [static]</tt></h3>
<p>Returns the tooltip for <i>parent</i>.</p>
<p>See also <a href="qxttooltip.html#setToolTip">setToolTip</a>().</p>
<h3 class="fn"><a name="toolTipRect"></a><a href="http://doc.qtsoftware.com/4.5/qrect.html">QRect</a> QxtToolTip::toolTipRect ( <a href="http://doc.qtsoftware.com/4.5/qwidget.html">QWidget</a> * <i>parent</i> ) <tt> [static]</tt></h3>
<p>Returns the rect on which tooltip is shown for <i>parent</i>.</p>
<p>See also <a href="qxttooltip.html#setToolTipRect">setToolTipRect</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2007-2010
<a href="mailto:foundation@libqxt.org">Qxt Foundation</a></td>
<td align="right"><div align="right">
<a href="http://libqxt.org">Qxt</a> 0.6.1</div></td>
</tr></table></div></address></body>
</html>
