Qt Help C++ Classes

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

Classes

QCompressedHelpInfo	Access to the details about a compressed help file
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
QHelpFilterData	Details for the filters used by QHelpFilterEngine
QHelpFilterEngine	Filtered view of the help contents
QHelpFilterSettingsWidget	Widget that allows for creating, editing and removing filters
QHelpIndexModel	Model that supplies index keywords to views
QHelpIndexWidget	List view displaying the QHelpIndexModel
QHelpLink	Struct provides the data associated with a help link
QHelpSearchEngine	Access to widgets reusable to integrate fulltext search as well as to index and search documentation
QHelpSearchEngineCore	Access to index and search documentation
QHelpSearchQueryWidget	Simple line edit or an advanced widget to enable the user to input a search term in a standardized input mask
QHelpSearchResult	The data associated with the search result
QHelpSearchResultWidget	Text browser to display search results

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 link against the module, add this line to your qmake .pro file:

QT += help

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