Qt Help

Getting Started

To use Qt Help classes, add this directive into the C++ files:

#include <QtHelp>

To link against the Qt Help module, add this line to the project file:

QT += help

Articles and Guides

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.

API Reference

These are links to the API reference material:

License Information

Qt Core is available under commercial licenses from The Qt Company. In addition, it is available under the GNU Lesser General Public License, version 3, or the GNU General Public License, version 2. See Qt Licensing for further details.

Qt Help uses the CLucene indexing library to provide full-text searching capabilities for Qt Assistant and applications that use Qt Help features. CLucene is available under GPL v2.1 or Apache License, Version 2.0.

Clucene Core Library

GNU Lesser General Public License v2.1 only or Apache License, Version 2.0

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