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 = Q_NULLPTR)
void collapseExtendedSearch()
void expandExtendedSearch()
bool isCompactMode() const
QList<QHelpSearchQuery> query() const
void setQuery(const QList<QHelpSearchQuery> &queryList)
  • 211 public functions inherited from QWidget
  • 31 public functions inherited from QObject
  • 14 public functions inherited from QPaintDevice


void search()

Additional Inherited Members

  • 58 properties inherited from QWidget
  • 1 property inherited from QObject
  • 19 public slots inherited from QWidget
  • 1 public slot inherited from QObject
  • 5 static public members inherited from QWidget
  • 11 static public members inherited from QObject
  • 35 protected functions inherited from QWidget
  • 9 protected functions inherited from QObject
  • 1 protected function inherited from QPaintDevice
  • 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 = Q_NULLPTR)

Constructs a new search query widget with the given parent.


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

QList<QHelpSearchQuery> QHelpSearchQueryWidget::query() const

Returns a list of queries to use in combination with the search engines search(QList<QHelpSearchQuery> &queryList) function.

See also setQuery().

This signal is emitted when a the user has the search button invoked. After receiving the signal you can ask the QHelpSearchQueryWidget for the build list of QHelpSearchQuery's that you may pass to the QHelpSearchEngine's search() function.

void QHelpSearchQueryWidget::setQuery(const QList<QHelpSearchQuery> &queryList)

Sets the QHelpSearchQueryWidget input fields to the values specified by queryList search field name. Please note that one has to call the search engine's search(QList<QHelpSearchQuery> &queryList) function to perform the actual search.

See also query().

© 2017 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.