Remove instances of "Whats This" help tool
General Description
There are three types of user help provided in Qt:
-
Tool Tips
(shown by hovering the mouse over a widget) -
Status Tips
(shown in the Status Bar) -
Whats This
tips shown by different methods depending on the platform (Windows: using the "?" in the Title Bar - Linux: using a Title Bar menu item)
This screenshot shows the Whats This
utilization tool for Windows (indicated by red circle)
The proper use of these three tools is described here: https://flylib.com/books/en/2.18.1/tooltips_status_tips_and_whats_this_help.html
The GUI facility for interacting with Whats This
tips is exposed by default for QDialog
, and anything that inherits it.
Whats This
tips are barely used in Paraview
. They are intended to be more verbose than Tool Tips
, and are only properly used in a single file (pqLightsEditor.ui
). In most cases in Paraview
, they simply duplicate the content of the Tool Tip
, or would be better suited as a Tool Tip
(given how short they are).
Suggested Changes
Whats This
tips should be removed from the project, and (more importantly) the buttons and menu items that enable Whats This
tips to be exposed should be removed, as well.
Hiding Window Title Bar Items
A single line of code hides the UI facility for interacting with the Whats This
tips:
dialog->setWindowFlags(dialog->windowFlags() & ~Qt::WindowContextHelpButtonHint);
This would need to be added everywhere a QDialog
or QFileDialog
is used.
Whats This
tips
Removing all definitions of There are no uses of QWidget::setWhatsThis()
in the project, meaning that all Whats This
tips are defined in .ui
files. Removing redundant tips, and changing the rest to be Tool Tips
will fully suffice for all .ui
except for pqLightsEditor.ui
. This is the only file where some information will be lost - probably information that was never used by anyone, but information none the less. Twelve .ui
files will be affected.