QSessionManager Class

メンバ関数ドキュメント

bool QSessionManager::allowsErrorInteraction()

エラー対話が許可されている場合はtrue を返し、そうでない場合はfalse を返す。

これはallowsInteraction()と似ているが、発生したエラーについてアプリケーショ ンがユーザーに伝えることもできる。セッションマネージャはエラー対話リクエストに高い優先度を与えるかもしれません。 これは、エラー対話が許可される可能性が高くなることを意味します。しかし、セッション・マネージャがエラーとのやりとりを許可するとは限りません。

allowsInteraction()、release()、cancel()も参照の こと。

bool QSessionManager::allowsInteraction()

セッションマネージャーにユーザーとの対話の許可を求める。対話が許可されている場合は true を返し、そうでない場合はfalse を返します。

このメカニズムの背後にある論理的根拠は、シャットダウン中にユーザーとの対話 を同期できるようにすることである。高度なセッションマネージャーは、すべてのアプリケーションに同時にデータをコミットするように要求することができ、その結果、シャットダウンが非常に速くなります。

インタラクションが完了したら、release （）を呼び出してユーザー・インタラクション・セマフォを解放することを強く推奨する。こうすることで、あなたのアプリケーションがまだデータの保存に追われている間に、他のアプリケーションがユーザーと対話する機会を得ることができます。(セマフォは、アプリケーションが終了するときに暗黙的に解放される）。

インタラクション・フェーズ中にユーザがシャットダウン・プロセスのキャンセルを決 定した場合、cancel() を呼び出して、セッション・マネージャにその旨を伝え る必要があります。

以下は、アプリケーションのQGuiApplication::commitDataRequest （）の実装例です：

MyMainWidget::MyMainWidget(QWidget(*parent) ： QWidget(親){
    connect(qApp, &QGuiApplication::commitDataRequest,
           this, &MyMainWidget::commitData); }voidMyMainWidget::commitData(QSessionManager&manager) {if(manager.allowsInteraction()) {intret=::warning( mainWindow, tr("私のアプリケーション", tr("ドキュメントに変更を保存しますか？ QMessageBox::warning( mainWindow,tr("My Application"),tr("Save changes to document?")、              QMessageBox:保存 QMessageBox:破棄 QMessageBox::Cancel);switch(ret) {caseQMessageBox::Save: manager.release();if(!saveDocument()) manager.cancel();break;caseQMessageBox::Discard:break;caseQMessageBox

アプリケーションのデータ保存中にエラーが発生した場合は、代わりにallowsErrorInteraction() を試してみてください。

QGuiApplication::commitDataRequest()、release()、cancel()も参照の こと。

void QSessionManager::cancel()

セッション・マネージャにシャットダウン処理をキャンセルするよう指示します。アプリケーションは、最初にユーザーに尋ねずにこの関数を呼んではならない。

allowsInteraction() およびallowsErrorInteraction()も参照の こと。

QStringList QSessionManager::discardCommand() const

現在設定されている破棄コマンドを返す。

setDiscardCommand()、restartCommand()、setRestartCommand()も参照 。

bool QSessionManager::isPhase2() const

セッションマネージャーが現在2番目のセッション管理フェーズを実行している場合はtrue を返し、そうでない場合はfalse を返す。

requestPhase2()も参照のこと 。

void QSessionManager::release()

インタラクションフェーズの後にセッションマネージャのインタラクションセマフォを解放します。

allowsInteraction() およびallowsErrorInteraction()も参照してください 。

void QSessionManager::requestPhase2()

アプリケーションに2回目のセッション管理フェーズを要求する。アプリケーションは、QGuiApplication::commitDataRequest()またはQApplication::saveStateRequest()関数から即座に戻ることができ、他のアプリケーションのほとんどまたはすべてがセッション管理を終了すると、これらの関数が再び呼び出されます。

この2つのフェーズは、X11ウィンドウ・マネージャのように、他のアプリケーションのウィンドウに関する情報を保存する必要があり、そのためこれらのアプリケーションがそれぞれのセッション管理タスクを完了するまで待たなければならないアプリケーションに便利です。

isPhase2()も参照してください 。

QStringList QSessionManager::restartCommand() const

現在設定されている再起動コマンドを返す。

setRestartCommand() およびrestartHint()も参照 。

QSessionManager::RestartHint QSessionManager::restartHint() const

アプリケーションの現在の再起動ヒントを返す。デフォルトはRestartIfRunning 。

setRestartHint()も参照 。

QString QSessionManager::sessionId() const

現在のセッションの識別子を返します。

アプリケーションが以前のセッションからリストアされている場合、この識別子は以前のセッションと同じです。

sessionKey() およびQGuiApplication::sessionId()も参照してください 。

QString QSessionManager::sessionKey() const

現在のセッションのセッション・キーを返します。

以前のセッションからアプリケーションが復元された場合、このキーは以前のセッションが終了したときと同じです。

セッション・キーは、 commitData() または saveState() を呼び出すたびに変更されます。

sessionId() およびQGuiApplication::sessionKey()も参照してください 。

void QSessionManager::setDiscardCommand(const QStringList &command)

与えられたcommand に廃棄コマンドを設定する。

discardCommand() およびsetRestartCommand()も参照のこと 。

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

アプリケーションの識別と状態記録への低レベルの書き込みアクセスは、セッション・マネージャに保持される。

name というプロパティには、その値が文字列リストvalue に設定されている。

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

これはオーバーロードされた関数である。

アプリケーションの識別と状態の記録への低レベルの書き込みアクセスは、セッション・マネージャに保持される。

name というプロパティには、その値が文字列value に設定される。

void QSessionManager::setRestartCommand(const QStringList &command)

セッションマネージャーがセッションをリストアできる場合、アプリケーションをリストアするためにcommand 。コマンドのデフォルトは

appname -session id

-session オプションは必須である。そうでなければ、QGuiApplication はリストアされたかどうか、あるいは現在のセッション識別子が何であるかを知ることができない。詳しくはQGuiApplication::isSessionRestored() とQGuiApplication::sessionId() を参照してください。

アプリケーションが非常に単純な場合、アプリケーションの状態全体を追加のコマンド行オプショ ンに格納することができるかもしれない。コマンド行は数百バイトに制限されていることが多いので、これは通常、非常に悪い考えです。その代わりに、QSettings 、一時ファイル、またはデータベースをこの目的に使用してください。データを一意のsessionId() でマークすることで、将来のセッションでアプリケーションを復元できるようになる。

restartCommand()、setDiscardCommand()、setRestartHint()も参照の こと。

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

アプリケーションの再起動ヒントをhint に設定する。アプリケーションの起動時に、ヒントはRestartIfRunning に設定される。

ほとんどのセッション・マネージャはアプリケーションの起動直後にチェックポイントを実行するため、QGuiApplication::saveStateRequest() で再起動ヒントを設定することを推奨します。

restartHint()も参照のこと 。