Filter documentation

Filter the documents in the Help mode to find relevant information faster. Select a filter from a list of filters. The contents of the Index and Contents view in the sidebar change accordingly.

{Filters on the Help mode toolbar}

Add filters

Define your own filters to show documentation for a set of Qt modules and versions.

To add filters:

  1. Go to Preferences > Help > Filters.

    {Filters tab in Help preferences}

  2. Select to add a new filter in the Add Filter dialog.
  3. In Filter name, enter a name for the filter, and then select OK to return to the Filters tab.
  4. In Components, select the Qt modules to include in the filter.
  5. In Versions, select the Qt versions to include in the filter.
  6. Select OK.
  7. In the Help mode, select the filter in the list of filters to see the filtered documentation in the sidebar.

Change filters

To modify the selected filter, add and remove Qt modules and versions and then select Apply.

To rename the selected filter, select Rename.

Remove filters

To remove the selected filter, select .

See also How To: Read Documentation.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.