QHelpSearchQueryWidget Class Reference
[QtHelp module]

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 = 0 )

Constructs a new search query widget with the given parent.

QHelpSearchQueryWidget::~QHelpSearchQueryWidget ()

Destroys the search query widget.

QList<QHelpSearchQuery> QHelpSearchQueryWidget::query () const

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

void QHelpSearchQueryWidget::search ()   [signal]

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