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=QMessageBox::warning( mainWindow,tr("My Application"),tr("Save changes to document?")、              QMessageBox: :保存 QMessageBox: :丢弃 QMessageBox::取消);switch(ret) {caseQMessageBox::Save: manager.release();if(!saveDocument()) manager.cancel();break;caseQMessageBox::Discard:break;caseQMessageBox取消： 默认情况下：manager.cancel(); } }else{// 我们没有获得交互权限，那么 // 做一些合理的事情代替} }

如果应用程序在保存数据时发生错误，您可以尝试allowsErrorInteraction() 代替。

另请参见 QGuiApplication::commitDataRequest()、release() 和cancel()。

void QSessionManager::cancel()

通知会话管理器取消关闭进程。应用程序不应在未询问用户的情况下调用此函数。

另请参阅 allowsInteraction() 和allowsErrorInteraction()。

QStringList QSessionManager::discardCommand() const

返回当前设置的丢弃命令。

另请参阅 setDiscardCommand()、restartCommand() 和setRestartCommand()。

bool QSessionManager::isPhase2() const

如果会话管理器当前正在执行第二个会话管理阶段，则返回true ；否则返回false 。

另请参阅 requestPhase2() 。

void QSessionManager::release()

在交互阶段结束后释放会话管理器的交互信号。

另请参阅 allowsInteraction() 和allowsErrorInteraction()。

void QSessionManager::requestPhase2()

请求应用程序进入第二个会话管理阶段。然后，应用程序可以立即从QGuiApplication::commitDataRequest() 或QApplication::saveStateRequest() 函数返回，一旦大多数或所有其他应用程序完成会话管理，就会再次调用这两个函数。

这两个阶段对 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() 。