Documentation update for new switching events.

Merge-request: 926
Reviewed-by: Samuel Rødal <samuel.rodal@nokia.com>

1 files changed, 6 insertions, 0 deletions

diff --git a/tools/qmeegographicssystemhelper/qmeegographicssystemhelper.h b/tools/qmeegographicssystemhelper/qmeegographicssystemhelper.h
index 2baacbb..d47c829 100644
--- a/tools/qmeegographicssystemhelper/qmeegographicssystemhelper.h
+++ b/tools/qmeegographicssystemhelper/qmeegographicssystemhelper.h
@@ -102,6 +102,9 @@ public:
      When running with the 'runtime' graphics system, sets the currently active 
      system to 'meego'. The window surface and all the resources are automatically
      migrated to OpenGL. Will fail if the active graphics system is not 'runtime'.
+     Calling this function will emit QMeeGoSwitchEvent to the top level widgets.
+     Two events will be emitted for each switch -- one before the switch (QMeeGoSwitchEvent::WillSwitch)
+     and one after the switch (QMeeGoSwitchEvent::DidSwitch).
     */
     static void switchToMeeGo();
 
@@ -111,6 +114,9 @@ public:
      system to 'raster'. The window surface and the graphics resources (including the 
      EGL shared image resources) are automatically migrated back to the CPU. All OpenGL 
      resources (surface, context, cache, font cache) are automaticall anihilated.
+     Calling this function will emit QMeeGoSwitchEvent to the top level widgets.
+     Two events will be emitted for each switch -- one before the switch (QMeeGoSwitchEvent::WillSwitch)
+     and one after the switch (QMeeGoSwitchEvent::DidSwitch).
     */
     static void switchToRaster();