QSessionManager Class

Dokumentation der Mitgliedsfunktionen

bool QSessionManager::allowsErrorInteraction()

Gibt true zurück, wenn eine Fehlerinteraktion erlaubt ist; andernfalls false.

Dies ist ähnlich wie allowsInteraction(), ermöglicht es der Anwendung aber auch, den Benutzer über aufgetretene Fehler zu informieren. Sitzungsmanager können Anfragen zur Fehlerinteraktion eine höhere Priorität einräumen, was bedeutet, dass es wahrscheinlicher ist, dass eine Fehlerinteraktion zugelassen wird. Es gibt jedoch keine Garantie dafür, dass der Sitzungsmanager eine Interaktion zulässt.

Siehe auch allowsInteraction(), release(), und cancel().

bool QSessionManager::allowsInteraction()

Fragt den Sitzungsmanager nach der Erlaubnis zur Interaktion mit dem Benutzer. Gibt true zurück, wenn die Interaktion erlaubt ist; andernfalls wird false zurückgegeben.

Der Grundgedanke hinter diesem Mechanismus ist es, die Synchronisierung der Benutzerinteraktion während des Herunterfahrens zu ermöglichen. Fortgeschrittene Sitzungsmanager können alle Anwendungen gleichzeitig auffordern, ihre Daten zu übertragen, was zu einem wesentlich schnelleren Herunterfahren führt.

Wenn die Interaktion abgeschlossen ist, empfehlen wir dringend, die Semaphore für die Benutzerinteraktion mit einem Aufruf von release() freizugeben. Auf diese Weise können andere Anwendungen die Möglichkeit erhalten, mit dem Benutzer zu interagieren, während Ihre Anwendung noch mit dem Speichern von Daten beschäftigt ist. (Die Semaphore wird implizit freigegeben, wenn die Anwendung beendet wird).

Wenn der Benutzer während der Interaktionsphase beschließt, den Shutdown-Prozess abzubrechen, müssen Sie dem Sitzungsmanager mit dem Aufruf cancel() mitteilen, dass dies geschehen ist.

Das folgende Beispiel zeigt, wie QGuiApplication::commitDataRequest() in einer Anwendung implementiert sein könnte:

