QHelpIndexModel Class
The QHelpIndexModel class provides a model that supplies index keywords to views. More...
#include <QHelpIndexModel> Inherits: QStringListModel.
This class was introduced in Qt 4.4.
Public Functions
| | QAbstractItemModel(QObject * parent = 0) |
| virtual | ~QAbstractItemModel() |
| virtual QModelIndex | buddy(const QModelIndex & index) const |
| virtual bool | canDropMimeData(const QMimeData * data, Qt::DropAction action, int row, int column, const QModelIndex & parent) const |
| virtual bool | canFetchMore(const QModelIndex & parent) const |
| virtual int | columnCount(const QModelIndex & parent = QModelIndex()) const = 0 |
| void | createIndex(const QString & customFilterName) |
| virtual QVariant | data(const QModelIndex & index, int role = Qt::DisplayRole) const = 0 |
| virtual bool | dropMimeData(const QMimeData * data, Qt::DropAction action, int row, int column, const QModelIndex & parent) |
| virtual void | fetchMore(const QModelIndex & parent) |
| QModelIndex | filter(const QString & filter, const QString & wildcard = QString()) |
| virtual Qt::ItemFlags | flags(const QModelIndex & index) const |
| virtual bool | hasChildren(const QModelIndex & parent = QModelIndex()) const |
| bool | hasIndex(int row, int column, const QModelIndex & parent = QModelIndex()) const |
| virtual QVariant | headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const |
| virtual QModelIndex | index(int row, int column, const QModelIndex & parent = QModelIndex()) const = 0 |
| bool | insertColumn(int column, const QModelIndex & parent = QModelIndex()) |
| virtual bool | insertColumns(int column, int count, const QModelIndex & parent = QModelIndex()) |
| bool | insertRow(int row, const QModelIndex & parent = QModelIndex()) |
| virtual bool | insertRows(int row, int count, const QModelIndex & parent = QModelIndex()) |
| bool | isCreatingIndex() const |
| virtual QMap<int, QVariant> | itemData(const QModelIndex & index) const |
| QMap<QString, QUrl> | linksForKeyword(const QString & keyword) const |
| virtual QModelIndexList | match(const QModelIndex & start, int role, const QVariant & value, int hits = 1, Qt::MatchFlags flags = Qt::MatchFlags( Qt::MatchStartsWith | Qt::MatchWrap )) const |
| virtual QMimeData * | mimeData(const QModelIndexList & indexes) const |
| virtual QStringList | mimeTypes() const |
| bool | moveColumn(const QModelIndex & sourceParent, int sourceColumn, const QModelIndex & destinationParent, int destinationChild) |
| virtual bool | moveColumns(const QModelIndex & sourceParent, int sourceColumn, int count, const QModelIndex & destinationParent, int destinationChild) |
| bool | moveRow(const QModelIndex & sourceParent, int sourceRow, const QModelIndex & destinationParent, int destinationChild) |
| virtual bool | moveRows(const QModelIndex & sourceParent, int sourceRow, int count, const QModelIndex & destinationParent, int destinationChild) |
| virtual QModelIndex | parent(const QModelIndex & index) const = 0 |
| bool | removeColumn(int column, const QModelIndex & parent = QModelIndex()) |
| virtual bool | removeColumns(int column, int count, const QModelIndex & parent = QModelIndex()) |
| bool | removeRow(int row, const QModelIndex & parent = QModelIndex()) |
| virtual bool | removeRows(int row, int count, const QModelIndex & parent = QModelIndex()) |
| virtual QHash<int, QByteArray> | roleNames() const |
| virtual int | rowCount(const QModelIndex & parent = QModelIndex()) const = 0 |
| virtual bool | setData(const QModelIndex & index, const QVariant & value, int role = Qt::EditRole) |
| virtual bool | setHeaderData(int section, Qt::Orientation orientation, const QVariant & value, int role = Qt::EditRole) |
| virtual bool | setItemData(const QModelIndex & index, const QMap<int, QVariant> & roles) |
| QModelIndex | sibling(int row, int column, const QModelIndex & index) const |
| virtual void | sort(int column, Qt::SortOrder order = Qt::AscendingOrder) |
| virtual QSize | span(const QModelIndex & index) const |
| virtual Qt::DropActions | supportedDragActions() const |
| virtual Qt::DropActions | supportedDropActions() const |
Public Slots
- 1 public slot inherited from QObject
Signals
| void | columnsAboutToBeInserted(const QModelIndex & parent, int start, int end) |
| void | columnsAboutToBeMoved(const QModelIndex & sourceParent, int sourceStart, int sourceEnd, const QModelIndex & destinationParent, int destinationColumn) |
| void | columnsAboutToBeRemoved(const QModelIndex & parent, int start, int end) |
| void | columnsInserted(const QModelIndex & parent, int start, int end) |
| void | columnsMoved(const QModelIndex & sourceParent, int sourceStart, int sourceEnd, const QModelIndex & destinationParent, int destinationColumn) |
| void | columnsRemoved(const QModelIndex & parent, int start, int end) |
| void | dataChanged(const QModelIndex & topLeft, const QModelIndex & bottomRight, const QSet<int> & roles = QSet<int> ()) |
| void | headerDataChanged(Qt::Orientation orientation, int first, int last) |
| void | indexCreated() |
| void | indexCreationStarted() |
| void | layoutAboutToBeChanged(const QList<QPersistentModelIndex> & parents = QList<QPersistentModelIndex> ()) |
| void | layoutChanged(const QList<QPersistentModelIndex> & parents = QList<QPersistentModelIndex> ()) |
| void | modelAboutToBeReset() |
| void | modelReset() |
| void | rowsAboutToBeInserted(const QModelIndex & parent, int start, int end) |
| void | rowsAboutToBeMoved(const QModelIndex & sourceParent, int sourceStart, int sourceEnd, const QModelIndex & destinationParent, int destinationRow) |
| void | rowsAboutToBeRemoved(const QModelIndex & parent, int start, int end) |
| void | rowsInserted(const QModelIndex & parent, int start, int end) |
| void | rowsMoved(const QModelIndex & sourceParent, int sourceStart, int sourceEnd, const QModelIndex & destinationParent, int destinationRow) |
| void | rowsRemoved(const QModelIndex & parent, int start, int end) |
Protected Functions
| void | beginInsertColumns(const QModelIndex & parent, int first, int last) |
| void | beginInsertRows(const QModelIndex & parent, int first, int last) |
| bool | beginMoveColumns(const QModelIndex & sourceParent, int sourceFirst, int sourceLast, const QModelIndex & destinationParent, int destinationChild) |
| bool | beginMoveRows(const QModelIndex & sourceParent, int sourceFirst, int sourceLast, const QModelIndex & destinationParent, int destinationChild) |
| void | beginRemoveColumns(const QModelIndex & parent, int first, int last) |
| void | beginRemoveRows(const QModelIndex & parent, int first, int last) |
| void | beginResetModel() |
| void | changePersistentIndex(const QModelIndex & from, const QModelIndex & to) |
| void | changePersistentIndexList(const QModelIndexList & from, const QModelIndexList & to) |
| QModelIndex | createIndex(int row, int column, void * ptr = 0) const |
| QModelIndex | createIndex(int row, int column, quint32 id) const |
| void | endInsertColumns() |
| void | endInsertRows() |
| void | endMoveColumns() |
| void | endMoveRows() |
| void | endRemoveColumns() |
| void | endRemoveRows() |
| void | endResetModel() |
| QModelIndexList | persistentIndexList() const |
- 9 protected functions inherited from QObject
Additional Inherited Members
- 1 property inherited from QObject
- 11 static public members inherited from QObject
Detailed Description
The QHelpIndexModel class provides a model that supplies index keywords to views.
Member Function Documentation
void QHelpIndexModel::createIndex(const QString & customFilterName)
Creates a new index by querying the help system for keywords for the specified customFilterName.
QModelIndex QHelpIndexModel::filter(const QString & filter, const QString & wildcard = QString())
Filters the indices and returns the model index of the best matching keyword. In a first step, only the keywords containing filter are kept in the model's index list. Analogously, if wildcard is not empty, only the keywords matched are left in the index list. In a second step, the best match is determined and its index model returned. When specifying a wildcard expression, the filter string is used to search for the best match.
void QHelpIndexModel::indexCreated() [signal]
This signal is emitted when the index has been created.
void QHelpIndexModel::indexCreationStarted() [signal]
This signal is emitted when the creation of a new index has started. The current index is invalid from this point on until the signal indexCreated() is emitted.
See also isCreatingIndex().
bool QHelpIndexModel::isCreatingIndex() const
Returns true if the index is currently built up, otherwise false.
QMap<QString, QUrl> QHelpIndexModel::linksForKeyword(const QString & keyword) const
Returns all hits found for the keyword. A hit consists of the URL and the document title.
|
