QToolTip

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

Inheritance diagram of PySide2.QtWidgets.QToolTip

Synopsis

Static functions

Detailed Description

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 setToolTip() function.

It is also possible to show different tool tips for different regions of a widget, by using a QHelpEvent of type ToolTip . Intercept the help event in your widget’s event() function and call showText() with the text you want to display. The Tooltips example illustrates this technique.

If you are calling hideText() , or showText() with an empty string, as a result of a ToolTip -event you should also call ignore() on the event, to signal that you don’t 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 setToolTip() function. However, if you want to provide custom tool tips in an item view, you must intercept the help event in the 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

toolTip toolTip Tool Tips Example

class PySide2.QtWidgets.QToolTip
static PySide2.QtWidgets.QToolTip.font()
Return type:

PySide2.QtGui.QFont

Returns the font used to render tooltips.

See also

setFont()

static PySide2.QtWidgets.QToolTip.hideText()

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

See also

showText()

static PySide2.QtWidgets.QToolTip.isVisible()
Return type:

bool

Returns true if this tooltip is currently shown.

See also

showText()

static PySide2.QtWidgets.QToolTip.palette()
Return type:

PySide2.QtGui.QPalette

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()

static PySide2.QtWidgets.QToolTip.setFont(arg__1)
Parameters:

arg__1 – PySide2.QtGui.QFont

Sets the font used to render tooltips.

See also

font()

static PySide2.QtWidgets.QToolTip.setPalette(arg__1)
Parameters:

arg__1 – PySide2.QtGui.QPalette

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()

static PySide2.QtWidgets.QToolTip.showText(pos, text[, w=None])
Parameters:

This is an overloaded function.

This is analogous to calling showText (pos , text , w , QRect())

static PySide2.QtWidgets.QToolTip.showText(pos, text, w, rect)
Parameters:

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 w . If the rect is not empty you must specify a widget. Otherwise this argument can be None but it 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.

static PySide2.QtWidgets.QToolTip.showText(pos, text, w, rect, msecShowTime)
Parameters:

This is an overloaded function.

This is similar to showText (pos , text , w , rect ) but with an extra parameter msecDisplayTime that specifies how long the tool tip will be displayed, in milliseconds.

static PySide2.QtWidgets.QToolTip.text()
Return type:

str

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