diff options
Diffstat (limited to 'src/scxml/qscxmldatamodel.cpp')
| -rw-r--r-- | src/scxml/qscxmldatamodel.cpp | 75 |
1 files changed, 72 insertions, 3 deletions
diff --git a/src/scxml/qscxmldatamodel.cpp b/src/scxml/qscxmldatamodel.cpp index 570289d..bf84ef8 100644 --- a/src/scxml/qscxmldatamodel.cpp +++ b/src/scxml/qscxmldatamodel.cpp @@ -45,14 +45,27 @@ QT_BEGIN_NAMESPACE /*! - * \class QScxmlDataModel::ForeachLoopBody - * \internal + \class QScxmlDataModel::ForeachLoopBody + \brief The ForeachLoopBody class represents a function to be executed on + each iteration of an SCXML foreach loop. + \since 5.8 + \inmodule QtScxml */ +/*! + Destroys a ForeachLoopBody + */ QScxmlDataModel::ForeachLoopBody::~ForeachLoopBody() {} /*! + \fn QScxmlDataModel::ForeachLoopBody::run(bool *ok) + + Function to be executed on each iteration. If the execution fails \a ok is + set to \c false, otherwise it is set to \c true. + */ + +/*! * \class QScxmlDataModel * \brief The QScxmlDataModel class is the data model base class for a Qt SCXML * state machine. @@ -89,7 +102,8 @@ QScxmlDataModel::QScxmlDataModel(QObject *parent) } /*! - * \internal + Creates a new QScxmlDataModel from a private object \a dd with parent + object \a parent. */ QScxmlDataModel::QScxmlDataModel(QScxmlDataModelPrivate &dd, QObject *parent) : QObject(dd, parent) @@ -184,4 +198,59 @@ QScxmlDataModel *QScxmlDataModelPrivate::instantiateDataModel(DocumentModel::Scx * Returns \c true if successful or \c false if an error occurred. */ +/*! + * \fn QScxmlDataModel::evaluateToString( + * QScxmlExecutableContent::EvaluatorId id, bool *ok) + * Evaluates the executable content pointed to by \a id, and sets \a ok to + * \c false if there was an error, or to \c true if there wasn't. + * Returns the result of the evaluation as a QString. + */ + +/*! + * \fn QScxmlDataModel::evaluateToBool(QScxmlExecutableContent::EvaluatorId id, + * bool *ok) + * Evaluates the executable content pointed to by \a id, and sets \a ok to + * \c false if there was an error, or to \c true if there wasn't. + * Returns the result of the evaluation as a bool. + */ + +/*! + * \fn QScxmlDataModel::evaluateToVariant( + * QScxmlExecutableContent::EvaluatorId id, bool *ok) + * Evaluates the executable content pointed to by \a id, and sets \a ok to + * \c false if there was an error, or to \c true if there wasn't. + * Returns the result of the evaluation as a QVariant. + */ + +/*! + * \fn QScxmlDataModel::evaluateToVoid(QScxmlExecutableContent::EvaluatorId id, + * bool *ok) + * Evaluates the executable content pointed to by \a id, and sets \a ok to + * \c false if there was an error, or to \c true if there wasn't. + * The execution is expected to return no result. + */ + +/*! + * \fn QScxmlDataModel::evaluateAssignment( + * QScxmlExecutableContent::EvaluatorId id, bool *ok) + * Evaluates the assignement pointed to by \a id, and sets \a ok to + * \c false if there was an error, or to \c true if there wasn't. + */ + +/*! + * \fn QScxmlDataModel::evaluateInitialization( + * QScxmlExecutableContent::EvaluatorId id, bool *ok) + * Evaluates the initialization pointed to by \a id, and sets \a ok to + * \c false if there was an error, or to \c true if there wasn't. + */ + +/*! + * \fn QScxmlDataModel::evaluateForeach( + * QScxmlExecutableContent::EvaluatorId id, bool *ok, + * ForeachLoopBody *body) + * Evaluates the foreach loop pointed to by \a id, and sets \a ok to + * \c false if there was an error, or to \c true if there wasn't. The + * \a body is executed on each iteration. + */ + QT_END_NAMESPACE |