- Qt 5.15
- Qt Help
- C++ Classes
- QHelpEngineCore
- Qt 5.15.17 Reference Documentation

# Obsolete Members for QHelpEngineCore

The following members of class QHelpEngineCore are obsolete. They are provided to keep old source code working. We strongly advise against using them in new code.

## Properties

- `(obsolete)` currentFilter : QString

## Public Functions

`(obsolete)` bool | addCustomFilter(const QString &filterName, const QStringList &attributes)
`(obsolete)` QString | currentFilter() const
`(obsolete)` QStringList | customFilters() const
`(obsolete)` QList<QUrl> | files(const QString namespaceName, const QStringList &filterAttributes, const QString &extensionFilter = QString())
`(obsolete)` QList<QStringList> | filterAttributeSets(const QString &namespaceName) const
`(obsolete)` QStringList | filterAttributes() const
`(obsolete)` QStringList | filterAttributes(const QString &filterName) const
`(obsolete)` QMap<QString, QUrl> | linksForIdentifier(const QString &id) const
`(obsolete)` QMap<QString, QUrl> | linksForKeyword(const QString &keyword) const
`(obsolete)` bool | removeCustomFilter(const QString &filterName)
`(obsolete)` void | setCurrentFilter(const QString &filterName)

## Signals

`(obsolete)` void | currentFilterChanged(const QString &newFilter)
`(obsolete)` void | readersAboutToBeInvalidated()

## Property Documentation

### currentFilter : QString

This property is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

This property holds the name of the custom filter currently applied.

QHelpFilterEngine::activeFilter() should be used instead.

Setting this property will save the new custom filter permanently in the help collection file. To set a custom filter without saving it permanently, disable the auto save filter mode.

This property was introduced in Qt 4.5.

Access functions:

QString | currentFilter() const
void | setCurrentFilter(const QString &filterName)

See also autoSaveFilter().

## Member Function Documentation

### `[signal]` void QHelpEngineCore::currentFilterChanged(const QString &newFilter)

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

QHelpFilterEngine::filterActivated() should be used instead.

This signal is emitted when the current filter is changed to newFilter.

### `[signal]` void QHelpEngineCore::readersAboutToBeInvalidated()

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

### bool QHelpEngineCore::addCustomFilter(const QString &filterName, const QStringList &attributes)

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

QHelpFilterEngine::setFilterData() should be used instead.

Adds the new custom filter filterName. The filter attributes are specified by attributes. If the filter already exists, its attribute set is replaced. The function returns true if the operation succeeded, otherwise it returns false.

See also customFilters() and removeCustomFilter().

### QStringList QHelpEngineCore::customFilters() const

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

QHelpFilterEngine::filters() should be used instead.

Returns a list of custom filters.

See also addCustomFilter() and removeCustomFilter().

### QList<QUrl> QHelpEngineCore::files(const QString namespaceName, const QStringList &filterAttributes, const QString &extensionFilter = QString())

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

files() should be used instead.

Returns a list of files contained in the Qt compressed help file namespaceName. The files can be filtered by filterAttributes as well as by their extension extensionFilter (e.g. 'html').

### QList<QStringList> QHelpEngineCore::filterAttributeSets(const QString &namespaceName) const

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

QHelpFilterEngine::filterData() should be used instead.

Returns a list of filter attributes for the different filter sections defined in the Qt compressed help file with the given namespace namespaceName.

### QStringList QHelpEngineCore::filterAttributes() const

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

QHelpFilterEngine::availableComponents() should be used instead.

Returns a list of all defined filter attributes.

### QStringList QHelpEngineCore::filterAttributes(const QString &filterName) const

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

QHelpFilterEngine::filterData() should be used instead.

Returns a list of filter attributes used by the custom filter filterName.

### QMap<QString, QUrl> QHelpEngineCore::linksForIdentifier(const QString &id) const

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Use documentsForIdentifier() instead.

Returns a map of the documents found for the id. The map contains the document titles and their URLs. The returned map contents depend on the current filter, and therefore only the identifiers registered for the current filter will be returned.

### QMap<QString, QUrl> QHelpEngineCore::linksForKeyword(const QString &keyword) const

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Use documentsForKeyword() instead.

Returns a map of all the documents found for the keyword. The map contains the document titles and URLs. The returned map contents depend on the current filter, and therefore only the keywords registered for the current filter will be returned.

### bool QHelpEngineCore::removeCustomFilter(const QString &filterName)

This function is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

QHelpFilterEngine::removeFilter() should be used instead.

Returns true if the filter filterName was removed successfully, otherwise false.

See also addCustomFilter() and customFilters().