The QHelpContentModel class provides a model that supplies content to views. More...
Header: | #include <QHelpContentModel> |
CMake: | find_package(Qt6 COMPONENTS Help REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Help) |
qmake: | QT += help |
Inherits: | QAbstractItemModel |
virtual | ~QHelpContentModel() override |
QHelpContentItem * | contentItemAt(const QModelIndex &index) const |
void | createContents(const QString &customFilterName) |
bool | isCreatingContents() const |
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 |
void | contentsCreated() |
void | contentsCreationStarted() |
[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.
Returns the help content item at the model index position index.
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.
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.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qhelpcontentmodel.html