QHelpSearchQueryWidget Class▲
-
Header: QHelpSearchQueryWidget
-
CMake:
find_package(Qt6 REQUIRED COMPONENTS Help)
target_link_libraries(mytarget PRIVATE Qt6::Help)
-
qmake: QT += help
-
Inherits: QWidget
Detailed Description▲
Member Function Documentation▲
[explicit] 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.
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.
[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▲
See also setSearchInput()
[since 5.9] void QHelpSearchQueryWidget::setSearchInput(const QString &searchInput)▲
Sets the QHelpSearchQueryWidget input field to the value specified by searchInput.
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▲
See also searchInput()
Obsolete Members for QHelpSearchQueryWidget▲
The following members of class QHelpSearchQueryWidget are deprecated. We strongly advise against using them in new code.
Obsolete Member Function Documentation▲
QList<QHelpSearchQuery> QHelpSearchQueryWidget::query() const▲
This function is deprecated. We strongly advise against using it in new code.
Use searchInput() instead.
See Also▲
See also setQuery()
void QHelpSearchQueryWidget::setQuery(const QList<QHelpSearchQuery> &queryList)▲
This function is deprecated. We strongly advise against using it in new code.
Use setSearchInput() instead.
See Also▲
See also query()