CopperSpice API  1.7.2
QToolTip Class Reference

The QToolTip class provides tool tips (balloon help) for any widget. More...

Static Public Methods

static QFont font ()
 
static void hideText ()
 
static bool isVisible ()
 
static QPalette palette ()
 
static void setFont (const QFont &font)
 
static void setPalette (const QPalette &palette)
 
static void showText (const QPoint &pos, const QString &text, QWidget *widget, const QRect &rect)
 
static void showText (const QPoint &pos, const QString &text, QWidget *widget, const QRect &rect, int msecShowTime)
 
static void showText (const QPoint &pos, const QString &text, QWidget *widget=nullptr)
 
static QString text ()
 

Detailed Description

The QToolTip class provides tool tips (balloon help) for any widget.

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 rich text formatted string.

Rich text displayed in a tool tip is implicitly word-wrapped unless specified differently with <p style='white-space:pre'>.

The simplest and most common way to set a widget's tool tip is by calling its QWidget::setToolTip() function.

It is also possible to show different tool tips for different regions of a widget, by using a QHelpEvent of type QEvent::ToolTip. Intercept the help event in your widget's event() function and call QToolTip::showText() with the text you want to display.

If you are calling QToolTip::hideText(), or QToolTip::showText() with an empty string, as a result of a ToolTip-event you should also call ignore() on the event, to signal that you do not want to start any tooltip specific modes.

Note that, if you want to show tooltips in an item view, the model/view architecture provides functionality to set an item's tool tip; e.g., the QTableWidgetItem::setToolTip() function. However, if you want to provide custom tool tips in an item view, you must intercept the help event in the QAbstractItemView::viewportEvent() function and handle it yourself.

The default tool tip color and font can be customized with setPalette() and setFont(). When a tooltip is currently on display, isVisible() returns true and text() the currently visible text.

Note
Tool tips use the inactive color group of QPalette, because tool tips are not active windows.
See also
QWidget::toolTip, QAction::toolTip

Method Documentation

QFont QToolTip::font ( )
static

Returns the font used to render tooltips.

See also
setFont()
void QToolTip::hideText ( )
inlinestatic

Hides the tool tip. This is the same as calling showText() with an empty string.

See also
showText()
bool QToolTip::isVisible ( )
static

Returns true if this tooltip is currently shown.

See also
showText()
QPalette QToolTip::palette ( )
static

Returns the palette used to render tooltips.

Note
Tool tips use the inactive color group of QPalette, because tool tips are not active windows.
See also
setPalette()
void QToolTip::setFont ( const QFont font)
static

Sets the font used to render tooltips.

See also
font()
void QToolTip::setPalette ( const QPalette palette)
static

Sets the palette used to render tooltips.

Note
Tool tips use the inactive color group of QPalette, because tool tips are not active windows.
See also
palette()
void QToolTip::showText ( const QPoint pos,
const QString text,
QWidget widget,
const QRect rect 
)
static

Shows text as a tool tip, with the global position pos as the point of interest. The tool tip will be shown with a platform specific offset from this point of interest.

If you specify a non-empty rect the tip will be hidden as soon as you move your cursor out of this area.

The rect is in the coordinates of the widget you specify with widget. If the rect is not empty you must specify a widget. Otherwise widget can be a nullptr. The widget argument is used to determine the appropriate screen on multi-head systems.

If text is empty the tool tip is hidden. If the text is the same as the currently shown tooltip, the tip will not move. You can force moving by first hiding the tip with an empty text, and then showing the new tip at the new position.

void QToolTip::showText ( const QPoint pos,
const QString text,
QWidget widget,
const QRect rect,
int  msecShowTime 
)
static

This method is similar to QToolTip::showText(pos, text, w, rect), however one extra parameter msecDisplayTime that specifies how long the tool tip will be displayed, in milliseconds.

void QToolTip::showText ( const QPoint pos,
const QString text,
QWidget widget = nullptr 
)
static

This is analogous to calling QToolTip::showText(pos, text, widget, QRect())

QString QToolTip::text ( )
static

Returns the tooltip text, if a tooltip is visible, or an empty string if a tooltip is not visible.