QSessionManager

The QSessionManager class provides access to the session manager. More…

Inheritance diagram of PySide2.QtGui.QSessionManager

Synopsis

Functions

Detailed Description

A session manager in a desktop environment (in which Qt GUI applications live) keeps track of a session, which is a group of running applications, each of which has a particular state. The state of an application contains (most notably) the documents the application has open and the position and size of its windows.

The session manager is used to save the session, e.g., when the machine is shut down, and to restore a session, e.g., when the machine is started up. We recommend that you use QSettings to save an application’s settings, for example, window positions, recently used files, etc. When the application is restarted by the session manager, you can restore the settings.

QSessionManager provides an interface between the application and the platform’s session manager. In Qt, session management requests for action are handled by the two signals commitDataRequest() and saveStateRequest() . Both provide a reference to a QSessionManager object as argument. The session manager can only be accessed in slots invoked by these signals.

Warning

If you use QSessionManager , you should disable fallback session management: setFallbackSessionManagementEnabled() .

No user interaction is possible unless the application gets explicit permission from the session manager. You ask for permission by calling allowsInteraction() or, if it is really urgent, allowsErrorInteraction() . Qt does not enforce this, but the session manager may.

You can try to abort the shutdown process by calling cancel() .

For sophisticated session managers provided on Unix/X11, QSessionManager offers further possibilities to fine-tune an application’s session management behavior: setRestartCommand() , setDiscardCommand() , setRestartHint() , setProperty() , requestPhase2() . See the respective function descriptions for further details.

See also

QGuiApplication Session Management

class PySide2.QtGui.QSessionManager
PySide2.QtGui.QSessionManager.RestartHint

This enum type defines the circumstances under which this application wants to be restarted by the session manager. The current values are:

Constant

Description

QSessionManager.RestartIfRunning

If the application is still running when the session is shut down, it wants to be restarted at the start of the next session.

QSessionManager.RestartAnyway

The application wants to be started at the start of the next session, no matter what. (This is useful for utilities that run just after startup and then quit.)

QSessionManager.RestartImmediately

The application wants to be started immediately whenever it is not running.

QSessionManager.RestartNever

The application does not want to be restarted automatically.

The default hint is RestartIfRunning .

PySide2.QtGui.QSessionManager.allowsErrorInteraction()
Return type:

bool

Returns true if error interaction is permitted; otherwise returns false .

This is similar to allowsInteraction() , but also enables the application to tell the user about any errors that occur. Session managers may give error interaction requests higher priority, which means that it is more likely that an error interaction is permitted. However, you are still not guaranteed that the session manager will allow interaction.

See also

allowsInteraction() release() cancel()

PySide2.QtGui.QSessionManager.allowsInteraction()
Return type:

bool

Asks the session manager for permission to interact with the user. Returns true if interaction is permitted; otherwise returns false .

The rationale behind this mechanism is to make it possible to synchronize user interaction during a shutdown. Advanced session managers may ask all applications simultaneously to commit their data, resulting in a much faster shutdown.

When the interaction is completed we strongly recommend releasing the user interaction semaphore with a call to release() . This way, other applications may get the chance to interact with the user while your application is still busy saving data. (The semaphore is implicitly released when the application exits.)

If the user decides to cancel the shutdown process during the interaction phase, you must tell the session manager that this has happened by calling cancel() .

Here’s an example of how an application’s commitDataRequest() might be implemented:

MyMainWidget::MyMainWidget(QWidget *parent)
    :QWidget(parent)
{
    QGuiApplication::setFallbackSessionManagementEnabled(false);
    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::Save | QMessageBox::Discard | QMessageBox::Cancel);

        switch (ret) {
        case QMessageBox::Save:
            manager.release();
            if (!saveDocument())
                manager.cancel();
            break;
        case QMessageBox::Discard:
            break;
        case QMessageBox::Cancel:
        default:
            manager.cancel();
        }
    } else {
        // we did not get permission to interact, then
        // do something reasonable instead
    }
}

If an error occurred within the application while saving its data, you may want to try allowsErrorInteraction() instead.

