summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSandro S. Andrade <sandroandrade@kde.org>2013-11-24 00:04:40 -0300
committerSandro S. Andrade <sandroandrade@kde.org>2013-11-24 04:01:27 +0100
commit7b0b553eefaea94f0599d74fbf499703a85fa09b (patch)
treea515a833931fadf3040b219e63bec1ab9c2df361
parentf2221017f76feddc0bcab60b977a3b87b162c253 (diff)
Fix QtModelingWidgets module documentation
Change-Id: I71dc23ed2f175bcc179576477da22c1d8930d7bd Reviewed-by: Sandro S. Andrade <sandroandrade@kde.org>
-rw-r--r--src/modelingwidgets/doc/qtmodelingwidgets.qdocconf12
-rw-r--r--src/modelingwidgets/doc/src/qtmodelingwidgets.qdoc16
-rw-r--r--src/modelingwidgets/internal/filterwidget_p.h4
-rw-r--r--src/modelingwidgets/internal/propertyeditor_p.h4
-rw-r--r--src/modelingwidgets/internal/propertyeditoritemdelegate_p.h4
-rw-r--r--src/modelingwidgets/qmodelingobjectmodel.cpp48
-rw-r--r--src/modelingwidgets/qmodelingobjectmodel.h4
-rw-r--r--src/modelingwidgets/qmodelingobjectmodel_p.h4
-rw-r--r--src/modelingwidgets/qmodelingobjectpropertyeditor.cpp21
-rw-r--r--src/modelingwidgets/qmodelingobjectpropertyeditor.h4
-rw-r--r--src/modelingwidgets/qmodelingobjectpropertyeditor_p.h4
-rw-r--r--src/modelingwidgets/qmodelingobjectpropertyfiltermodel.cpp15
-rw-r--r--src/modelingwidgets/qmodelingobjectpropertyfiltermodel.h4
-rw-r--r--src/modelingwidgets/qmodelingobjectpropertymodel.cpp52
-rw-r--r--src/modelingwidgets/qmodelingobjectpropertymodel.h4
-rw-r--r--src/modelingwidgets/qmodelingobjectpropertymodel_p.h4
-rw-r--r--src/modelingwidgets/qmodelingobjectview.cpp34
-rw-r--r--src/modelingwidgets/qmodelingobjectview.h4
-rw-r--r--src/modelingwidgets/qmodelingobjectview_p.h4
19 files changed, 186 insertions, 60 deletions
diff --git a/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf b/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf
index 0ecbda4b..77c1843a 100644
--- a/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf
+++ b/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf
@@ -1,7 +1,7 @@
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
project = QtModelingWidgets
-description = Qt ModelingWidgets Reference Documentation
+description = Qt Modeling Widgets Reference Documentation
url = http://qt-project.org/doc/qt-$QT_VER
version = $QT_VERSION
@@ -12,7 +12,7 @@ qhp.projects = QtModelingWidgets
qhp.QtModelingWidgets.file = qtmodelingwidgets.qhp
qhp.QtModelingWidgets.namespace = org.qt-project.qtmodelingwidgets.$QT_VERSION_TAG
qhp.QtModelingWidgets.virtualFolder = qtmodelingwidgets
-qhp.QtModelingWidgets.indexTitle = Qt ModelingWidgets
+qhp.QtModelingWidgets.indexTitle = Qt Modeling Widgets
qhp.QtModelingWidgets.indexRoot =
qhp.QtModelingWidgets.filterAttributes = qtmodelingwidgets $QT_VERSION qtrefdoc
@@ -21,12 +21,12 @@ qhp.QtModelingWidgets.customFilters.Qt.filterAttributes = qtmodelingwidgets $QT_
qhp.QtModelingWidgets.subprojects = classes
qhp.QtModelingWidgets.subprojects.classes.title = C++ Classes
-qhp.QtModelingWidgets.subprojects.classes.indexTitle = Qt ModelingWidgets C++ Classes
+qhp.QtModelingWidgets.subprojects.classes.indexTitle = Qt Modeling Widgets C++ Classes
qhp.QtModelingWidgets.subprojects.classes.selectors = class fake:headerfile
qhp.QtModelingWidgets.subprojects.classes.sortPages = true
tagfile = ../../../doc/qtmodelingwidgets/qtmodelingwidgets.tags
-depends += qtcore modeling qtdoc
+depends += qtcore qtdoc qtmodeling qtquick
headerdirs += ..
@@ -39,3 +39,7 @@ exampledirs += ../../../examples/modelingwidgets \
imagedirs += images \
../../../examples/modelingwidgets/doc/images
+
+
+navigation.landingpage = "Qt Modeling Widgets"
+navigation.cppclassespage = "Qt Modeling Widgets C++ Classes"
diff --git a/src/modelingwidgets/doc/src/qtmodelingwidgets.qdoc b/src/modelingwidgets/doc/src/qtmodelingwidgets.qdoc
index e7a1d71c..f2ccde75 100644
--- a/src/modelingwidgets/doc/src/qtmodelingwidgets.qdoc
+++ b/src/modelingwidgets/doc/src/qtmodelingwidgets.qdoc
@@ -26,17 +26,17 @@
****************************************************************************/
/*!
\page qtmodelingwidgets-index.html
- \title Qt ModelingWidgets
- \brief Provide model and widget classes for use with QtModelingWidgets module.
+ \title Qt Modeling Widgets
+ \brief Provide model and widget classes for use with QtModeling module.
- Qt ModelingWidgets is an add-on module which provides model and widget classes for use with QtModelingWidgets module.
+ Qt Modeling Widgets is an add-on module which provides model and widget classes for use with QtModeling module.
\section1 Getting Started
- To enable Qt ModelingWidgets in a project, add this directive into the C++ files:
+ To enable Qt Modeling Widgets in a project, add this directive into the C++ files:
\code
#include <QtModelingWidgets>
\endcode
- To link against the Qt ModelingWidgets module, add this line to the project file:
+ To link against the Qt Modeling Widgets module, add this line to the project file:
\code
QT += modelingwidgets
\endcode
@@ -44,15 +44,15 @@
\section1 Reference
These are links to the API reference materials.
\list
- \li \l{Qt ModelingWidgets Module C++ Classes}{C++ classes}
+ \li \l{Qt Modeling Widgets C++ Classes}{C++ classes}
\endlist
*/
/*!
\module QtModelingWidgets
- \title Qt ModelingWidgets Module C++ Classes
+ \title Qt Modeling Widgets C++ Classes
\ingroup modules
- \brief Provide model and widget classes for use with QtModelingWidgets module.
+ \brief Provide model and widget classes for use with QtModeling module.
To include the definitions of the module's classes, use the
following directive:
diff --git a/src/modelingwidgets/internal/filterwidget_p.h b/src/modelingwidgets/internal/filterwidget_p.h
index 21dfa4ed..62c96ed2 100644
--- a/src/modelingwidgets/internal/filterwidget_p.h
+++ b/src/modelingwidgets/internal/filterwidget_p.h
@@ -48,8 +48,6 @@
#define ICONBUTTON_SIZE 16
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtWrappedObjectsWidgets)
@@ -132,7 +130,5 @@ private:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // FILTERWIDGET_P_H
diff --git a/src/modelingwidgets/internal/propertyeditor_p.h b/src/modelingwidgets/internal/propertyeditor_p.h
index 66e19470..ae0d0c71 100644
--- a/src/modelingwidgets/internal/propertyeditor_p.h
+++ b/src/modelingwidgets/internal/propertyeditor_p.h
@@ -45,8 +45,6 @@
#include <QtWidgets/QAbstractItemDelegate>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtWrappedObjectsWidgets)
@@ -83,7 +81,5 @@ private:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // PROPERTYEDITOR_H
diff --git a/src/modelingwidgets/internal/propertyeditoritemdelegate_p.h b/src/modelingwidgets/internal/propertyeditoritemdelegate_p.h
index 72c813bb..131e65f9 100644
--- a/src/modelingwidgets/internal/propertyeditoritemdelegate_p.h
+++ b/src/modelingwidgets/internal/propertyeditoritemdelegate_p.h
@@ -45,8 +45,6 @@
#include <QtWidgets/QStyledItemDelegate>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtWrappedObjectsWidgets)
@@ -73,7 +71,5 @@ private:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // PROPERTYEDITORITEMDELEGATE_P_H
diff --git a/src/modelingwidgets/qmodelingobjectmodel.cpp b/src/modelingwidgets/qmodelingobjectmodel.cpp
index 310aebf7..5cf8a75f 100644
--- a/src/modelingwidgets/qmodelingobjectmodel.cpp
+++ b/src/modelingwidgets/qmodelingobjectmodel.cpp
@@ -51,15 +51,30 @@
QT_BEGIN_NAMESPACE
+/*!
+ \class QModelingObjectModel
+
+ \inmodule QtModelingWidgets
+
+ \brief The QModelingObjectModel class provides a Qt model for handling
+ with hierarchical model elements.
+*/
+
QModelingObjectModelPrivate::QModelingObjectModelPrivate()
{
}
+/*!
+ Creates a new QModelingObjectModel with the given \a parent.
+*/
QModelingObjectModel::QModelingObjectModel(QObject *parent) :
QAbstractItemModel(*new QModelingObjectModelPrivate, parent)
{
}
+/*!
+ Adjusts \a modelingObjects as the top level model elements which should be handled by this QModelingObjectModel.
+*/
void QModelingObjectModel::setModelingObjects(QList<QModelingObject *> modelingObjects)
{
Q_D(QModelingObjectModel);
@@ -69,6 +84,9 @@ void QModelingObjectModel::setModelingObjects(QList<QModelingObject *> modelingO
endResetModel();
}
+/*!
+ Returns the top level model elements handled by this QModelingObjectModel.
+*/
QList<QModelingObject *> QModelingObjectModel::modelingObjects() const
{
Q_D(const QModelingObjectModel);
@@ -76,6 +94,9 @@ QList<QModelingObject *> QModelingObjectModel::modelingObjects() const
return d->modelingObjects;
}
+/*!
+ Returns the QModelIndex which corresponds to the \a parent's child at position \a row, \a column.
+*/
QModelIndex QModelingObjectModel::index(int row, int column, const QModelIndex &parent) const
{
Q_D(const QModelingObjectModel);
@@ -93,6 +114,9 @@ QModelIndex QModelingObjectModel::index(int row, int column, const QModelIndex &
return createIndex(row, column, static_cast<void *>(modelingObject->children().at(row)));
}
+/*!
+ Returns the QModelIndex of the parent of index identified by \a child.
+*/
QModelIndex QModelingObjectModel::parent(const QModelIndex &child) const
{
Q_D(const QModelingObjectModel);
@@ -112,6 +136,9 @@ QModelIndex QModelingObjectModel::parent(const QModelIndex &child) const
return createIndex(grandParentModelingObject->children().indexOf(parentModelingObject), 0, static_cast<void *>(parentModelingObject));
}
+/*!
+ Returns the number of index rows having \a parent as parent.
+*/
int QModelingObjectModel::rowCount(const QModelIndex &parent) const
{
Q_D(const QModelingObjectModel);
@@ -129,6 +156,9 @@ int QModelingObjectModel::rowCount(const QModelIndex &parent) const
return modelingObject->children().size();
}
+/*!
+ Returns the number of index columns having \a parent as parent.
+*/
int QModelingObjectModel::columnCount(const QModelIndex &parent) const
{
Q_D(const QModelingObjectModel);
@@ -136,6 +166,9 @@ int QModelingObjectModel::columnCount(const QModelIndex &parent) const
return (d->modelingObjects.isEmpty() || (parent.isValid() && parent.column() != 0)) ? 0:2;
}
+/*!
+ Returns the data \a index contains in role \a role.
+*/
QVariant QModelingObjectModel::data(const QModelIndex &index, int role) const
{
Q_D(const QModelingObjectModel);
@@ -177,11 +210,17 @@ QVariant QModelingObjectModel::data(const QModelIndex &index, int role) const
return QVariant();
}
+/*!
+ Ajusts the \a index's data corresponding to role \a role to \a value.
+*/
bool QModelingObjectModel::setData(const QModelIndex &index, const QVariant &value, int role)
{
return QAbstractItemModel::setData(index, value, role);
}
+/*!
+ Returns the header data for section \a section and orientation \a orientation corresponding to role \a role.
+*/
QVariant QModelingObjectModel::headerData(int section, Qt::Orientation orientation, int role) const
{
if ((section == 0 || section == 1) && orientation == Qt::Horizontal && role == Qt::DisplayRole)
@@ -189,11 +228,17 @@ QVariant QModelingObjectModel::headerData(int section, Qt::Orientation orientati
return QVariant();
}
+/*!
+ Returns the flags of item corresponding to \a index.
+*/
Qt::ItemFlags QModelingObjectModel::flags(const QModelIndex &index) const
{
return QAbstractItemModel::flags(index);
}
+/*!
+ Notify views that \a index has been modified.
+*/
void QModelingObjectModel::updateIndex(const QModelIndex &index)
{
if (!index.isValid()) {
@@ -205,6 +250,9 @@ void QModelingObjectModel::updateIndex(const QModelIndex &index)
emit dataChanged(index, index, QVector<int>() << Qt::DisplayRole);
}
+/*!
+ Delete the model handled by this QModelingObjectModel.
+*/
void QModelingObjectModel::clear()
{
Q_D(QModelingObjectModel);
diff --git a/src/modelingwidgets/qmodelingobjectmodel.h b/src/modelingwidgets/qmodelingobjectmodel.h
index 67394028..e91de51d 100644
--- a/src/modelingwidgets/qmodelingobjectmodel.h
+++ b/src/modelingwidgets/qmodelingobjectmodel.h
@@ -45,8 +45,6 @@
#include <QtCore/QAbstractItemModel>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtModelingWidgets)
@@ -83,7 +81,5 @@ public Q_SLOTS:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QMODELINGOBJECTMODEL_H
diff --git a/src/modelingwidgets/qmodelingobjectmodel_p.h b/src/modelingwidgets/qmodelingobjectmodel_p.h
index dca90f13..bd1a172e 100644
--- a/src/modelingwidgets/qmodelingobjectmodel_p.h
+++ b/src/modelingwidgets/qmodelingobjectmodel_p.h
@@ -44,8 +44,6 @@
#include "qtmodelingwidgetsglobal.h"
#include "private/qabstractitemmodel_p.h"
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtModelingWidgets)
@@ -63,7 +61,5 @@ public:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QMODELINGOBJECTMODEL_P_H
diff --git a/src/modelingwidgets/qmodelingobjectpropertyeditor.cpp b/src/modelingwidgets/qmodelingobjectpropertyeditor.cpp
index 62725238..02c86dd9 100644
--- a/src/modelingwidgets/qmodelingobjectpropertyeditor.cpp
+++ b/src/modelingwidgets/qmodelingobjectpropertyeditor.cpp
@@ -53,6 +53,15 @@
QT_BEGIN_NAMESPACE
+/*!
+ \class QModelingObjectPropertyEditor
+
+ \inmodule QtModelingWidgets
+
+ \brief The QModelingObjectPropertyEditor class provides a Qt view for handling
+ model element's properties.
+*/
+
QModelingObjectPropertyEditorPrivate::QModelingObjectPropertyEditorPrivate() :
label(new QLabel),
treeView(new QTreeView),
@@ -67,6 +76,9 @@ QModelingObjectPropertyEditorPrivate::~QModelingObjectPropertyEditorPrivate()
delete proxyModel;
}
+/*!
+ Creates a new QModelingObjectPropertyEditor with the given \a parent and window flags \a f.
+*/
QModelingObjectPropertyEditor::QModelingObjectPropertyEditor(QWidget *parent, Qt::WindowFlags f) :
QWidget(*new QModelingObjectPropertyEditorPrivate, parent, f)
{
@@ -99,10 +111,16 @@ QModelingObjectPropertyEditor::QModelingObjectPropertyEditor(QWidget *parent, Qt
connect(d->filter, &FilterWidget::filterChanged, this, &QModelingObjectPropertyEditor::filterChanged);
}
+/*!
+ Destroys the QModelingObjectPropertyEditor.
+*/
QModelingObjectPropertyEditor::~QModelingObjectPropertyEditor()
{
}
+/*!
+ Adjusts \a propertyModel as the model handled by this QModelingObjectPropertyEditor.
+*/
void QModelingObjectPropertyEditor::setModel(QModelingObjectPropertyModel *propertyModel)
{
Q_D(QModelingObjectPropertyEditor);
@@ -117,6 +135,9 @@ void QModelingObjectPropertyEditor::setModel(QModelingObjectPropertyModel *prope
connect(propertyModel, &QAbstractItemModel::modelReset, this, &QModelingObjectPropertyEditor::modelReset);
}
+/*!
+ Returns the QModelingObjectPropertyModel handled by this QModelingObjectPropertyEditor.
+*/
QModelingObjectPropertyModel *QModelingObjectPropertyEditor::model() const
{
Q_D(const QModelingObjectPropertyEditor);
diff --git a/src/modelingwidgets/qmodelingobjectpropertyeditor.h b/src/modelingwidgets/qmodelingobjectpropertyeditor.h
index 01889e36..bed7e935 100644
--- a/src/modelingwidgets/qmodelingobjectpropertyeditor.h
+++ b/src/modelingwidgets/qmodelingobjectpropertyeditor.h
@@ -45,8 +45,6 @@
#include <QtWidgets/QWidget>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtModelingWidgets)
@@ -77,7 +75,5 @@ private Q_SLOTS:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QMODELINGOBJECTPROPERTYEDITOR_H
diff --git a/src/modelingwidgets/qmodelingobjectpropertyeditor_p.h b/src/modelingwidgets/qmodelingobjectpropertyeditor_p.h
index 47b47ae7..bed94169 100644
--- a/src/modelingwidgets/qmodelingobjectpropertyeditor_p.h
+++ b/src/modelingwidgets/qmodelingobjectpropertyeditor_p.h
@@ -44,8 +44,6 @@
#include "qtmodelingwidgetsglobal.h"
#include "private/qwidget_p.h"
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtModelingWidgets)
@@ -74,7 +72,5 @@ public:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QMODELINGOBJECTPROPERTYEDITOR_P_H
diff --git a/src/modelingwidgets/qmodelingobjectpropertyfiltermodel.cpp b/src/modelingwidgets/qmodelingobjectpropertyfiltermodel.cpp
index c7c63533..99ba1e28 100644
--- a/src/modelingwidgets/qmodelingobjectpropertyfiltermodel.cpp
+++ b/src/modelingwidgets/qmodelingobjectpropertyfiltermodel.cpp
@@ -42,11 +42,26 @@
QT_BEGIN_NAMESPACE
+/*!
+ \class QModelingObjectPropertyFilterModel
+
+ \inmodule QtModelingWidgets
+
+ \brief The QModelingObjectPropertyFilterModel class allows filtering properties
+ in a QModelingObjectPropertyEditor by name.
+*/
+
+/*!
+ Creates a new QModelingObjectPropertyFilterModel with the given \a parent.
+*/
QModelingObjectPropertyFilterModel::QModelingObjectPropertyFilterModel(QObject *parent) :
QSortFilterProxyModel(parent)
{
}
+/*!
+ Implements the filtering mechanism, deciding if element at \a sourceRow identified by \a sourceParent should be exhibited.
+*/
bool QModelingObjectPropertyFilterModel::filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const
{
int rows;
diff --git a/src/modelingwidgets/qmodelingobjectpropertyfiltermodel.h b/src/modelingwidgets/qmodelingobjectpropertyfiltermodel.h
index 855c3124..5469a175 100644
--- a/src/modelingwidgets/qmodelingobjectpropertyfiltermodel.h
+++ b/src/modelingwidgets/qmodelingobjectpropertyfiltermodel.h
@@ -45,8 +45,6 @@
#include <QtCore/QSortFilterProxyModel>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtModelingWidgets)
@@ -63,7 +61,5 @@ protected:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QMODELINGOBJECTPROPERTYFILTERMODEL_H
diff --git a/src/modelingwidgets/qmodelingobjectpropertymodel.cpp b/src/modelingwidgets/qmodelingobjectpropertymodel.cpp
index 6906b77e..2ba655f5 100644
--- a/src/modelingwidgets/qmodelingobjectpropertymodel.cpp
+++ b/src/modelingwidgets/qmodelingobjectpropertymodel.cpp
@@ -51,20 +51,39 @@
QT_BEGIN_NAMESPACE
+/*!
+ \class QModelingObjectPropertyModel
+
+ \inmodule QtModelingWidgets
+
+ \brief The QModelingObjectPropertyModel class provides a Qt model for
+ handling QtModeling element's properties.
+*/
+
QModelingObjectPropertyModelPrivate::QModelingObjectPropertyModelPrivate() :
modelingObject(0), modelingMetaObject(0)
{
}
+/*!
+ Creates a new QModelingObjectPropertyModel with the given \a parent.
+*/
QModelingObjectPropertyModel::QModelingObjectPropertyModel(QObject *parent) :
QAbstractItemModel(*new QModelingObjectPropertyModelPrivate, parent)
{
}
+/*!
+ Destroys the QModelingObjectPropertyModel;
+*/
QModelingObjectPropertyModel::~QModelingObjectPropertyModel()
{
}
+/*!
+ Adjusts \a modelingObject as the element whose properties should be handled by this QModelingObjectPropertyModel.
+ \a index represents the index \a modelingObject plays in the corresponding QModelingObjectModel.
+*/
void QModelingObjectPropertyModel::setModelingObject(QModelingObject *modelingObject, QModelIndex index)
{
Q_D(QModelingObjectPropertyModel);
@@ -80,6 +99,9 @@ void QModelingObjectPropertyModel::setModelingObject(QModelingObject *modelingOb
}
}
+/*!
+ Returns the QModelIndex which corresponds to the \a parent's child at position \a row, \a column.
+*/
QModelIndex QModelingObjectPropertyModel::index(int row, int column, const QModelIndex &parent) const
{
Q_D(const QModelingObjectPropertyModel);
@@ -92,6 +114,9 @@ QModelIndex QModelingObjectPropertyModel::index(int row, int column, const QMode
return createIndex(row, column);
}
+/*!
+ Returns the QModelIndex of the parent of index identified by \a child.
+*/
QModelIndex QModelingObjectPropertyModel::parent(const QModelIndex &child) const
{
Q_D(const QModelingObjectPropertyModel);
@@ -106,6 +131,9 @@ QModelIndex QModelingObjectPropertyModel::parent(const QModelIndex &child) const
return createIndex(d->modelingObject->propertyGroupIndex(*metaProperty), 0);
}
+/*!
+ Returns the number of index rows having \a parent as parent.
+*/
int QModelingObjectPropertyModel::rowCount(const QModelIndex &parent) const
{
Q_D(const QModelingObjectPropertyModel);
@@ -116,6 +144,9 @@ int QModelingObjectPropertyModel::rowCount(const QModelIndex &parent) const
(!parent.internalPointer()) ? d->groupProperties->values(d->propertyGroups->at(parent.row())).count():0;
}
+/*!
+ Returns the number of index columns having \a parent as parent.
+*/
int QModelingObjectPropertyModel::columnCount(const QModelIndex &parent) const
{
Q_D(const QModelingObjectPropertyModel);
@@ -123,6 +154,9 @@ int QModelingObjectPropertyModel::columnCount(const QModelIndex &parent) const
return (!d->modelingMetaObject || (parent.isValid() && parent.column() != 0)) ? 0:2;
}
+/*!
+ Returns the data \a index contains in role \a role.
+*/
QVariant QModelingObjectPropertyModel::data(const QModelIndex &index, int role) const
{
Q_D(const QModelingObjectPropertyModel);
@@ -305,6 +339,9 @@ QVariant QModelingObjectPropertyModel::data(const QModelIndex &index, int role)
return QVariant();
}
+/*!
+ Ajusts the \a index's data corresponding to role \a role to \a value.
+*/
bool QModelingObjectPropertyModel::setData(const QModelIndex &index, const QVariant &value, int role)
{
Q_D(QModelingObjectPropertyModel);
@@ -330,6 +367,9 @@ bool QModelingObjectPropertyModel::setData(const QModelIndex &index, const QVari
return false;
}
+/*!
+ Returns the header data for section \a section and orientation \a orientation corresponding to role \a role.
+*/
QVariant QModelingObjectPropertyModel::headerData(int section, Qt::Orientation orientation, int role) const
{
if ((section == 0 || section == 1) && orientation == Qt::Horizontal && role == Qt::DisplayRole)
@@ -337,6 +377,9 @@ QVariant QModelingObjectPropertyModel::headerData(int section, Qt::Orientation o
return QVariant();
}
+/*!
+ Returns the flags of item corresponding to \a index.
+*/
Qt::ItemFlags QModelingObjectPropertyModel::flags(const QModelIndex &index) const
{
QMetaProperty *metaProperty = static_cast<QMetaProperty *>(index.internalPointer());
@@ -346,6 +389,9 @@ Qt::ItemFlags QModelingObjectPropertyModel::flags(const QModelIndex &index) cons
return QAbstractItemModel::flags(index);
}
+/*!
+ Returns the QModelingObject whose properties are being handled by this QModelingObjectPropertyModel.
+*/
QModelingObject *QModelingObjectPropertyModel::modelingObject() const
{
Q_D(const QModelingObjectPropertyModel);
@@ -353,5 +399,11 @@ QModelingObject *QModelingObjectPropertyModel::modelingObject() const
return d->modelingObject;
}
+/*!
+ \fn void QModelingObjectPropertyModel::indexChanged(const QModelIndex &modelingObjectIndex)
+
+ This signal is emitted whenever the property represented by \a modelingObjectIndex has been changed.
+*/
+
QT_END_NAMESPACE
diff --git a/src/modelingwidgets/qmodelingobjectpropertymodel.h b/src/modelingwidgets/qmodelingobjectpropertymodel.h
index 78a696f7..8cec3f53 100644
--- a/src/modelingwidgets/qmodelingobjectpropertymodel.h
+++ b/src/modelingwidgets/qmodelingobjectpropertymodel.h
@@ -45,8 +45,6 @@
#include <QtCore/QAbstractItemModel>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtModelingWidgets)
@@ -85,7 +83,5 @@ Q_SIGNALS:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QMODELINGOBJECTPROPERTYMODEL_H
diff --git a/src/modelingwidgets/qmodelingobjectpropertymodel_p.h b/src/modelingwidgets/qmodelingobjectpropertymodel_p.h
index 459fc9da..03e4ca7d 100644
--- a/src/modelingwidgets/qmodelingobjectpropertymodel_p.h
+++ b/src/modelingwidgets/qmodelingobjectpropertymodel_p.h
@@ -44,8 +44,6 @@
#include "qtmodelingwidgetsglobal.h"
#include "private/qabstractitemmodel_p.h"
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtModelingWidgets)
@@ -69,7 +67,5 @@ public:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QMODELINGOBJECTPROPERTYMODEL_P_H
diff --git a/src/modelingwidgets/qmodelingobjectview.cpp b/src/modelingwidgets/qmodelingobjectview.cpp
index f9cce45b..4f0231b5 100644
--- a/src/modelingwidgets/qmodelingobjectview.cpp
+++ b/src/modelingwidgets/qmodelingobjectview.cpp
@@ -51,6 +51,15 @@
QT_BEGIN_NAMESPACE
+/*!
+ \class QModelingObjectView
+
+ \inmodule QtModelingWidgets
+
+ \brief The QModelingObjectView class provides a Qt view for
+ handling hierarchical QtModeling elements.
+*/
+
QModelingObjectViewPrivate::QModelingObjectViewPrivate() :
treeView(new QTreeView)
{
@@ -103,6 +112,9 @@ void QModelingObjectViewPrivate::populateContextMenu(QMenu &menu, QObject *eleme
menu.addAction(action);
}
+/*!
+ Creates a new QModelingObjectView with the given \a parent and window flags \a f.
+*/
QModelingObjectView::QModelingObjectView(QWidget *parent, Qt::WindowFlags f) :
QWidget(*new QModelingObjectViewPrivate, parent, f)
{
@@ -124,6 +136,9 @@ QModelingObjectView::QModelingObjectView(QWidget *parent, Qt::WindowFlags f) :
layout->addWidget(d->treeView);
}
+/*!
+ Adjusts \a model as the QModelingObjectModel exhibited by this QModelingObjectView.
+*/
void QModelingObjectView::setModel(QAbstractItemModel *model)
{
Q_D(QModelingObjectView);
@@ -140,6 +155,9 @@ void QModelingObjectView::setModel(QAbstractItemModel *model)
}
}
+/*!
+ Updates data about the currently selected (sub-)element.
+*/
void QModelingObjectView::updateSelected()
{
Q_D(QModelingObjectView);
@@ -151,6 +169,9 @@ void QModelingObjectView::updateSelected()
d->treeView->setCurrentIndex(index);
}
+/*!
+ Handles the occurrence of \a event.
+*/
void QModelingObjectView::contextMenuEvent(QContextMenuEvent *event)
{
Q_D(QModelingObjectView);
@@ -162,6 +183,19 @@ void QModelingObjectView::contextMenuEvent(QContextMenuEvent *event)
menu.exec(event->globalPos());
}
+/*!
+ \fn void QModelingObjectView::modelingObjectChanged(QModelingObject *selectedModelingObject, QModelIndex index = QModelIndex())
+
+ This signal is emitted whenever the \a selectedModelingObject's data represented by \a index has been changed.
+*/
+
+/*!
+ \fn void QModelingObjectView::addToView(QObject *selectedModelingObject, QQuickItem *parent = 0)
+
+ This signal is emitted whenever the action "Add to view" has been requested for the sub-element \a selectedModelingObject.
+ \a parent, if provided, represents the parent QQuickItem the new element should be drawn into.
+*/
+
void QModelingObjectView::handleAddMethod()
{
Q_D(QModelingObjectView);
diff --git a/src/modelingwidgets/qmodelingobjectview.h b/src/modelingwidgets/qmodelingobjectview.h
index 14778dd3..48eca501 100644
--- a/src/modelingwidgets/qmodelingobjectview.h
+++ b/src/modelingwidgets/qmodelingobjectview.h
@@ -47,8 +47,6 @@
#include <QtCore/QModelIndex>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtModelingWidgets)
@@ -92,7 +90,5 @@ private Q_SLOTS:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QMODELINGOBJECTVIEW_H
diff --git a/src/modelingwidgets/qmodelingobjectview_p.h b/src/modelingwidgets/qmodelingobjectview_p.h
index 287cca61..bd000e88 100644
--- a/src/modelingwidgets/qmodelingobjectview_p.h
+++ b/src/modelingwidgets/qmodelingobjectview_p.h
@@ -44,8 +44,6 @@
#include "qtmodelingwidgetsglobal.h"
#include "private/qwidget_p.h"
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtModelingWidgets)
@@ -67,7 +65,5 @@ public:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QMODELINGOBJECTVIEW_P_H