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> |
Inherits: | QWidget |
Public Functions
QHelpSearchQueryWidget(QWidget *parent = nullptr) | |
virtual | ~QHelpSearchQueryWidget() override |
void | collapseExtendedSearch() |
void | expandExtendedSearch() |
QList<QHelpSearchQuery> | query() const |
QString | searchInput() const |
void | setQuery(const QList<QHelpSearchQuery> &queryList) |
void | setSearchInput(const QString &searchInput) |
Signals
void | search() |
Detailed Description
\since
4.4 \inmodule
QtHelp
Member Function Documentation
[explicit]
QHelpSearchQueryWidget::QHelpSearchQueryWidget(QWidget *parent = nullptr)
Constructs a new search query widget with the given parent.
[override virtual noexcept]
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.
QList<QHelpSearchQuery> QHelpSearchQueryWidget::query() const
\deprecated
Use searchInput() instead.
See also setQuery().
[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
\since
5.9
Returns a search phrase to use in combination with the QHelpSearchEngine::search(const QString &searchInput) function.
See also setSearchInput().
void QHelpSearchQueryWidget::setQuery(const QList<QHelpSearchQuery> &queryList)
\deprecated
Use setSearchInput() instead.
See also query().
void QHelpSearchQueryWidget::setSearchInput(const QString &searchInput)
\since
5.9
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.
See also searchInput().