Qt Help C++ Classes

Provides classes for integrating online documentation in applications. More...



Item for use with QHelpContentModel


Model that supplies content to views


Tree view for displaying help content model items


Access to contents and indices of the help engine


The core functionality of the help system


Model that supplies index keywords to views


List view displaying the QHelpIndexModel


Access to widgets reusable to integrate fulltext search as well as to index and search documentation


Contains the field name and the associated search term


Simple line edit or an advanced widget to enable the user to input a search term in a standardized input mask


Either a tree widget or a text browser depending on the used search engine to display the hits found by the search

Detailed Description

The classes and tools supplied with Qt to enable developers to include online help and documentation in their applications are described in more detail in The Qt Help Framework overview document.

To include the definitions of the module's classes, use the following directive:

#include <QtHelp>

To link against the module, add this line to your qmake .pro file:

QT += help

© 2017 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.