Qt Help C++ Classes

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

Classes

QHelpContentItem

Item for use with QHelpContentModel

QHelpContentModel

Model that supplies content to views

QHelpContentWidget

Tree view for displaying help content model items

QHelpEngine

Access to contents and indices of the help engine

QHelpEngineCore

The core functionality of the help system

QHelpIndexModel

Model that supplies index keywords to views

QHelpIndexWidget

List view displaying the QHelpIndexModel

QHelpSearchEngine

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

QHelpSearchQuery

Contains the field name and the associated search term

QHelpSearchQueryWidget

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

QHelpSearchResultWidget

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