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>
qmake:	QT += help
Since:	Qt 4.4
Inherits:	QWidget

Public Functions

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

219 public functions inherited from QWidget
33 public functions inherited from QObject

Public Slots

void	setCompactMode(bool on)

19 public slots inherited from QWidget
1 public slot inherited from QObject

Signals

void	search()

3 signals inherited from QWidget
2 signals inherited from QObject

Additional Inherited Members

59 properties inherited from QWidget
1 property inherited from QObject
1 public variable inherited from QWidget
1 public variable inherited from QObject
7 static public members inherited from QWidget
10 static public members inherited from QObject
35 protected functions inherited from QWidget
9 protected functions inherited from QObject
1 protected slot inherited from QWidget
2 protected variables inherited from QObject

Detailed Description

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.

Member Function Documentation

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

Constructs a new search query widget with the given parent.

`[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.

bool QHelpSearchQueryWidget::isCompactMode() const

`[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.

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().

`[slot]` void QHelpSearchQueryWidget::setCompactMode(bool on)

See also isCompactMode().

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.