QToolTip#

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

Synopsis#

Static functions#

def font ()
def hideText ()
def isVisible ()
def palette ()
def setFont (arg__1)
def setPalette (arg__1)
def showText (pos, text[, w=None[, rect={}[, msecShowTime=-1]]])
def text ()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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'>.

UI elements that are created via QAction use the tooltip property of the QAction, so for most interactive UI elements, setting that property is the easiest way to provide tool tips.

openAction = QAction(tr("Open..."))
openAction.setToolTip(tr("Open an existing file"))
fileMenu = menuBar().addMenu(tr("File"))
fileToolBar = addToolBar(tr("File"))
fileMenu.addAction(openAction)
fileToolBar.addAction(openAction)

For any other widgets, the simplest and most common way to set a widget’s tool tip is by calling its setToolTip() function.

searchBar = SearchBar()
searchBar.setToolTip(tr("Search in the current document"))

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 showText() with the text you want to display.

def event(self, QEvent event):

    if event.type() == QEvent.ToolTip:
        helpEvent = QHelpEvent(event)
        if Element element = elementAt(helpEvent.pos()):
            QToolTip.showText(helpEvent.globalPos(), element.toolTip())
        else:
            QToolTip.hideText()
            event.ignore()

        return True

    return QWidget.event(event)

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.