QHelpEngineCore Class

Documentación de funciones miembro

[explicit] QHelpEngineCore::QHelpEngineCore(const QString &collectionFile, QObject *parent = nullptr)

Construye un nuevo motor de ayuda del núcleo con un parent. El motor de ayuda utiliza la información almacenada en el collectionFile para proporcionar ayuda. Si el archivo de colección aún no existe, se creará.

[virtual noexcept] QHelpEngineCore::~QHelpEngineCore()

Destruye el motor de ayuda.

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

Crea el archivo fileName y copia todo el contenido del archivo de colección actual en el archivo recién creado, y devuelve true si se ha realizado correctamente; en caso contrario, devuelve false.

El proceso de copia se asegura de que las referencias a los archivos de colección de Qt (.qch) se actualicen en consecuencia.

QVariant QHelpEngineCore::customValue(const QString &key, const QVariant &defaultValue = {}) const

Devuelve el valor asignado a la key. Si la clave solicitada no existe, se devuelve la defaultValue especificada.

Véase también setCustomValue() y removeCustomValue().

QString QHelpEngineCore::documentationFileName(const QString &namespaceName)

Devuelve el nombre de archivo absoluto del archivo de ayuda comprimido Qt (.qch) identificado por namespaceName. Si no hay ningún archivo de ayuda comprimido Qt con el espacio de nombres especificado registrado, se devuelve una cadena vacía.

Véase también namespaceName().

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id) const

Devuelve una lista de todos los enlaces de documentos encontrados para el id. El contenido de la lista devuelta depende del filtro actual, por lo que sólo se devolverán las palabras clave registradas para el filtro actual.

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id, const QString &filterName) const

Devuelve una lista de los enlaces de documentos encontrados para el id, filtrados por filterName. El contenido de la lista devuelta depende del filtro pasado, por lo que sólo se devolverán las palabras clave registradas para este filtro. Si desea obtener todos los resultados sin filtrar, pase una cadena vacía como filterName.

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword) const

Devuelve una lista de todos los enlaces de documentos encontrados para el keyword. El contenido de la lista devuelta depende del filtro actual, por lo que sólo se devolverán las palabras clave registradas para el filtro actual.

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword, const QString &filterName) const

Devuelve una lista de los enlaces de documentos encontrados para el keyword, filtrados por filterName. El contenido de la lista devuelta depende del filtro pasado, por lo que sólo se devolverán las palabras clave registradas para este filtro. Si desea obtener todos los resultados sin filtrar, pase una cadena vacía como filterName.

QString QHelpEngineCore::error() const

Devuelve una descripción del último error que se ha producido.

QByteArray QHelpEngineCore::fileData(const QUrl &url) const

Devuelve los datos del archivo especificado por url. Si el archivo no existe, se devuelve un QByteArray vacío.

Véase también findFile().

QList<QUrl> QHelpEngineCore::files(const QString namespaceName, const QString &filterName, const QString &extensionFilter = {})

Devuelve una lista de los archivos contenidos en el archivo de ayuda comprimido de Qt para namespaceName. Los archivos pueden filtrarse por filterName así como por su extensión extensionFilter (por ejemplo, 'html').

QHelpFilterEngine *QHelpEngineCore::filterEngine() const

Devuelve el motor de filtrado asociado a este motor de ayuda. El motor de filtros permite añadir, cambiar y eliminar filtros existentes para este motor de ayuda. Para utilizar el motor también hay que llamar a setUsesFilterEngine() ajustado a true.

QUrl QHelpEngineCore::findFile(const QUrl &url) const

Devuelve la URL corregida para el url que puede referirse a un espacio de nombres diferente definido por la carpeta virtual definida como parte del url. Si la carpeta virtual coincide con el espacio de nombres del url, el método sólo comprueba si el archivo existe y devuelve el mismo url. Si la carpeta virtual no coincide con el espacio de nombres de url, intenta encontrar el espacio de nombres que mejor coincida según el filtro activo. Cuando encuentra el espacio de nombres, devuelve la URL corregida si el archivo existe, en caso contrario devuelve una URL no válida.

[static] QVariant QHelpEngineCore::metaData(const QString &documentationFileName, const QString &name)

Devuelve los metadatos del archivo de ayuda comprimido de Qt documentationFileName. Si no hay datos disponibles para name, se devuelve un QVariant() inválido. Los metadatos se definen al crear el archivo de ayuda comprimido Qt y no pueden modificarse posteriormente. Los metadatos comunes incluyen, por ejemplo, el autor de la documentación.

[static] QString QHelpEngineCore::namespaceName(const QString &documentationFileName)

Devuelve el nombre del espacio de nombres definido para el archivo de ayuda comprimido Qt (.qch) especificado por su documentationFileName. Si el archivo no es válido, se devuelve una cadena vacía.

Véase también documentationFileName().

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

Registra el archivo de ayuda comprimido Qt (.qch) contenido en el archivo documentationFileName. Un archivo de ayuda comprimido, identificado unívocamente por su espacio de nombres, sólo puede ser registrado una vez. Se devuelve true si el registro se ha realizado correctamente, en caso contrario false.

Véase también unregisterDocumentation() y error().

QStringList QHelpEngineCore::registeredDocumentations() const

Devuelve una lista de todos los archivos de ayuda comprimidos Qt registrados del archivo de colección actual. Los nombres devueltos son los espacios de nombres de los archivos de ayuda comprimida Qt (.qch) registrados.

bool QHelpEngineCore::removeCustomValue(const QString &key)

Elimina la dirección key de la sección de configuración del archivo de recogida. Devuelve true si el valor se ha eliminado correctamente, en caso contrario false.

Véase también customValue() y setCustomValue().

bool QHelpEngineCore::setCustomValue(const QString &key, const QVariant &value)

Guarda el value bajo el key. Si la clave ya existe, el valor será sobrescrito. Devuelve true si el valor se ha guardado correctamente, en caso contrario false.

Véase también customValue() y removeCustomValue().

void QHelpEngineCore::setUsesFilterEngine(bool uses)

Activa o desactiva la funcionalidad del nuevo motor de filtrado dentro del motor de ayuda, según el parámetro uses pasado.

Véase también usesFilterEngine() y filterEngine().

bool QHelpEngineCore::setupData()

Configura el motor de ayuda procesando la información encontrada en el fichero de colección y devuelve true si se ha realizado correctamente; en caso contrario devuelve false.

Al llamar a esta función, se obliga al motor de ayuda a inicializarse inmediatamente. La mayoría de las veces, esta función no tiene que ser llamada explícitamente porque las funciones getter que dependen de un motor de ayuda correctamente configurado lo hacen por sí mismas.

[signal] void QHelpEngineCore::setupFinished()

Esta señal se emite cuando la configuración ha finalizado.

[signal] void QHelpEngineCore::setupStarted()

Esta señal se emite cuando se inicia la configuración.

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

Desregistra el archivo de ayuda comprimido Qt (.qch) identificado por su namespaceName de la colección de ayuda. Devuelve true en caso de éxito, false en caso contrario.

Véase también registerDocumentation() y error().

bool QHelpEngineCore::usesFilterEngine() const

Devuelve si el motor de ayuda utiliza la nueva funcionalidad de filtro.

Véase también setUsesFilterEngine() y filterEngine().

[signal] void QHelpEngineCore::warning(const QString &msg)

Esta señal se emite cuando se produce un error no crítico. El mensaje de advertencia se almacena en msg.