API reference - Class QSessionManager

RestartAnyway

Signature: [static,const] QSessionManager_RestartHint RestartAnyway

Description: Enum constant QSessionManager::RestartAnyway

Python specific notes:
The object exposes a readable attribute 'RestartAnyway'. This is the getter.

RestartIfRunning

Signature: [static,const] QSessionManager_RestartHint RestartIfRunning

Description: Enum constant QSessionManager::RestartIfRunning

Python specific notes:
The object exposes a readable attribute 'RestartIfRunning'. This is the getter.

RestartImmediately

Signature: [static,const] QSessionManager_RestartHint RestartImmediately

Description: Enum constant QSessionManager::RestartImmediately

Python specific notes:
The object exposes a readable attribute 'RestartImmediately'. This is the getter.

RestartNever

Signature: [static,const] QSessionManager_RestartHint RestartNever

Description: Enum constant QSessionManager::RestartNever

Python specific notes:
The object exposes a readable attribute 'RestartNever'. This is the getter.

_const_cast

Signature: [const] QSessionManager ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

allowsErrorInteraction

Signature: bool allowsErrorInteraction

Description: Method bool QSessionManager::allowsErrorInteraction()

allowsInteraction

Signature: bool allowsInteraction

Description: Method bool QSessionManager::allowsInteraction()

cancel

Signature: void cancel

Description: Method void QSessionManager::cancel()

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QSessionManager::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

discardCommand

Signature: [const] string[] discardCommand

Description: Method QStringList QSessionManager::discardCommand()

Python specific notes:
The object exposes a readable attribute 'discardCommand'. This is the getter.

discardCommand=

Signature: void discardCommand= (string[] arg1)

Description: Method void QSessionManager::setDiscardCommand(const QStringList &)

Python specific notes:
The object exposes a writable attribute 'discardCommand'. This is the setter.

isPhase2?

Signature: [const] bool isPhase2?

Description: Method bool QSessionManager::isPhase2()

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QSessionManager::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

release

Signature: void release

Description: Method void QSessionManager::release()

requestPhase2

Signature: void requestPhase2

Description: Method void QSessionManager::requestPhase2()

restartCommand

Signature: [const] string[] restartCommand

Description: Method QStringList QSessionManager::restartCommand()

Python specific notes:
The object exposes a readable attribute 'restartCommand'. This is the getter.

restartCommand=

Signature: void restartCommand= (string[] arg1)

Description: Method void QSessionManager::setRestartCommand(const QStringList &)

Python specific notes:
The object exposes a writable attribute 'restartCommand'. This is the setter.

restartHint

Signature: [const] QSessionManager_RestartHint restartHint

Description: Method QSessionManager::RestartHint QSessionManager::restartHint()

Python specific notes:
The object exposes a readable attribute 'restartHint'. This is the getter.

restartHint=

Signature: void restartHint= (const QSessionManager_RestartHint arg1)

Description: Method void QSessionManager::setRestartHint(QSessionManager::RestartHint)

Python specific notes:
The object exposes a writable attribute 'restartHint'. This is the setter.

sessionId

Signature: [const] string sessionId

Description: Method QString QSessionManager::sessionId()

sessionKey

Signature: [const] string sessionKey

Description: Method QString QSessionManager::sessionKey()

setDiscardCommand

Signature: void setDiscardCommand (string[] arg1)

Description: Method void QSessionManager::setDiscardCommand(const QStringList &)

Python specific notes:
The object exposes a writable attribute 'discardCommand'. This is the setter.

setManagerProperty

(1) Signature: void setManagerProperty (string name, string value)

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

(2) Signature: void setManagerProperty (string name, string[] value)

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

setRestartCommand

Signature: void setRestartCommand (string[] arg1)

Description: Method void QSessionManager::setRestartCommand(const QStringList &)

Python specific notes:
The object exposes a writable attribute 'restartCommand'. This is the setter.

setRestartHint

Signature: void setRestartHint (const QSessionManager_RestartHint arg1)

Description: Method void QSessionManager::setRestartHint(QSessionManager::RestartHint)

Python specific notes:
The object exposes a writable attribute 'restartHint'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QSessionManager::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QSessionManager::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.