Obsolete Members for QHelpEngineCore | Qt Help | Qt 6.10.3
Description: The QHelpEngineCore class provides the core functionality of the help system.

- Qt 6.10
- Qt Help
- C++ Classes
- QHelpEngineCore
- Qt 6.10.3 Reference Documentation

# Obsolete Members for QHelpEngineCore

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

## Properties

- `(deprecated)` currentFilter : QString

## Public Functions

`(deprecated)` bool | addCustomFilter(const QString &filterName, const QStringList &attributes)
`(deprecated)` QString | currentFilter() const
`(deprecated)` QStringList | customFilters() const
`(deprecated)` QList<QUrl> | files(const QString namespaceName, const QStringList &filterAttributes, const QString &extensionFilter = {})
`(deprecated)` QList<QStringList> | filterAttributeSets(const QString &namespaceName) const
`(deprecated)` QStringList | filterAttributes() const
`(deprecated)` QStringList | filterAttributes(const QString &filterName) const
`(deprecated)` bool | removeCustomFilter(const QString &filterName)
`(deprecated)` void | setCurrentFilter(const QString &filterName)

## Signals

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

## Property Documentation

### `[deprecated]` currentFilter : QString

This property is deprecated. 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.

Access functions:

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

See also autoSaveFilter().

## Member Function Documentation

### `[deprecated]` bool QHelpEngineCore::addCustomFilter(const QString &filterName, const QStringList &attributes)

This function is deprecated. 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().

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

This function is deprecated. 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.

### `[deprecated]` QStringList QHelpEngineCore::customFilters() const

This function is deprecated. 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().

### `[deprecated]` QList<QUrl> QHelpEngineCore::files(const QString namespaceName, const QStringList &filterAttributes, const QString &extensionFilter = {})

This function is deprecated. 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').

### `[deprecated]` QList<QStringList> QHelpEngineCore::filterAttributeSets(const QString &namespaceName) const

This function is deprecated. 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.

### `[deprecated]` QStringList QHelpEngineCore::filterAttributes() const

This function is deprecated. We strongly advise against using it in new code.

QHelpFilterEngine::availableComponents() should be used instead.

Returns a list of all defined filter attributes.

### `[deprecated]` QStringList QHelpEngineCore::filterAttributes(const QString &filterName) const

This function is deprecated. 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.

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

This function is deprecated. We strongly advise against using it in new code.

### `[deprecated]` bool QHelpEngineCore::removeCustomFilter(const QString &filterName)

This function is deprecated. 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().