QScxmlEvent Class
La classe QScxmlEvent est un événement pour une machine à états Qt SCXML. Plus...
| En-tête : | #include <QScxmlEvent> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Scxml)target_link_libraries(mytarget PRIVATE Qt6::Scxml) |
| qmake : | QT += scxml |
Types publics
| enum | EventType { PlatformEvent, InternalEvent, ExternalEvent } |
Propriétés
|
|
Fonctions publiques
| QScxmlEvent() | |
| QScxmlEvent(const QScxmlEvent &other) | |
| ~QScxmlEvent() | |
| void | clear() |
| QVariant | data() const |
| int | delay() const |
| QString | errorMessage() const |
| QScxmlEvent::EventType | eventType() const |
| QString | invokeId() const |
| bool | isErrorEvent() const |
| QString | name() const |
| QString | origin() const |
| QString | originType() const |
| QString | scxmlType() const |
| QString | sendId() const |
| void | setData(const QVariant &data) |
| void | setDelay(int delayInMiliSecs) |
| void | setErrorMessage(const QString &message) |
| void | setEventType(const QScxmlEvent::EventType &type) |
| void | setInvokeId(const QString &invokeid) |
| void | setName(const QString &name) |
| void | setOrigin(const QString &origin) |
| void | setOriginType(const QString &origintype) |
| void | setSendId(const QString &sendid) |
| QScxmlEvent & | operator=(const QScxmlEvent &other) |
Description détaillée
Les événements SCXML déclenchent des transitions. La plupart des événements sont générés par l'utilisation des éléments <raise> et <send> dans l'application. La machine d'état génère automatiquement certains événements obligatoires, tels que les erreurs.
Pour plus d'informations, voir Spécification SCXML - 5.10.1 La structure interne des événements. Pour plus d'informations sur les différences entre l'API Qt SCXML et la spécification, voir Conformité SCXML.
Voir également QScxmlStateMachine.
Documentation sur les types de membres
enum QScxmlEvent::EventType
Ce type d'énumération spécifie le type d'un événement SCXML :
| Constante | Valeur | Description de l'événement |
|---|---|---|
QScxmlEvent::PlatformEvent | 0 | Un événement généré en interne par la machine d'état. Par exemple, les erreurs. |
QScxmlEvent::InternalEvent | 1 | Un événement généré par un élément <raise>. |
QScxmlEvent::ExternalEvent | 2 | Un événement généré par un élément <send>. |
Propriété Documentation
data : QVariant
Cette propriété contient les données incluses par l'expéditeur.
Lorsque des éléments <param> sont utilisés dans l'élément <send>, les données contiennent un élément QVariantMap dont la clé est l'attribut name et la valeur est tirée de l'attribut expr ou de l'attribut location.
Lorsqu'un élément <content> est utilisé, les données contiennent un seul élément avec la valeur de l'attribut expr de l'élément <content> ou les données de l'enfant de l'élément <content>.
Fonctions d'accès :
delay : int
Cette propriété indique le délai en millisecondes après lequel l'événement doit être délivré après le traitement de l'élément <send>.
Fonctions d'accès :
[read-only] errorEvent : bool
Cette propriété indique si l'événement représente une erreur.
Fonctions d'accès :
| bool | isErrorEvent() const |
errorMessage : QString
Cette propriété contient un message d'erreur pour un événement d'erreur, ou un message vide QString.
Fonctions d'accès :
| QString | errorMessage() const |
| void | setErrorMessage(const QString &message) |
eventType : EventType
Cette propriété contient le type d'événement.
Fonctions d'accès :
| QScxmlEvent::EventType | eventType() const |
| void | setEventType(const QScxmlEvent::EventType &type) |
invokeId : QString
Cette propriété contient l'ID de la machine d'état invoquée si l'événement est généré par l'une d'entre elles.
Fonctions d'accès :
| QString | invokeId() const |
| void | setInvokeId(const QString &invokeid) |
name : QString
Cette propriété contient le nom de l'événement.
Si l'événement est généré dans le document SCXML, cette propriété contient la valeur de l'attribut event spécifié dans l'élément <raise> ou <send>.
Si l'événement est créé dans le code C++ et soumis à QScxmlStateMachine, la valeur de cette propriété est comparée à la valeur de l'attribut event spécifié dans l'élément <transition> du document SCXML.
Fonctions d'accès :
origin : QString
Cette propriété contient l'URI qui pointe vers l'origine d'un événement SCXML.
L'origine est équivalente à l'attribut target de l'élément <send>.
Fonctions d'accès :
originType : QString
Cette propriété contient le type d'origine d'un événement SCXML.
Le type d'origine est équivalent à l'attribut type de l'élément <send>.
Fonctions d'accès :
| QString | originType() const |
| void | setOriginType(const QString &origintype) |
[read-only] scxmlType : QString
Cette propriété contient le type d'événement.
Fonctions d'accès :
| QString | scxmlType() const |
sendId : QString
Cette propriété contient l'identifiant de l'événement.
L'ID est utilisé par l'élément <cancel> pour identifier l'événement à annuler.
Note : La machine d'état génère un identifiant unique si l'attribut id n'est pas spécifié dans l'élément <send>. Cette propriété permet d'accéder à l'identifiant généré.
Fonctions d'accès :
Documentation des fonctions membres
QScxmlEvent::QScxmlEvent()
Crée un nouvel événement SCXML externe.
QScxmlEvent::QScxmlEvent(const QScxmlEvent &other)
Construit une copie de other.
[noexcept] QScxmlEvent::~QScxmlEvent()
Détruit l'événement SCXML.
[invokable] void QScxmlEvent::clear()
Efface le contenu de l'événement.
Remarque : cette fonction peut être invoquée via le système de méta-objets et à partir de QML. Voir Q_INVOKABLE.
QVariant QScxmlEvent::data() const
Renvoie les données incluses par l'expéditeur.
Remarque : fonction Getter pour les données relatives aux propriétés.
Voir aussi setData().
int QScxmlEvent::delay() const
Renvoie le délai en millisecondes après lequel cet événement doit être délivré après le traitement de l'élément <send>.
Note : fonction Getter pour la propriété delay.
Voir aussi setDelay().
QString QScxmlEvent::errorMessage() const
S'il s'agit d'un événement d'erreur, il renvoie le message d'erreur. Dans le cas contraire, la fonction renvoie un message vide QString.
Remarque : fonction Getter pour la propriété errorMessage.
Voir également setErrorMessage().
QScxmlEvent::EventType QScxmlEvent::eventType() const
Renvoie le type de cet événement.
Remarque : fonction Getter pour la propriété eventType.
Voir aussi setEventType() et QScxmlEvent::EventType.
QString QScxmlEvent::invokeId() const
Si cet événement est généré par une machine d'état invoquée, renvoie l'ID de l'élément <invoke>. Sinon, il renvoie une valeur vide.
Remarque : fonction Getter pour la propriété invokeId.
Voir aussi setInvokeId().
bool QScxmlEvent::isErrorEvent() const
Renvoie true s'il s'agit d'un événement d'erreur, false dans le cas contraire.
Remarque : fonction Getter pour la propriété errorEvent.
QString QScxmlEvent::name() const
Renvoie le nom de l'événement.
Remarque : fonction Getter pour le nom de la propriété.
Voir également setName().
QString QScxmlEvent::origin() const
Renvoie un URI qui pointe vers l'origine d'un événement SCXML.
Note : Fonction Getter pour la propriété origin.
Voir également setOrigin().
QString QScxmlEvent::originType() const
Renvoie le type d'origine d'un événement SCXML.
Note : fonction Getter pour la propriété originType.
Voir également setOriginType().
QString QScxmlEvent::scxmlType() const
Renvoie le type d'événement.
Remarque : fonction Getter pour la propriété scxmlType.
QString QScxmlEvent::sendId() const
Renvoie l'identifiant de l'événement.
Remarque : fonction Getter pour la propriété sendId.
Voir aussi setSendId().
void QScxmlEvent::setData(const QVariant &data)
Définit les données de la charge utile à data.
Note : Fonction de définition de la propriété data.
Voir également QScxmlEvent::data.
void QScxmlEvent::setDelay(int delayInMiliSecs)
Fixe le délai en millisecondes à la valeur de delayInMiliSecs.
Note : Fonction de définition de la propriété delay.
Voir aussi QScxmlEvent::delay.
void QScxmlEvent::setErrorMessage(const QString &message)
S'il s'agit d'un événement d'erreur, l'adresse message est définie comme message d'erreur.
Note : Fonction de définition de la propriété errorMessage.
Voir aussi errorMessage().
void QScxmlEvent::setEventType(const QScxmlEvent::EventType &type)
Définit le type d'événement à type.
Remarque : fonction de définition de la propriété eventType.
Voir également QScxmlEvent::eventType et QScxmlEvent::EventType.
void QScxmlEvent::setInvokeId(const QString &invokeid)
Définit l'ID d'une machine d'état invoquée à invokeid.
Note : Fonction de définition de la propriété invokeId.
Voir également QScxmlEvent::invokeId.
void QScxmlEvent::setName(const QString &name)
Définit le nom de l'événement à name.
Remarque : fonction de définition de la propriété name.
Voir également name().
void QScxmlEvent::setOrigin(const QString &origin)
Définit l'origine d'un événement SCXML à origin.
Note : Fonction de définition de la propriété origin.
Voir également QScxmlEvent::origin.
void QScxmlEvent::setOriginType(const QString &origintype)
Définit le type d'origine d'un événement SCXML à origintype.
Remarque : fonction de définition de la propriété originType.
Voir également QScxmlEvent::originType.
void QScxmlEvent::setSendId(const QString &sendid)
Définit l'ID sendid pour cet événement.
Remarque : fonction de définition de la propriété sendId.
Voir aussi sendId().
QScxmlEvent &QScxmlEvent::operator=(const QScxmlEvent &other)
Attribue other à cet événement SCXML et renvoie une référence à cet événement SCXML.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
