QHelpEngine Class

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

Header: #include <QHelpEngine>
qmake: QT += help
Since: Qt 4.4
Inherits: QHelpEngineCore

This class was introduced in Qt 4.4.

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.

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