QHelpIndexModel 类

QHelpIndexModel 类提供向视图供给索引关键字的模型。更多...

头：	#include <QHelpIndexModel>
CMake:	find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake:	QT += help
继承：	QStringListModel

所有成员列表，包括继承成员

公共函数

void	createIndex (const QString & customFilterName )
QModelIndex	filter (const QString & filter , const QString & wildcard = QString())
QHelpEngineCore *	helpEngine () const
bool	isCreatingIndex () const

信号

void	indexCreated ()
void	indexCreationStarted ()

详细描述

成员函数文档编制

void QHelpIndexModel:: createIndex (const QString & customFilterName )

Creates a new index by querying the help system for keywords for the specified customFilterName .

QModelIndex QHelpIndexModel:: filter (const QString & filter , const QString & wildcard = QString())

Filters the indices and returns the model index of the best matching keyword. In a first step, only the keywords containing filter are kept in the model's index list. Analogously, if wildcard is not empty, only the keywords matched are left in the index list. In a second step, the best match is determined and its index model returned. When specifying a wildcard expression, the filter string is used to search for the best match.

QHelpEngineCore *QHelpIndexModel:: helpEngine () const

返回管理此模型的关联帮助引擎。

`[signal]` void QHelpIndexModel:: indexCreated ()

此信号被发射，当索引被创建时。

`[signal]` void QHelpIndexModel:: indexCreationStarted ()

This signal is emitted when the creation of a new index has started. The current index is invalid from this point on until the signal indexCreated () 被发射。

另请参阅 isCreatingIndex ().

bool QHelpIndexModel:: isCreatingIndex () const

返回 true 若索引目前已建立，否则 false。