diff options
author | Samuel Gaist <samuel.gaist@edeltech.ch> | 2013-09-27 21:53:12 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-02 11:44:52 +0200 |
commit | 56cd9cc2b085c1a2152831d47bb8fd9607d7500e (patch) | |
tree | ed9a4efb58d10f4535060300e6f8e479b766ec78 /src/gui/kernel | |
parent | bc962256b41ebbf656a8d533397d1776c43a719e (diff) |
Update QSessionManager and related classes documentation
Update the Qt 4 documentation of QSessionManager to reflect the changes
in Qt 5
Task-number: QTBUG-33528
Change-Id: I74286134155efc2781f9f6fc505fb6cf736d814e
Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/gui/kernel')
-rw-r--r-- | src/gui/kernel/qguiapplication.cpp | 4 | ||||
-rw-r--r-- | src/gui/kernel/qsessionmanager.cpp | 50 | ||||
-rw-r--r-- | src/gui/kernel/qstylehints.cpp | 2 |
3 files changed, 30 insertions, 26 deletions
diff --git a/src/gui/kernel/qguiapplication.cpp b/src/gui/kernel/qguiapplication.cpp index 8e5c290cc6..bde8d99a1c 100644 --- a/src/gui/kernel/qguiapplication.cpp +++ b/src/gui/kernel/qguiapplication.cpp @@ -2935,7 +2935,7 @@ static inline void applyWindowCursor(const QList<QWindow *> &l) restoreOverrideCursor(), otherwise the stack will never be emptied. Example: - \snippet code/src_gui_kernel_qapplication_x11.cpp 0 + \snippet code/src_gui_kernel_qguiapplication_x11.cpp 0 \sa overrideCursor(), restoreOverrideCursor(), changeOverrideCursor(), QWidget::setCursor() @@ -2995,7 +2995,7 @@ QStyleHints *QGuiApplication::styleHints() This function must be called before creating the QGuiApplication object, like this: - \snippet code/src_gui_kernel_qapplication.cpp 6 + \snippet code/src_gui_kernel_qguiapplication.cpp 0 \sa desktopSettingsAware() */ diff --git a/src/gui/kernel/qsessionmanager.cpp b/src/gui/kernel/qsessionmanager.cpp index 8cc8d3d961..c46dd5f55a 100644 --- a/src/gui/kernel/qsessionmanager.cpp +++ b/src/gui/kernel/qsessionmanager.cpp @@ -74,10 +74,11 @@ QT_BEGIN_NAMESPACE QSessionManager provides an interface between the application and the session manager so that the program can work well with the session manager. In Qt, session management requests for action are handled by the two - virtual functions QApplication::commitData() and QApplication::saveState(). - Both provide a reference to a session manager object as argument, to allow - the application to communicate with the session manager. The session - manager can only be accessed through these functions. + signals QGuiApplication::commitDataRequest() and + QGuiApplication::saveStateRequest(). Both provide a reference to a session + manager object as argument, to allow the application to communicate with + the session manager. The session manager can only be accessed through these + functions. No user interaction is possible \e unless the application gets explicit permission from the session manager. You ask for permission by calling @@ -94,7 +95,7 @@ QT_BEGIN_NAMESPACE setRestartHint(), setProperty(), requestPhase2(). See the respective function descriptions for further details. - \sa QApplication, {Session Management} + \sa QGuiApplication, {Session Management} */ @@ -151,7 +152,7 @@ QSessionManager::~QSessionManager() If the application has been restored from an earlier session, this identifier is the same as it was in the earlier session. - \sa sessionKey(), QApplication::sessionId() + \sa sessionKey(), QGuiApplication::sessionId() */ QString QSessionManager::sessionId() const { @@ -169,7 +170,7 @@ QString QSessionManager::sessionId() const The session key changes with every call of commitData() or saveState(). - \sa sessionId(), QApplication::sessionKey() + \sa sessionId(), QGuiApplication::sessionKey() */ QString QSessionManager::sessionKey() const { @@ -197,15 +198,15 @@ QString QSessionManager::sessionKey() const phase, you must tell the session manager that this has happened by calling cancel(). - Here's an example of how an application's QApplication::commitData() might - be implemented: + Here's an example of how an application's QGuiApplication::commitDataRequest() + might be implemented: - \snippet code/src_gui_kernel_qapplication.cpp 8 + \snippet code/src_gui_kernel_qguiapplication.cpp 8 If an error occurred within the application while saving its data, you may want to try allowsErrorInteraction() instead. - \sa QApplication::commitData(), release(), cancel() + \sa QGuiApplication::commitDataRequest(), release(), cancel() */ bool QSessionManager::allowsInteraction() { @@ -261,8 +262,9 @@ void QSessionManager::cancel() \note These flags are only hints, a session manager may or may not respect them. - We recommend setting the restart hint in QApplication::saveState() because - most session managers perform a checkpoint shortly after an application's + We recommend setting the restart hint in QGuiApplication::saveStateRequest() + because most session managers perform a checkpoint shortly after an + application's startup. \sa restartHint() @@ -291,12 +293,13 @@ QSessionManager::RestartHint QSessionManager::restartHint() const If the session manager is capable of restoring sessions it will execute \a command in order to restore the application. The command defaults to - \snippet code/src_gui_kernel_qapplication.cpp 9 + \snippet code/src_gui_kernel_qguiapplication.cpp 9 - The \c -session option is mandatory; otherwise QApplication cannot tell - whether it has been restored or what the current session identifier is. - See QApplication::isSessionRestored() and QApplication::sessionId() for - details. + The \c -session option is mandatory; otherwise QGuiApplication cannot + tell whether it has been restored or what the current session identifier + is. + See QGuiApplication::isSessionRestored() and + QGuiApplication::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 @@ -318,7 +321,7 @@ void QSessionManager::setRestartCommand(const QStringList &command) To iterate over the list, you can use the \l foreach pseudo-keyword: - \snippet code/src_gui_kernel_qapplication.cpp 10 + \snippet code/src_gui_kernel_qguiapplication.cpp 10 \sa setRestartCommand(), restartHint() */ @@ -344,7 +347,7 @@ void QSessionManager::setDiscardCommand(const QStringList &command) To iterate over the list, you can use the \l foreach pseudo-keyword: - \snippet code/src_gui_kernel_qapplication.cpp 11 + \snippet code/src_gui_kernel_qguiapplication.cpp 11 \sa setDiscardCommand(), restartCommand(), setRestartCommand() */ @@ -396,9 +399,10 @@ bool QSessionManager::isPhase2() const /*! Requests a second session management phase for the application. The - application may then return immediately from the QApplication::commitData() - or QApplication::saveState() function, and they will be called again once - most or all other applications have finished their session management. + application may then return immediately from the + QGuiApplication::commitDataRequest() or QApplication::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 diff --git a/src/gui/kernel/qstylehints.cpp b/src/gui/kernel/qstylehints.cpp index a302f2186c..04ea9c27d5 100644 --- a/src/gui/kernel/qstylehints.cpp +++ b/src/gui/kernel/qstylehints.cpp @@ -106,7 +106,7 @@ int QStyleHints::mouseDoubleClickInterval() const and the current position (e.g. in the mouse move event) is \c currentPos, you can find out if a drag should be started with code like this: - \snippet code/src_gui_kernel_qapplication.cpp 7 + \snippet code/src_gui_kernel_qguiapplication.cpp 6 \sa startDragTime(), QPoint::manhattanLength(), {Drag and Drop} */ |