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() override |
| void | collapseExtendedSearch() |
| void | expandExtendedSearch() |
| bool | isCompactMode() const |
| QString | searchInput() const |
| void | setSearchInput(const QString &searchInput) |
Public Slots
| void | setCompactMode(bool on) |
Signals
| void | search() |
Static Public Members
| const QMetaObject | staticMetaObject |
Additional Inherited Members
- 59 properties inherited from QWidget
- 1 property inherited from QObject
- 35 protected functions inherited from QWidget
- 9 protected functions inherited from QObject
- 1 protected slot inherited from QWidget
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.
[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.
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.
This function was introduced in Qt 5.9.
See also searchInput().
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.