QHelpFilterData Class Reference

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

#include <qhelpfilterdata.h>

Collaboration diagram for QHelpFilterData:

Public Member Functions
	QHelpFilterData ()
	Constructs the empty filter.
	QHelpFilterData (const QHelpFilterData &other)
	Constructs a copy of other.
	QHelpFilterData (QHelpFilterData &&other)
	Move-constructs a QHelpFilterData instance, making it point at the same object that other was pointing to.
	~QHelpFilterData ()
	Destroys the filter.
QHelpFilterData &	operator= (const QHelpFilterData &other)
	Assigns other to this filter and returns a reference to this filter.
QHelpFilterData &	operator= (QHelpFilterData &&other)
	Move-assigns other to this QHelpFilterData instance.
bool	operator== (const QHelpFilterData &other) const
void	swap (QHelpFilterData &other) Q_DECL_NOTHROW
	Swaps the filter other with this filter.
void	setComponents (const QStringList &components)
	Specifies the component list that is used for filtering the search results.
void	setVersions (const QList< QVersionNumber > &versions)
	Specifies the version list that is used for filtering the search results.
QStringList	components () const
	Returns the component list that is used for filtering the search results.
QList< QVersionNumber >	versions () const
	Returns the version list that is used for filtering the search results.

Detailed Description

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

Since

5.13 \inmodule QtHelp

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

Definition at line 16 of file qhelpfilterdata.h.

Constructor & Destructor Documentation

QHelpFilterData() [1/3]

QHelpFilterData::QHelpFilterData

(

)

Constructs the empty filter.

Definition at line 42 of file qhelpfilterdata.cpp.

QHelpFilterData() [2/3]

QHelpFilterData::QHelpFilterData ( const QHelpFilterData & other )

default

Constructs a copy of other.

QHelpFilterData() [3/3]

QHelpFilterData::QHelpFilterData ( QHelpFilterData && other )

default

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

~QHelpFilterData()

QHelpFilterData::~QHelpFilterData ( )

default

Destroys the filter.

Member Function Documentation

components()

QStringList QHelpFilterData::components

(

)

const

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

Definition at line 105 of file qhelpfilterdata.cpp.

operator=() [1/2]

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

default

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

operator=() [2/2]

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

default

Move-assigns other to this QHelpFilterData instance.

operator==()

bool QHelpFilterData::operator==

(

const QHelpFilterData &

other

)

const

Definition at line 76 of file qhelpfilterdata.cpp.

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.

Definition at line 86 of file qhelpfilterdata.cpp.

setVersions()

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.

Definition at line 96 of file qhelpfilterdata.cpp.

swap()

void QHelpFilterData::swap ( QHelpFilterData & other )

inline

Swaps the filter other with this filter.

This operation is very fast and never fails.

Definition at line 28 of file qhelpfilterdata.h.

versions()

QList< QVersionNumber > QHelpFilterData::versions

(

)

const

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

Definition at line 114 of file qhelpfilterdata.cpp.

---

The documentation for this class was generated from the following files:

• qttools/src/assistant/help/qhelpfilterdata.h (a54746cc812b52ca52cbb997305864502498488b)
• qttools/src/assistant/help/qhelpfilterdata.cpp (25a36bca696023c9fe8ea7514a074df360660473)