QHelpContentModel Class
The QHelpContentModel class provides a model that supplies content to views. More...
| Header: | #include <QHelpContentModel> |
| qmake: | QT += help |
| Since: | Qt 4.4 |
| Inherits: | QAbstractItemModel |
Public Functions
| ~QHelpContentModel() | |
| QHelpContentItem * | contentItemAt(const QModelIndex &index) const |
| void | createContents(const QString &customFilterName) |
| bool | isCreatingContents() const |
Reimplemented Public Functions
| virtual int | columnCount(const QModelIndex &parent = QModelIndex()) const |
| virtual QVariant | data(const QModelIndex &index, int role) const |
| virtual QModelIndex | index(int row, int column, const QModelIndex &parent = QModelIndex()) const |
| virtual QModelIndex | parent(const QModelIndex &index) const |
| virtual int | rowCount(const QModelIndex &parent = QModelIndex()) const |
- 39 public functions inherited from QAbstractItemModel
- 31 public functions inherited from QObject
Signals
| void | contentsCreated() |
| void | contentsCreationStarted() |
- 18 signals inherited from QAbstractItemModel
- 2 signals inherited from QObject
Additional Inherited Members
- 1 property inherited from QObject
- 2 public slots inherited from QAbstractItemModel
- 1 public slot inherited from QObject
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 19 protected functions inherited from QAbstractItemModel
- 9 protected functions inherited from QObject
- 1 protected slot inherited from QAbstractItemModel
- 2 protected variables inherited from QObject
Detailed Description
The QHelpContentModel class provides a model that supplies content to views.
Member Function Documentation
QHelpContentModel::~QHelpContentModel()
Destroys the help content model.
[virtual] int QHelpContentModel::columnCount(const QModelIndex &parent = QModelIndex()) const
Reimplemented from QAbstractItemModel::columnCount().
Returns the number of columns under the given parent. Currently returns always 1.
QHelpContentItem *QHelpContentModel::contentItemAt(const QModelIndex &index) const
Returns the help content item at the model index position index.
[signal] void QHelpContentModel::contentsCreated()
This signal is emitted when the contents have been created.
[signal] void QHelpContentModel::contentsCreationStarted()
This signal is emitted when the creation of the contents has started. The current contents are invalid from this point on until the signal contentsCreated() is emitted.
See also isCreatingContents().
void QHelpContentModel::createContents(const QString &customFilterName)
Creates new contents by querying the help system for contents specified for the customFilterName.
[virtual] QVariant QHelpContentModel::data(const QModelIndex &index, int role) const
Reimplemented from QAbstractItemModel::data().
Returns the data stored under the given role for the item referred to by the index.
[virtual] QModelIndex QHelpContentModel::index(int row, int column, const QModelIndex &parent = QModelIndex()) const
Reimplemented from QAbstractItemModel::index().
Returns the index of the item in the model specified by the given row, column and parent index.
bool QHelpContentModel::isCreatingContents() const
Returns true if the contents are currently rebuilt, otherwise false.
[virtual] QModelIndex QHelpContentModel::parent(const QModelIndex &index) const
Reimplemented from QAbstractItemModel::parent().
Returns the parent of the model item with the given index, or QModelIndex() if it has no parent.
[virtual] int QHelpContentModel::rowCount(const QModelIndex &parent = QModelIndex()) const
Reimplemented from QAbstractItemModel::rowCount().
Returns the number of rows under the given parent.