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 |
This class was introduced in Qt 4.4.
Public Functions
QHelpSearchQueryWidget(QWidget *parent = nullptr) | |
virtual | ~QHelpSearchQueryWidget() override |
void | collapseExtendedSearch() |
void | expandExtendedSearch() |
QString | searchInput() const |
void | setSearchInput(const QString &searchInput) |
Signals
void | search() |
Related Non-Members
typedef | QObjectList |
QList<T> | qFindChildren(const QObject *obj, const QRegExp ®Exp) |
T | qobject_cast(QObject *object) |
T | qobject_cast(const QObject *object) |
Macros
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
QWIDGETSIZE_MAX | |
Q_CLASSINFO(Name, Value) | |
Q_DISABLE_COPY(Class) | |
Q_DISABLE_COPY_MOVE(Class) | |
Q_DISABLE_MOVE(Class) | |
Q_EMIT | |
Q_ENUM(...) | |
Q_ENUM_NS(...) | |
Q_FLAG(...) | |
Q_FLAG_NS(...) | |
Q_GADGET | |
Q_INTERFACES(...) | |
Q_INVOKABLE | |
Q_NAMESPACE | |
Q_OBJECT | |
Q_PROPERTY(...) | |
Q_REVISION | |
Q_SET_OBJECT_NAME(Object) | |
Q_SIGNAL | |
Q_SIGNALS | |
Q_SLOT | |
Q_SLOTS |
Additional Inherited Members
- 59 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
- 9 static public members inherited from QObject
- 35 protected functions inherited from QWidget
- 9 protected functions inherited from QObject
- 1 protected slot inherited from QWidget
Detailed Description
Member Function Documentation
QHelpSearchQueryWidget::QHelpSearchQueryWidget(QWidget *parent = nullptr)
Constructs a new search query widget with the given parent.
[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.
[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.
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().
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().