See also

commitDataRequest() release() cancel()

PySide2.QtGui.QSessionManager.cancel()

Tells the session manager to cancel the shutdown process. Applications should not call this function without asking the user first.

See also

allowsInteraction() allowsErrorInteraction()

PySide2.QtGui.QSessionManager.discardCommand()
Return type:

list of strings

Returns the currently set discard command.

To iterate over the list, you can use the foreach pseudo-keyword:

const QStringList commands = mySession.discardCommand();
for (const QString &command : mySession.discardCommand())
    do_something(command);

See also

setDiscardCommand() restartCommand() setRestartCommand()

PySide2.QtGui.QSessionManager.isPhase2()
Return type:

bool

Returns true if the session manager is currently performing a second session management phase; otherwise returns false .

See also

requestPhase2()

PySide2.QtGui.QSessionManager.release()

Releases the session manager’s interaction semaphore after an interaction phase.

See also

allowsInteraction() allowsErrorInteraction()

PySide2.QtGui.QSessionManager.requestPhase2()

Requests a second session management phase for the application. The application may then return immediately from the commitDataRequest() or saveStateRequest() function, and they will be called again once most or all other applications have finished their session management.

The two phases are useful for applications such as the X11 window manager that need to store information about another application’s windows and therefore have to wait until these applications have completed their respective session management tasks.

Note

If another application has requested a second phase it may get called before, simultaneously with, or after your application’s second phase.

See also

isPhase2()

PySide2.QtGui.QSessionManager.restartCommand()
Return type:

list of strings

Returns the currently set restart command.

To iterate over the list, you can use the foreach pseudo-keyword:

const QStringList commands = mySession.restartCommand();
for (const QString &command : commands)
    do_something(command);

See also

setRestartCommand() restartHint()

PySide2.QtGui.QSessionManager.restartHint()
Return type:

RestartHint

Returns the application’s current restart hint. The default is RestartIfRunning .

See also

setRestartHint()

PySide2.QtGui.QSessionManager.sessionId()
Return type:

str

Returns the identifier of the current session.

If the application has been restored from an earlier session, this identifier is the same as it was in the earlier session.

See also

sessionKey() sessionId()

PySide2.QtGui.QSessionManager.sessionKey()
Return type:

str

Returns the session key in the current session.

If the application has been restored from an earlier session, this key is the same as it was when the previous session ended.

The session key changes with every call of commitData() or saveState().

See also

sessionId() sessionKey()

PySide2.QtGui.QSessionManager.setDiscardCommand(arg__1)
Parameters:

arg__1 – list of strings

Sets the discard command to the given command .

See also

discardCommand() setRestartCommand()

PySide2.QtGui.QSessionManager.setManagerProperty(name, value)
Parameters:

  • name – str

  • value – str

PySide2.QtGui.QSessionManager.setManagerProperty(name, value)
Parameters:

  • name – str

  • value – list of strings

PySide2.QtGui.QSessionManager.setRestartCommand(arg__1)
Parameters:

arg__1 – list of strings

If the session manager is capable of restoring sessions it will execute command in order to restore the application. The command defaults to

appname -session id

The -session option is mandatory; otherwise QGuiApplication cannot tell whether it has been restored or what the current session identifier is. See isSessionRestored() and sessionId() for details.

If your application is very simple, it may be possible to store the entire application state in additional command line options. This is usually a very bad idea because command lines are often limited to a few hundred bytes. Instead, use QSettings , temporary files, or a database for this purpose. By marking the data with the unique sessionId() , you will be able to restore the application in a future session.

See also

restartCommand() setDiscardCommand() setRestartHint()

PySide2.QtGui.QSessionManager.setRestartHint(arg__1)
Parameters:

arg__1 – RestartHint

Sets the application’s restart hint to hint . On application startup, the hint is set to RestartIfRunning .

Note

These flags are only hints, a session manager may or may not respect them.

We recommend setting the restart hint in saveStateRequest() because most session managers perform a checkpoint shortly after an application’s startup.

See also

restartHint()