QSessionManager Class

Documentation sur les fonctions membres

bool QSessionManager::allowsErrorInteraction()

Renvoie true si l'interaction avec les erreurs est autorisée ; sinon, renvoie false.

Cette méthode est similaire à allowsInteraction(), mais elle permet également à l'application d'informer l'utilisateur des erreurs qui se produisent. Les gestionnaires de session peuvent accorder une priorité plus élevée aux demandes d'interaction avec les erreurs, ce qui signifie qu'il est plus probable qu'une interaction avec les erreurs soit autorisée. Cependant, vous n'avez toujours pas la garantie que le gestionnaire de session autorisera l'interaction.

Voir également allowsInteraction(), release() et cancel().

bool QSessionManager::allowsInteraction()

Demande au gestionnaire de session l'autorisation d'interagir avec l'utilisateur. Retourne true si l'interaction est autorisée, sinon retourne false.

La raison d'être de ce mécanisme est de permettre de synchroniser l'interaction avec l'utilisateur au cours d'un arrêt. Les gestionnaires de session avancés peuvent demander simultanément à toutes les applications de valider leurs données, ce qui accélère considérablement l'arrêt.

Lorsque l'interaction est terminée, nous recommandons vivement de libérer le sémaphore d'interaction utilisateur par un appel à release(). De cette manière, d'autres applications peuvent avoir la possibilité d'interagir avec l'utilisateur pendant que votre application est encore occupée à enregistrer des données. (Le sémaphore est implicitement libéré lorsque l'application se termine).

Si l'utilisateur décide d'annuler le processus d'arrêt pendant la phase d'interaction, vous devez en informer le gestionnaire de session en appelant cancel().

Voici un exemple d'implémentation de la fonction QGuiApplication::commitDataRequest() d'une application :

MyMainWidget::MyMainWidget(QWidget *parent) : QWidget(parent){
    connect(qApp, &QGuiApplication::commitDataRequest,
           this, &MyMainWidget::commitData) ; }void MyMainWidget::commitData(QSessionManager& manager) { if (manager.allowsInteraction()) { int ret = QMessageBox::warning( mainWindow,tr("My Application"),tr("Save changes to document ?"),    QMessageBox::Enregistrer | QMessageBox::Discard | QMessageBox::Cancel) ; switch (ret) { case QMessageBox::Save : manager.release() ; if (!saveDocument()) manager.cancel() ; break; case ::Discard : break ; case QMessageBox::Discard : break; case QMessageBox::Cancel : default: manager.cancel() ; } } else { // nous n'avons pas eu la permission d'interagir, alors // faites quelque chose de raisonnable à la place} }

Si une erreur s'est produite dans l'application lors de l'enregistrement des données, vous pouvez essayer allowsErrorInteraction() à la place.

Voir également QGuiApplication::commitDataRequest(), release() et cancel().

void QSessionManager::cancel()

Indique au gestionnaire de session d'annuler le processus d'arrêt. Les applications ne doivent pas appeler cette fonction sans demander l'avis de l'utilisateur.

Voir également allowsInteraction() et allowsErrorInteraction().

QStringList QSessionManager::discardCommand() const

Renvoie la commande de rejet actuellement définie.

Voir aussi setDiscardCommand(), restartCommand() et setRestartCommand().

bool QSessionManager::isPhase2() const

Renvoie true si le gestionnaire de session est en train d'effectuer une deuxième phase de gestion de session ; sinon, renvoie false.

Voir également requestPhase2().

void QSessionManager::release()

Libère le sémaphore d'interaction du gestionnaire de session après une phase d'interaction.

Voir également allowsInteraction() et allowsErrorInteraction().

void QSessionManager::requestPhase2()

Demande une deuxième phase de gestion de session pour l'application. L'application peut alors revenir immédiatement de la fonction QGuiApplication::commitDataRequest() ou QApplication::saveStateRequest(), qui seront appelées à nouveau une fois que la plupart ou toutes les autres applications auront terminé leur gestion de session.

Les deux phases sont utiles pour les applications telles que le gestionnaire de fenêtres X11 qui doivent stocker des informations sur les fenêtres d'une autre application et qui doivent donc attendre que ces applications aient terminé leurs tâches respectives de gestion de session.

Voir également isPhase2().

QStringList QSessionManager::restartCommand() const

Renvoie la commande de redémarrage actuellement définie.

Voir aussi setRestartCommand() et restartHint().

QSessionManager::RestartHint QSessionManager::restartHint() const

Renvoie l'indice de redémarrage actuel de l'application. La valeur par défaut est RestartIfRunning.

Voir aussi setRestartHint().

QString QSessionManager::sessionId() const

Renvoie l'identifiant de la session en cours.

Si l'application a été restaurée à partir d'une session antérieure, cet identifiant est le même que celui de la session antérieure.

Voir aussi sessionKey() et QGuiApplication::sessionId().

QString QSessionManager::sessionKey() const

Renvoie la clé de session de la session en cours.

Si l'application a été restaurée à partir d'une session antérieure, cette clé est la même qu'à la fin de la session précédente.

La clé de session change à chaque appel de commitData() ou saveState().

Voir également sessionId() et QGuiApplication::sessionKey().

void QSessionManager::setDiscardCommand(const QStringList &command)

Définit la commande de rejet à l'adresse command.

Voir aussi discardCommand() et setRestartCommand().

void QSessionManager::setManagerProperty(const QString &name, const QStringList &value)

L'accès en écriture de bas niveau à l'identification de l'application et à l'enregistrement de l'état est conservé dans le gestionnaire de session.

La propriété appelée name a pour valeur la liste de chaînes value.

void QSessionManager::setManagerProperty(const QString &name, const QString &value)

L'accès en écriture de bas niveau aux enregistrements d'identification et d'état de l'application est conservé dans le gestionnaire de session.

La propriété appelée name a pour valeur la chaîne de caractères value.

void QSessionManager::setRestartCommand(const QStringList &command)

Si le gestionnaire de session est capable de restaurer des sessions, il exécutera command afin de restaurer l'application. La commande est par défaut

appname -session id

L'option -session est obligatoire, sinon QGuiApplication ne peut pas savoir s'il a été restauré ou quel est l'identifiant de la session en cours. Voir QGuiApplication::isSessionRestored() et QGuiApplication::sessionId() pour plus de détails.

Si votre application est très simple, il peut être possible de stocker tout l'état de l'application dans des options de ligne de commande supplémentaires. C'est généralement une très mauvaise idée, car les lignes de commande sont souvent limitées à quelques centaines d'octets. Utilisez plutôt QSettings, des fichiers temporaires ou une base de données. En marquant les données avec l'unique sessionId(), vous pourrez restaurer l'application lors d'une prochaine session.

Voir également restartCommand(), setDiscardCommand() et setRestartHint().

void QSessionManager::setRestartHint(QSessionManager::RestartHint hint)

Définit l'indice de redémarrage de l'application à hint. Au démarrage de l'application, l'indice est fixé à RestartIfRunning.

Nous recommandons de définir l'indice de redémarrage dans QGuiApplication::saveStateRequest() car la plupart des gestionnaires de session effectuent un point de contrôle peu de temps après le démarrage d'une application.

Voir également restartHint().