QxtToolTip Class Reference [QxtGui]

Show any arbitrary widget as a tooltip. More...

#include <qxttooltip.h>

List of all members.

Static Public Member Functions
static void	show (const QPoint &pos, QWidget *tooltip, QWidget *parent=0, const QRect &rect=QRect())
static void	hide ()
static QWidget *	toolTip (QWidget *parent)
static void	setToolTip (QWidget *parent, QWidget *tooltip, const QRect &rect=QRect())
static QRect	toolTipRect (QWidget *parent)
static void	setToolTipRect (QWidget *parent, const QRect &rect)
static int	margin ()
static void	setMargin (int margin)
static qreal	opacity ()
static void	setOpacity (qreal level)

---

Detailed Description

Show any arbitrary widget as a tooltip.

QxtToolTip provides means for showing any arbitrary widget as a tooltip.

Note:

The rich text support of QToolTip 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 QLabel which is then shown as a tooltip. Yet another use case is a tooltip with dynamically changing content.

QxtToolTip in action.

Warning:

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. QToolTip is sufficient for most of the cases!

Definition at line 33 of file qxttooltip.h.

---

Member Function Documentation

void QxtToolTip::hide

(

)

[static]

Hides the tooltip.

See also:

show()

Definition at line 260 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance().

{
    QxtToolTipPrivate::instance()->hide();
}

int QxtToolTip::margin

(

)

[static]

Returns the margin of the tooltip.

See also:

setMargin()

Definition at line 341 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance().

{
    return QxtToolTipPrivate::instance()->layout()->margin();
}

qreal QxtToolTip::opacity

(

)

[static]

Returns the opacity level of the tooltip.

See also:

QWidget::windowOpacity()

Definition at line 363 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance().

{
    return QxtToolTipPrivate::instance()->windowOpacity();
}

void QxtToolTip::setMargin

(

int

margin )

[static]

Sets the margin of the tooltip.

The default value is QStyle::PM_ToolTipLabelFrameWidth.

See also:

margin()

Definition at line 353 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance().

{
    QxtToolTipPrivate::instance()->layout()->setMargin(margin);
}

void QxtToolTip::setOpacity

(

qreal

level )

[static]

Sets the opacity level of the tooltip.

The default value is QStyle::SH_ToolTipLabel_Opacity.

See also:

QWidget::setWindowOpacity()

Definition at line 375 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance().

{
    QxtToolTipPrivate::instance()->setWindowOpacity(level);
}

void QxtToolTip::setToolTip	(	QWidget *	parent,
		QWidget *	tooltip,
		const QRect &	rect = QRect()
	)		[static]

Sets the tooltip to be shown for parent. An optional rect may also be passed.

See also:

toolTip()

Definition at line 287 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance(), and QxtToolTipPrivate::tooltips.

{
    Q_ASSERT(parent);
    if (tooltip)
    {
        // set
        tooltip->hide();
        QxtToolTipPrivate::instance()->tooltips[parent] = qMakePair(QPointer<QWidget>(tooltip), rect);
    }
    else
    {
        // remove
        if (!QxtToolTipPrivate::instance()->tooltips.contains(parent))
            qWarning("QxtToolTip::setToolTip: Unknown parent");
        else
            QxtToolTipPrivate::instance()->tooltips.remove(parent);
    }
}

void QxtToolTip::setToolTipRect	(	QWidget *	parent,
		const QRect &	rect
	)		[static]

Sets the rect on which tooltip is shown for parent.

See also:

toolTipRect()

Definition at line 327 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance(), and QxtToolTipPrivate::tooltips.

{
    Q_ASSERT(parent);
    if (!QxtToolTipPrivate::instance()->tooltips.contains(parent))
        qWarning("QxtToolTip::setToolTipRect: Unknown parent");
    else
        QxtToolTipPrivate::instance()->tooltips[parent].second = rect;
}

void QxtToolTip::show	(	const QPoint &	pos,
		QWidget *	tooltip,
		QWidget *	parent = 0,
		const QRect &	rect = QRect()
	)		[static]

Shows the tooltip at pos for parent at rect.

See also:

hide()

Definition at line 250 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance(), and QxtToolTipPrivate::show().

{
    QxtToolTipPrivate::instance()->show(pos, tooltip, parent, rect);
}

QWidget * QxtToolTip::toolTip

(

QWidget *

parent )

[static]

Returns the tooltip for parent.

See also:

setToolTip()

Definition at line 270 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance(), and QxtToolTipPrivate::tooltips.

{
    Q_ASSERT(parent);
    QWidget* tooltip = 0;
    if (!QxtToolTipPrivate::instance()->tooltips.contains(parent))
        qWarning("QxtToolTip::toolTip: Unknown parent");
    else
        tooltip = QxtToolTipPrivate::instance()->tooltips.value(parent).first;
    return tooltip;
}

QRect QxtToolTip::toolTipRect

(

QWidget *

parent )

[static]

Returns the rect on which tooltip is shown for parent.

See also:

setToolTipRect()

Definition at line 311 of file qxttooltip.cpp.

References QxtToolTipPrivate::instance(), and QxtToolTipPrivate::tooltips.

{
    Q_ASSERT(parent);
    QRect rect;
    if (!QxtToolTipPrivate::instance()->tooltips.contains(parent))
        qWarning("QxtToolTip::toolTipRect: Unknown parent");
    else
        rect = QxtToolTipPrivate::instance()->tooltips.value(parent).second;
    return rect;
}

---

The documentation for this class was generated from the following files:

• qxttooltip.h
• qxttooltip.cpp