MyMainWidget::MyMainWidget(QWidget *parent) : QWidget(Elternteil){
    connect(qApp, &QGuiApplication::commitDataRequest,
           this, &MyMainWidget::commitData); }void MyMainWidget::commitData(QSessionManager& manager) { if (manager.allowsInteraction()) { int ret = QMessageBox::warning( mainWindow,tr("Meine Anwendung"),tr("Änderungen im Dokument speichern?"),             QMessageBox::Speichern | QMessageBox::Verwerfen | QMessageBox::Abbrechen); switch (ret) { case QMessageBox::Save: manager.release(); if (!saveDocument()) manager.cancel(); break; case QMessageBox::Discard: break; case QMessageBox::Cancel: default: manager.cancel(); } } else { // wir haben keine Erlaubnis zur Interaktion erhalten, dann // tun Sie stattdessen etwas Vernünftiges} }

Wenn innerhalb der Anwendung beim Speichern der Daten ein Fehler auftritt, können Sie stattdessen allowsErrorInteraction() verwenden.

Siehe auch QGuiApplication::commitDataRequest(), release(), und cancel().

void QSessionManager::cancel()

Weist den Sitzungsmanager an, den Beendigungsprozess abzubrechen. Anwendungen sollten diese Funktion nicht aufrufen, ohne den Benutzer vorher zu fragen.

Siehe auch allowsInteraction() und allowsErrorInteraction().

QStringList QSessionManager::discardCommand() const

Gibt den aktuell eingestellten Verwerfungsbefehl zurück.

Siehe auch setDiscardCommand(), restartCommand(), und setRestartCommand().

bool QSessionManager::isPhase2() const

Gibt true zurück, wenn der Sitzungsmanager gerade eine zweite Phase der Sitzungsverwaltung durchführt; andernfalls wird false zurückgegeben.

Siehe auch requestPhase2().

void QSessionManager::release()

Gibt die Interaktionssemaphore des Sitzungsmanagers nach einer Interaktionsphase frei.

Siehe auch allowsInteraction() und allowsErrorInteraction().

void QSessionManager::requestPhase2()

Fordert eine zweite Phase der Sitzungsverwaltung für die Anwendung an. Die Anwendung kann dann sofort von der Funktion QGuiApplication::commitDataRequest() oder QApplication::saveStateRequest() zurückkehren, und sie werden erneut aufgerufen, sobald die meisten oder alle anderen Anwendungen ihre Sitzungsverwaltung abgeschlossen haben.

Die beiden Phasen sind nützlich für Anwendungen wie den X11-Fenstermanager, die Informationen über die Fenster einer anderen Anwendung speichern müssen und daher warten müssen, bis diese Anwendungen ihre jeweiligen Sitzungsverwaltungsaufgaben abgeschlossen haben.

Siehe auch isPhase2().

QStringList QSessionManager::restartCommand() const

Gibt den aktuell eingestellten Neustartbefehl zurück.

Siehe auch setRestartCommand() und restartHint().

QSessionManager::RestartHint QSessionManager::restartHint() const

Gibt den aktuellen Neustart-Hinweis der Anwendung zurück. Die Vorgabe ist RestartIfRunning.

Siehe auch setRestartHint().

QString QSessionManager::sessionId() const

Gibt den Bezeichner der aktuellen Sitzung zurück.

Wenn die Anwendung aus einer früheren Sitzung wiederhergestellt wurde, ist dieser Bezeichner derselbe wie in der früheren Sitzung.

Siehe auch sessionKey() und QGuiApplication::sessionId().

QString QSessionManager::sessionKey() const

Gibt den Sitzungsschlüssel der aktuellen Sitzung zurück.

Wurde die Anwendung aus einer früheren Sitzung wiederhergestellt, ist dieser Schlüssel derselbe wie beim Beenden der vorherigen Sitzung.

Der Sitzungsschlüssel ändert sich mit jedem Aufruf von commitData() oder saveState().

Siehe auch sessionId() und QGuiApplication::sessionKey().

void QSessionManager::setDiscardCommand(const QStringList &command)

Setzt den Befehl discard auf die angegebene command.

Siehe auch discardCommand() und setRestartCommand().

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

Der Schreibzugriff auf die Identifikation und den Status der Anwendung wird im Sitzungsmanager gespeichert.

Der Wert der Eigenschaft name ist auf die String-Liste value festgelegt.

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

Dies ist eine überladene Funktion.

Der Schreibzugriff auf die Identifizierungs- und Zustandsdatensätze der Anwendung auf niedriger Ebene wird im Sitzungsmanager gespeichert.

Der Wert der Eigenschaft name ist auf die Zeichenkette value festgelegt.

void QSessionManager::setRestartCommand(const QStringList &command)

Wenn der Sitzungsmanager in der Lage ist, Sitzungen wiederherzustellen, wird er command ausführen, um die Anwendung wiederherzustellen. Der Befehl ist standardmäßig auf

appname -session id

Die Option -session ist obligatorisch; andernfalls kann QGuiApplication nicht feststellen, ob die Sitzung wiederhergestellt wurde oder wie der aktuelle Sitzungsidentifikator lautet. Siehe QGuiApplication::isSessionRestored() und QGuiApplication::sessionId() für Details.

Wenn Ihre Anwendung sehr einfach ist, kann es möglich sein, den gesamten Anwendungsstatus in zusätzlichen Kommandozeilenoptionen zu speichern. Dies ist in der Regel eine sehr schlechte Idee, da Befehlszeilen oft auf einige hundert Bytes beschränkt sind. Verwenden Sie stattdessen QSettings, temporäre Dateien oder eine Datenbank für diesen Zweck. Wenn Sie die Daten mit dem eindeutigen sessionId() markieren, können Sie die Anwendung in einer späteren Sitzung wiederherstellen.

Siehe auch restartCommand(), setDiscardCommand(), und setRestartHint().

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

Setzt den Neustart-Hinweis der Anwendung auf hint. Beim Starten der Anwendung wird der Hinweis auf RestartIfRunning gesetzt.

Wir empfehlen, den Neustart-Hinweis in QGuiApplication::saveStateRequest() zu setzen, da die meisten Sitzungsmanager kurz nach dem Start einer Anwendung einen Checkpoint durchführen.

Siehe auch restartHint().