Qt Reference Documentation
Search index:

Contents

QHelpIndexWidget Class Reference

The QHelpIndexWidget class provides a list view displaying the QHelpIndexModel. More...

 #include <QHelpIndexWidget>

Inherits QListView.

This class was introduced in Qt 4.4.

Public Slots

void activateCurrentItem ()
void filterIndices ( const QString & filter, const QString & wildcard = QString() )

Signals

void linkActivated ( const QUrl & link, const QString & keyword )
void linksActivated ( const QMap<QString, QUrl> & links, const QString & keyword )

Additional Inherited Members

Detailed Description

The QHelpIndexWidget class provides a list view displaying the QHelpIndexModel.

Member Function Documentation

void QHelpIndexWidget::activateCurrentItem () [slot]

Activates the current item which will result eventually in the emitting of a linkActivated() or linksActivated() signal.

void QHelpIndexWidget::filterIndices ( const QString & filter, const QString & wildcard = QString() ) [slot]

Filters the indices according to filter or wildcard. The item with the best match is set as current item.

See also QHelpIndexModel::filter().

void QHelpIndexWidget::linkActivated ( const QUrl & link, const QString & keyword ) [signal]

This signal is emitted when an item is activated and its associated link should be shown. To know where the link belongs to, the keyword is given as a second paremeter.

void QHelpIndexWidget::linksActivated ( const QMap<QString, QUrl> & links, const QString & keyword ) [signal]

This signal is emitted when the item representing the keyword is activated and the item has more than one link associated. The links consist of the document title and their URL.

© 2008-2010 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.

X

Thank you for giving your feedback.

Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.