En esta página

QHelpIndexModel Class

La clase QHelpIndexModel ofrece un modelo que proporciona palabras clave de índice a las vistas. Más información...

Encabezado: #include <QHelpIndexModel>
CMake: find_package(Qt6 REQUIRED COMPONENTS Help)
target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake: QT += help
Heredado de: QStringListModel

Funciones públicas

void createIndex(const QString &filter)
(since 6.8) void createIndexForCurrentFilter()
QModelIndex filter(const QString &filter, const QString &wildcard = {})
QHelpEngineCore *helpEngine() const
bool isCreatingIndex() const

Señales

Descripción detallada

Documentación de las funciones de miembro

void QHelpIndexModel::createIndex(const QString &filter)

Crea un nuevo índice consultando el sistema de ayuda en busca de palabras clave para el nombre personalizado especificado: « filter ».

[since 6.8] void QHelpIndexModel::createIndexForCurrentFilter()

Crea un nuevo índice consultando el sistema de ayuda en busca de palabras clave para el filtro actual.

Esta función se introdujo en Qt 6.8.

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

Filtra los índices y devuelve el índice del modelo de la palabra clave que mejor coincide. En un primer paso, solo se conservan en la lista de índices del modelo las palabras clave que contienen « filter ». Del mismo modo, si « wildcard » no está vacía, solo se mantienen en la lista de índices las palabras clave que coinciden. En un segundo paso, se determina la mejor coincidencia y se devuelve el índice del modelo correspondiente. Al especificar una expresión con comodines, se utiliza la cadena « filter » para buscar la mejor coincidencia.

QHelpEngineCore *QHelpIndexModel::helpEngine() const

Devuelve el motor de ayuda asociado que gestiona este modelo.

[signal] void QHelpIndexModel::indexCreated()

Esta señal se emite cuando se ha creado el índice.

[signal] void QHelpIndexModel::indexCreationStarted()

Esta señal se emite cuando se inicia la creación de un nuevo índice. El índice actual deja de ser válido a partir de este momento hasta que se emita la señal indexCreated().

Véase también isCreatingIndex().

bool QHelpIndexModel::isCreatingIndex() const

Devuelve «true» si el índice está actualmente creado; en caso contrario, devuelve «false».

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