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(parent)
{
    connect(qApp, &QGuiApplication::commitDataRequest,
           this, &MyMainWidget::commitData);
}

voidMyMainWidget::commitData(QSessionManager&manager)
{
    if(manager.allowsInteraction()) {
        intret=QMessageBox::warning(
                    mainWindow,
                    tr("My Application"),
                    tr("ドキュメントの変更を保存しますか？"),
                    QMessageBox::Save|QMessageBox::Discard|QMessageBox::Cancel);

        switch(ret) {
        caseQMessageBox::Save:
            manager.release();
            if(!saveDocument())
                manager.cancel();
            break;
        caseQMessageBox::破棄:
            break;
        caseQMessageBox::Cancel:
        default:
            manager.cancel();
        }
    }else{
        // 操作の許可が得られなかった場合、
        // 代わりに適切な処理を行う
    }
}

データの保存中にアプリケーション内でエラーが発生した場合は、代わりに `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()も参照してください 。