src/hbwidgets/devicedialogs/hbdevicemessageboxsymbian.cpp
changeset 28 b7da29130b0e
parent 23 e6ad4ef83b23
child 30 80e4d18b72f5
equal deleted inserted replaced
23:e6ad4ef83b23 28:b7da29130b0e
   545 {
   545 {
   546     aBox->SetPropertyValue(CHbDeviceMessageBoxPrivate::EShowLevel, aLevel);
   546     aBox->SetPropertyValue(CHbDeviceMessageBoxPrivate::EShowLevel, aLevel);
   547 }
   547 }
   548 
   548 
   549 /*!
   549 /*!
       
   550     @stable
       
   551     @hbwidgets
       
   552 
   550     \class CHbDeviceMessageBoxSymbian
   553     \class CHbDeviceMessageBoxSymbian
   551     \brief CHbDeviceMessageBoxSymbian is a Symbian implementation of HbDeviceMessageBox.
   554     \brief CHbDeviceMessageBoxSymbian is a Symbian implementation of HbDeviceMessageBox.
       
   555 
       
   556     <b>This class is Symbian only. Not available on other platforms.</b>
   552 
   557 
   553     CHbDeviceMessageBoxSymbian is intended for use by servers that don't run Qt event loop
   558     CHbDeviceMessageBoxSymbian is intended for use by servers that don't run Qt event loop
   554     and cannot use HbDeviceMessageBox.
   559     and cannot use HbDeviceMessageBox.
   555 
   560 
   556     It displays a message box with text, icon or animation and two optional buttons,
   561     It displays a message box with text, icon or animation and two optional buttons,
   577         <tr><td>EInformation</td><td>Info icon</td><td>"Ok" button</td><td>Standard timeout</td><td>Tap anywhere</td><td>Info sound</td></tr>
   582         <tr><td>EInformation</td><td>Info icon</td><td>"Ok" button</td><td>Standard timeout</td><td>Tap anywhere</td><td>Info sound</td></tr>
   578         <tr><td>EWarning</td><td>Warning icon</td><td>"Ok" button</td><td>Standard timeout</td><td>Tap anywhere</td><td>Warn sound</td></tr>
   583         <tr><td>EWarning</td><td>Warning icon</td><td>"Ok" button</td><td>Standard timeout</td><td>Tap anywhere</td><td>Warn sound</td></tr>
   579         <tr><td>EQuestion</td><td>Question icon</td><td>"Yes" and "No" buttons</td><td>No timeout</td><td>Button press</td><td>Question sound</td></tr>
   584         <tr><td>EQuestion</td><td>Question icon</td><td>"Yes" and "No" buttons</td><td>No timeout</td><td>Button press</td><td>Question sound</td></tr>
   580     </table>
   585     </table>
   581 
   586 
   582     ShowL() displays a message box asynchronously. The function returns immediately. The launched
   587     ShowL() displays a message box asynchronously. The function returns immediately.
       
   588     A new message box is lauched every time ShowL() is called. The launched
   583     dialog can be updated by setters and then calling UpdateL(). Closing can be observed by a
   589     dialog can be updated by setters and then calling UpdateL(). Closing can be observed by a
   584     callback. Because each UpdateL() after the ShowL() requires interprocess communication,
   590     callback. Because each UpdateL() after the ShowL() requires interprocess communication,
   585     it's advisable to fully construct the device message box before displaying it.
   591     it's advisable to fully construct the device message box before displaying it.
   586 
   592 
   587     A device message box is launched synchronously by ExecL() function. The function returns when
   593     A device message box is launched synchronously by ExecL() function. The function returns when
   597 
   603 
   598     Static convenience functions are provided for ease of use. Message boxes created by these
   604     Static convenience functions are provided for ease of use. Message boxes created by these
   599     static functions contain a default set of properties depending on the message box type and their
   605     static functions contain a default set of properties depending on the message box type and their
   600     contents cannot be updated while the message box executes.
   606     contents cannot be updated while the message box executes.
   601 
   607 
   602     Supported icon animation formats are following:
   608     If CHbDeviceMessageBoxSymbian has no observer set, the object can be deleted after
       
   609     ShowL() has been called and device-dialog service takes care showing the message box. If
       
   610     observer is set, message box is closed when CHbDeviceMessageBoxSymbian object goes out of
       
   611     scope.  
       
   612 
       
   613     An animation can replace an icon on device message box. Supported icon animation formats are
       
   614     following:
       
   615 
   603     - GIF (.gif)
   616     - GIF (.gif)
   604     - MNG (.mng)
   617     - MNG (.mng)
   605         - Frame animations
   618         - Frame animations
   606 
   619 
   607     Sample code:
   620     Sample code:
   678     iMessageBox->SetIconNameL(KIconName);
   691     iMessageBox->SetIconNameL(KIconName);
   679     iMessageBox->ShowL();
   692     iMessageBox->ShowL();
   680     \endcode
   693     \endcode
   681 
   694 
   682     \sa HbDeviceMessageBox, HbMessageBox, MHbDeviceMessageBoxObserver
   695     \sa HbDeviceMessageBox, HbMessageBox, MHbDeviceMessageBoxObserver
   683 
       
   684     @stable
       
   685     @hbwidgets
       
   686 */
   696 */
   687 
   697 
   688 /*!
   698 /*!
   689     \enum CHbDeviceMessageBoxSymbian::TType
   699     \enum CHbDeviceMessageBoxSymbian::TType
   690     Message box type. Determines a set of default properties for the message box.
   700     Message box type. Determines a set of default properties for the message box.