- Qt 6.8
- Qt Help
- C++ Classes
- QHelpFilterData
- Qt 6.8.0 Reference Documentation

# QHelpFilterData Class

The QHelpFilterData class provides details for the filters used by QHelpFilterEngine. More...

Header: | #include <QHelpFilterData>
CMake: | find_package(Qt6 REQUIRED COMPONENTS Help) target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake: | QT += help

- List of all members, including inherited members

## Public Functions

| QHelpFilterData()
| QHelpFilterData(const QHelpFilterData &other)
| QHelpFilterData(QHelpFilterData &&other)
| ~QHelpFilterData()
QStringList | components() const
void | setComponents(const QStringList &components)
void | setVersions(const QList<QVersionNumber> &versions)
void | swap(QHelpFilterData &other)
QList<QVersionNumber> | versions() const
QHelpFilterData & | operator=(QHelpFilterData &&other)
QHelpFilterData & | operator=(const QHelpFilterData &other)

## Detailed Description

By using setComponents() you may constrain the search results to documents that belong only to components specified on the given list. By using setVersions() you may constrain the search results to documents that belong only to versions specified on the given list.

See also QHelpFilterEngine.

## Member Function Documentation

### QHelpFilterData::QHelpFilterData()

Constructs the empty filter.

### QHelpFilterData::QHelpFilterData(const QHelpFilterData &other)

Constructs a copy of other.

### QHelpFilterData::QHelpFilterData(QHelpFilterData &&other)

Move-constructs a QHelpFilterData instance, making it point at the same object that other was pointing to.

### `[noexcept]` QHelpFilterData::~QHelpFilterData()

Destroys the filter.

### QStringList QHelpFilterData::components() const

Returns the component list that is used for filtering the search results.

See also setComponents().

### void QHelpFilterData::setComponents(const QStringList &components)

Specifies the component list that is used for filtering the search results. Only results from components in the list components shall be returned.

See also components().

### void QHelpFilterData::setVersions(const QList<QVersionNumber> &versions)

Specifies the version list that is used for filtering the search results. Only results from versions in the list versions shall be returned.

See also versions().

### `[noexcept]` void QHelpFilterData::swap(QHelpFilterData &other)

Swaps the filter other with this filter. This operation is very fast and never fails.

### QList<QVersionNumber> QHelpFilterData::versions() const

Returns the version list that is used for filtering the search results.

See also setVersions().

### QHelpFilterData &QHelpFilterData::operator=(QHelpFilterData &&other)

Move-assigns other to this QHelpFilterData instance.

### QHelpFilterData &QHelpFilterData::operator=(const QHelpFilterData &other)

Assigns other to this filter and returns a reference to this filter.