Documented Symbian peculiarity about QDesktopWidget::availableGeometry

In Symbian QDesktopWidget::availableGeometry() is not guaranteed to
return correct values at the time the resize event related to the
geometry change is passed to the widgets. There is a similar issue
with QDesktopWidget::screenGeometry(). Documented this fact.

Task-number: QTBUG-14058
Reviewed-by: Sami Merila

1 files changed, 10 insertions, 0 deletions

diff --git a/src/gui/kernel/qdesktopwidget.qdoc b/src/gui/kernel/qdesktopwidget.qdoc
index f71155e..b93bcb3 100644
--- a/src/gui/kernel/qdesktopwidget.qdoc
+++ b/src/gui/kernel/qdesktopwidget.qdoc
@@ -151,6 +151,11 @@
      on Mac OS X, or the task bar on Windows). The default screen is used if
      \a screen is -1.
 
+     \note In Symbian devices the available geometry reported by QDesktopWidget is
+     not guaranteed to be correct at the time the geometry change resize event
+     is passed to widgets. The correct way to listen for available geometry changes
+     is to connect to the workAreaResized() signal of QDesktopWidget.
+
      \sa screenNumber(), screenGeometry()
 */
 
@@ -179,6 +184,11 @@
     Returns the geometry of the screen with index \a screen. The default
     screen is used if \a screen is -1.
 
+     \note In Symbian devices the screen geometry reported by QDesktopWidget is
+     not guaranteed to be correct at the time the geometry change resize event
+     is passed to widgets. The correct way to listen for screen geometry changes
+     is to connect to the resized() signal of QDesktopWidget.
+
     \sa screenNumber()
 */