QHelpEngine Class

The QHelpEngine class provides access to contents and indices of the help engine. More...

Header:	#include <QHelpEngine>
CMake:	find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake:	QT += help
Inherits:	QHelpEngineCore

List of all members, including inherited members

Public Functions

	QHelpEngine(const QString &collectionFile, QObject *parent = nullptr)
virtual	~QHelpEngine()
QHelpContentModel *	contentModel() const
QHelpContentWidget *	contentWidget()
QHelpIndexModel *	indexModel() const
QHelpIndexWidget *	indexWidget()
QHelpSearchEngine *	searchEngine()

Detailed Description

Member Function Documentation

QHelpEngine::QHelpEngine(const QString &collectionFile, QObject **parent* = nullptr)

Constructs a new help engine with the given parent. The help engine uses the information stored in the collectionFile for providing help. If the collection file does not already exist, it will be created.

`[virtual]` QHelpEngine::~QHelpEngine()

Destroys the help engine object.

QHelpContentModel *QHelpEngine::contentModel() const

Returns the content model.

QHelpContentWidget *QHelpEngine::contentWidget()

Returns the content widget.

QHelpIndexModel *QHelpEngine::indexModel() const

Returns the index model.

QHelpIndexWidget *QHelpEngine::indexWidget()

Returns the index widget.

QHelpSearchEngine *QHelpEngine::searchEngine()

Returns the default search engine.

Contents