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 |
This class was introduced in Qt 4.4.
Public Functions
virtual | ~QHelpContentModel() override |
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 override |
virtual QVariant | data(const QModelIndex &index, int role) const override |
virtual QModelIndex | index(int row, int column, const QModelIndex &parent = QModelIndex()) const override |
virtual QModelIndex | parent(const QModelIndex &index) const override |
virtual int | rowCount(const QModelIndex &parent = QModelIndex()) const override |
- 40 public functions inherited from QAbstractItemModel
- 30 public functions inherited from QObject
Signals
void | contentsCreated() |
void | contentsCreationStarted() |
- 18 signals inherited from QAbstractItemModel
- 2 signals inherited from QObject
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 | |
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
- 1 property inherited from QObject
- 2 public slots inherited from QAbstractItemModel
- 1 public slot inherited from QObject
- 9 static public members inherited from QObject
- 19 protected functions inherited from QAbstractItemModel
- 9 protected functions inherited from QObject
- 1 protected slot inherited from QAbstractItemModel
Detailed Description
Member Function Documentation
[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().
[override virtual]
QHelpContentModel::~QHelpContentModel()
Destroys the help content model.
[override virtual]
int QHelpContentModel::columnCount(const QModelIndex &parent = QModelIndex()) const
Reimplements: QAbstractItemModel::columnCount(const QModelIndex &parent) const.
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.
void QHelpContentModel::createContents(const QString &customFilterName)
Creates new contents by querying the help system for contents specified for the customFilterName.
[override virtual]
QVariant QHelpContentModel::data(const QModelIndex &index, int role) const
Reimplements: QAbstractItemModel::data(const QModelIndex &index, int role) const.
Returns the data stored under the given role for the item referred to by the index.
[override virtual]
QModelIndex QHelpContentModel::index(int row, int column, const QModelIndex &parent = QModelIndex()) const
Reimplements: QAbstractItemModel::index(int row, int column, const QModelIndex &parent) const.
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.
[override virtual]
QModelIndex QHelpContentModel::parent(const QModelIndex &index) const
Reimplements: QAbstractItemModel::parent(const QModelIndex &index) const.
Returns the parent of the model item with the given index, or QModelIndex() if it has no parent.
[override virtual]
int QHelpContentModel::rowCount(const QModelIndex &parent = QModelIndex()) const
Reimplements: QAbstractItemModel::rowCount(const QModelIndex &parent) const.
Returns the number of rows under the given parent.