Qt 5.7 | Qt Help

Qt 5.7.1 Reference Documentation

# 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:

- C++ Classes

## License Information

Qt Help uses the CLucene indexing library to provide full-text searching capabilities for Qt Assistant and applications that use Qt Help features.

Developers using the Qt Commercial License who wish to distribute applications that use the Qt Help features need to be aware of their obligations under the GNU Lesser General Public License (LGPL).

Developers using the Open Source Edition can choose to redistribute the module under the appropriate version of the GNU LGPL; version 2.1 for applications and libraries licensed under the GNU GPL version 2, or version 3 for applications and libraries licensed under the GNU GPL version 3.

Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team
Changes are Copyright (C) 2016 The Qt Company Ltd.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA