Detailed Description

Example: Without this class, a tooltip of a QToolButton of a "New" action will read something like "New File". Using this class, the tooltip can be enhanced to read something like "New File (Ctrl+N)" and in the next line smaller "Press Shift for help.". Pressing Shift will open the "What's This" context help for that widget. If a hyperlink in that help is clicked, the corresponding event will also be filtered by this class and open the linked location.

The extra text added to tooltips is only shown when available and where it makes sense. If a QToolButton has no associated shortcut and an empty QWidget::whatsThis(), this class won't tamper with the requested tooltip at all.

This class also activates tooltips for actions in QMenus but only when it makes sense like when the tooltip isn't equal to the already displayed text.

If you want the "Press Shift for help." line to be displayed for a widget that has whatsThis() but no toolTip() take a look at KToolTipHelper::whatsThisHintOnly().

The enhanced tooltips can be enabled at any time after the QApplication was constructed with:

qApp->installEventFilter(KToolTipHelper::instance());

Therefore, to de-activate them you can call the following any time later:

qApp->removeEventFilter(KToolTipHelper::instance());

If you want KToolTipHelper to not tamper with certain QEvents, e.g. you want to handle some tooltips differently or you want to change what happens when a QWhatsThisClickedEvent is processed, first remove KToolTipHelper as an event filter just like in the line of code above. Then create your own custom EventFilter that handles those QEvents differently and, for all cases that you don't want to handle differently, call:

return KToolTipHelper::instance()->eventFilter(watched, event);

Since 5.84, KMainWindow installs this EventFilter by default. If you want to opt out of that, remove the EventFilter in the constructor of your MainWindow class inheriting from KMainWindow.