QHelpEngine Class Reference

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

 #include <QHelpEngine>

Inherits: QHelpEngineCore.

This class was introduced in Qt 4.4.

Public Functions

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

Additional Inherited Members

Detailed Description

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

Member Function Documentation

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

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.

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.

Notes provided by the Qt Community

No notes