src/hbwidgets/devicedialogs/hbdevicemessagebox.cpp
changeset 28 b7da29130b0e
parent 21 4633027730f5
child 30 80e4d18b72f5
--- a/src/hbwidgets/devicedialogs/hbdevicemessagebox.cpp	Thu Sep 02 20:44:51 2010 +0300
+++ b/src/hbwidgets/devicedialogs/hbdevicemessagebox.cpp	Fri Sep 17 08:32:10 2010 +0300
@@ -407,13 +407,13 @@
     @stable
     @hbwidgets
     \class HbDeviceMessageBox
-    \brief HbDeviceMessageBox displays a message box on top of any running applications.
+    \brief HbDeviceMessageBox displays a message box on top all applications.
 
-    HbDeviceMessageBox is a device-dialog version of HbMessageBox. It displays a message box
-    with text, icon or animation and optional accept and reject buttons. The message box is
-    displayed by a device-dialog service which HbDeviceMessageBox is a client of.
+    HbDeviceMessageBox is a device-dialog version of HbMessageBox. It is a modal
+    dialog and displayed on top all applications by a device-dialog service.
+    HbDeviceMessageBox is a client of the service.
 
-    Device dialogs are shown on top of any running applications and are always modal by nature.
+    For content it provides text, icon or animation and optional accept and reject buttons.
 
     A device message box is lauched by a show(). A new message box is lauched every time show()
     is called. aboutToClose() signal is emitted when the box has closed. There is also syncronous
@@ -440,6 +440,10 @@
     be updated. Information and warning convenience methods return immediately. Question waits for
     a message box to close and is not compatible with gestures.
 
+    If none of HbDeviceMessageBox signals have been connected to, the object can be deleted after
+    show() has been called and device-dialog service takes care showing the message box. If any
+    signals are connected, message box is closed when HbDeviceMessageBox object goes out of scope.  
+
     Four types of message boxes are predefined. The type determines a set of default properties that
     are set on construction. Below is a table listing types and their default properties.
 
@@ -452,12 +456,18 @@
         <tr><td>Question</td><td>Question icon</td><td>"Yes" and "No" buttons</td><td>No timeout</td><td>Button press</td><td>Question sound</td></tr>
     </table>
 
-    In place of an icon, message box may conatain an animation. Supported icon animation formats are:
+    In place of an icon, message box may contain an animation. Supported icon animation formats are:
     - GIF (.gif)
     - MNG (.mng)
     - Frame animations (.axml)
 
-    Sample code:
+    \section _platform_spec Platform-specific implementation notes for HbDeviceNotificationDialog
+
+    \subsection _nonsymbian Non-Symbian
+    Device dialog service is implemented only for the Symbian platform. On other platforms device 
+    message boxes are displayed on client's main window.
+
+    \section _code_samples Sample code
 
     \code
     // Ask from user whether to continue operation or not.
@@ -555,6 +565,7 @@
 
 /*!
     Constructor.
+
     \param type Type of the message box.
     \param parent An optional parameter.
 */
@@ -570,6 +581,7 @@
 
 /*!
     Constructor.
+
     \param text Message box text.
     \param type Type of the message box.
     \param parent An optional parameter.
@@ -596,7 +608,8 @@
 }
 
 /*!
-    Shows a message box and returns immediately without waiting for it to close. Closing of the
+    Shows a message box and returns immediately without waiting for it to close. A new message box
+    is launched each time show() is called. Closing of the
     message box is indicated by aboutToClose() signal. Button presses are indicated by
     QAction::triggered() signals. The message box can be updated while showing by property
     setters.