QStateMachine Class

QPushButton button;

QStateMachine machine;
QState *s1 = new QState();
s1->assignProperty(&button, "text", "Click me");

QFinalState *s2 = new QFinalState();
s1->addTransition(&button, &QPushButton::clicked, s2);

machine.addState(s1);
machine.addState(s2);
machine.setInitialState(s1);
machine.start();

Documentation des fonctions membres

[explicit] QStateMachine::QStateMachine(QObject *parent = nullptr)

Construit un nouvel automate à états avec l'adresse parent.

[virtual noexcept] QStateMachine::~QStateMachine()

Détruit cette machine d'état.

void QStateMachine::addDefaultAnimation(QAbstractAnimation *animation)

Ajoute une adresse animation par défaut à prendre en compte pour toute transition.

void QStateMachine::addState(QAbstractState *state)

Ajoute l'adresse state à cet automate à états. L'état devient un état de premier niveau et la machine à états en devient propriétaire.

Si l'état se trouve déjà dans une autre machine, il sera d'abord supprimé de son ancienne machine, puis ajouté à cette machine.

Voir aussi removeState() et setInitialState().

bool QStateMachine::cancelDelayedEvent(int id)

Annule l'événement retardé identifié par l'adresse id. L'identifiant doit être une valeur renvoyée par un appel à postDelayedEvent(). Retourne true si l'événement a été annulé avec succès, sinon retourne false.

Remarque : cette fonction est sûre pour les threads.

Voir aussi postDelayedEvent().

void QStateMachine::clearError()

Efface la chaîne d'erreur et le code d'erreur de la machine d'état.

QSet<QAbstractState *> QStateMachine::configuration() const

Renvoie l'ensemble cohérent maximal d'états (y compris les états parallèles et finaux) dans lequel se trouve actuellement cette machine à états. Si un état s est dans la configuration, il est toujours possible que le parent de s soit également dans c. Notez cependant que la machine elle-même n'est pas un membre explicite de la configuration.

QList<QAbstractAnimation *> QStateMachine::defaultAnimations() const

Renvoie la liste des animations par défaut qui seront prises en compte pour toute transition.

QStateMachine::Error QStateMachine::error() const

Renvoie le code d'erreur de la dernière erreur survenue dans la machine à états.

QString QStateMachine::errorString() const

Renvoie la chaîne d'erreur de la dernière erreur survenue dans la machine d'état.

[override virtual protected] bool QStateMachine::event(QEvent *e)

Réimplémente : QState::event(QEvent *e).

[override virtual] bool QStateMachine::eventFilter(QObject *watched, QEvent *event)

Réimplémente : QObject::eventFilter(QObject *watched, QEvent *event).

QState::RestorePolicy QStateMachine::globalRestorePolicy() const

Renvoie la politique de restauration de la machine à états.

Voir également setGlobalRestorePolicy().

bool QStateMachine::isAnimated() const

Indique si les animations sont activées pour cette machine d'état.

[override virtual protected] void QStateMachine::onEntry(QEvent *event)

Réimplémente : QState::onEntry(QEvent *event).

Cette fonction appelle start() pour démarrer la machine à états.

[override virtual protected] void QStateMachine::onExit(QEvent *event)

Réimplémente : QState::onExit(QEvent *event).

Cette fonction appellera stop() pour arrêter la machine à états et émettra ensuite le signal stopped().

int QStateMachine::postDelayedEvent(QEvent *event, int delay)

Publie l'événement event pour traitement par cette machine d'état, avec la valeur delay en millisecondes. Retourne un identifiant associé à l'événement retardé, ou -1 si l'événement n'a pas pu être posté.

Cette fonction revient immédiatement. À l'expiration du délai, l'événement est ajouté à la file d'attente des événements de l'automate à états pour être traité. L'automate d'état devient propriétaire de l'événement et le supprime une fois qu'il a été traité.

Vous ne pouvez poster des événements que lorsque la machine à états est en cours d'exécution.

Remarque : cette fonction est à l'épreuve des threads.

Voir aussi cancelDelayedEvent() et postEvent().

int QStateMachine::postDelayedEvent(QEvent *event, std::chrono::milliseconds delay)

Publie l'événement event pour traitement par cette machine d'état, avec la valeur delay en millisecondes. Retourne un identifiant associé à l'événement retardé, ou -1 si l'événement n'a pas pu être posté.

Cette fonction revient immédiatement. À l'expiration du délai, l'événement est ajouté à la file d'attente des événements de l'automate à états pour être traité. L'automate d'état devient propriétaire de l'événement et le supprime une fois qu'il a été traité.

Vous ne pouvez poster des événements que lorsque l'automate d'état est en cours d'exécution.

Remarque : cette fonction est à l'épreuve des threads.

Voir aussi cancelDelayedEvent() et postEvent().

void QStateMachine::postEvent(QEvent *event, QStateMachine::EventPriority priority = NormalPriority)

Affiche le site event du site priority pour qu'il soit traité par cette machine d'état.

Cette fonction est renvoyée immédiatement. L'événement est ajouté à la file d'attente d'événements de la machine à états. Les événements sont traités dans l'ordre dans lequel ils ont été postés. La machine à états prend possession de l'événement et le supprime une fois qu'il a été traité.

Vous ne pouvez poster des événements que lorsque l'automate à états est en cours d'exécution ou lorsqu'il démarre.

Remarque : cette fonction est à l'épreuve des threads.

Voir aussi postDelayedEvent().

void QStateMachine::removeDefaultAnimation(QAbstractAnimation *animation)

Supprime animation de la liste des animations par défaut.

void QStateMachine::removeState(QAbstractState *state)

Supprime l'adresse state de cet automate d'état. La machine à états libère la propriété de l'état.

Voir également addState().

[signal] void QStateMachine::runningChanged(bool running)

Ce signal est émis lorsque la propriété en cours d'exécution est modifiée avec running comme argument.

Voir aussi QStateMachine::running.

void QStateMachine::setAnimated(bool enabled)

Définit si les animations sont enabled pour cette machine d'état.

Voir également isAnimated().

void QStateMachine::setGlobalRestorePolicy(QState::RestorePolicy restorePolicy)

Définit la politique de restauration de la machine à états à restorePolicy. La politique de restauration par défaut est QState::DontRestoreProperties.

Voir également globalRestorePolicy().

[slot] void QStateMachine::start()

Démarre cette machine d'état. La machine réinitialise sa configuration et passe à l'état initial. Lorsqu'un état final de niveau supérieur (QFinalState) est atteint, la machine émet le signal finished().

Voir également started(), finished(), stop(), initialState() et setRunning().

[private signal] void QStateMachine::started()

Ce signal est émis lorsque la machine à états est entrée dans son état initial (QStateMachine::initialState).

Voir aussi QStateMachine::finished() et QStateMachine::start().

[slot] void QStateMachine::stop()

Arrête cette machine à états. L'automate d'état cesse de traiter les événements et émet alors le signal stopped().

Voir également stopped(), start() et setRunning().

[private signal] void QStateMachine::stopped()

Ce signal est émis lorsque la machine à états s'est arrêtée.

Voir aussi QStateMachine::stop() et QStateMachine::finished().