The QtHelp module 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 |
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:
CONFIG += help
The QtHelp module uses the CLucene indexing library to provide full-text searching capabilities for Qt Assistant and applications that use the features of QtHelp.
Qt Commercial Edition licensees that wish to distribute applications that use these features of the QtHelp module 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) 2015 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
See also The Qt Help Framework.