QHelpSearchQueryWidget Class

The QHelpSearchQueryWidget class provides a simple line edit or an advanced widget to enable the user to input a search term in a standardized input mask. More...

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

Public Functions

	QHelpSearchQueryWidget(QWidget *parent = nullptr)
virtual	~QHelpSearchQueryWidget() override
void	collapseExtendedSearch()
void	expandExtendedSearch()
QString	searchInput() const
void	setSearchInput(const QString &searchInput)

Signals

void	search()

Detailed Description

Member Function Documentation

QHelpSearchQueryWidget::QHelpSearchQueryWidget(QWidget **parent* = nullptr)

Constructs a new search query widget with the given parent.

`[signal]` void QHelpSearchQueryWidget::search()

This signal is emitted when a the user has the search button invoked. After receiving the signal you can ask the QHelpSearchQueryWidget for the search input that you may pass to the QHelpSearchEngine::search() function.

`[override virtual]` QHelpSearchQueryWidget::~QHelpSearchQueryWidget()

Destroys the search query widget.

void QHelpSearchQueryWidget::collapseExtendedSearch()

Collapses the search query widget so that only the default search field is shown.

void QHelpSearchQueryWidget::expandExtendedSearch()

Expands the search query widget so that the extended search fields are shown.

`[since 5.9]` QString QHelpSearchQueryWidget::searchInput() const

Returns a search phrase to use in combination with the QHelpSearchEngine::search(const QString &searchInput) function.

This function was introduced in Qt 5.9.

See also setSearchInput().

`[since 5.9]` void QHelpSearchQueryWidget::setSearchInput(const QString &searchInput)

Sets the QHelpSearchQueryWidget input field to the value specified by searchInput.

Note: The QHelpSearchEngine::search(const QString &searchInput) function has to be called to perform the actual search.

This function was introduced in Qt 5.9.

See also searchInput().

Contents

QHelpSearchQueryWidget Class

Public Functions

Signals

Detailed Description

Member Function Documentation

QHelpSearchQueryWidget::QHelpSearchQueryWidget(QWidget *parent = nullptr)

[signal] void QHelpSearchQueryWidget::search()

[override virtual] QHelpSearchQueryWidget::~QHelpSearchQueryWidget()

void QHelpSearchQueryWidget::collapseExtendedSearch()

void QHelpSearchQueryWidget::expandExtendedSearch()

[since 5.9] QString QHelpSearchQueryWidget::searchInput() const

[since 5.9] void QHelpSearchQueryWidget::setSearchInput(const QString &searchInput)

Sign Up and Download for Free

QHelpSearchQueryWidget::QHelpSearchQueryWidget(QWidget **parent* = nullptr)

`[signal]` void QHelpSearchQueryWidget::search()

`[override virtual]` QHelpSearchQueryWidget::~QHelpSearchQueryWidget()

`[since 5.9]` QString QHelpSearchQueryWidget::searchInput() const

`[since 5.9]` void QHelpSearchQueryWidget::setSearchInput(const QString &searchInput)