src/hbcore/devicedialogbase/hbdevicedialogplugin.cpp
changeset 23 e6ad4ef83b23
parent 21 4633027730f5
child 28 b7da29130b0e
--- a/src/hbcore/devicedialogbase/hbdevicedialogplugin.cpp	Wed Aug 18 10:05:37 2010 +0300
+++ b/src/hbcore/devicedialogbase/hbdevicedialogplugin.cpp	Thu Sep 02 20:44:51 2010 +0300
@@ -48,9 +48,9 @@
     numbers in type strings. It performs string comparison of the whole string when searching
     for a plugin.
 
-    Device dialogs are divided into five groups: generic, notification, indicator-menu, security
-    and critical groups. The group dictates how and when a dialog is shown. Generic and
-    notification dialogs are intended for application use. Indicator, security and critical dialogs are
+    Device dialogs are divided into four groups: generic, notification, indicator-menu and security
+    groups. The group dictates how and when a dialog is shown. Generic and
+    notification dialogs are intended for application use. Indicator and security dialogs are
     for platform. Each dialog indicates which group it belongs to. The group need not be fixed.
     It may change depending on create parameters.
 
@@ -316,7 +316,7 @@
     Defines device dialog groups. Each of these groups have different rules for showing
     device dialogs.
 
-    \sa deviceDialogInfo DeviceDialogInfo
+    \sa deviceDialogInfo() DeviceDialogInfo
 */
 /*!
     \var HbDeviceDialogPlugin::DeviceDialogGroup HbDeviceDialogPlugin::GenericDeviceDialogGroup
@@ -338,6 +338,29 @@
     \var HbDeviceDialogPlugin::DeviceDialogGroup HbDeviceDialogPlugin::CriticalGroup
     High priority dialogs shown on top other dialogs. Only platform device dialogs may
     belong to this group.
+
+    \deprecated HbDeviceDialogPlugin::CriticalGroup
+    is deprecated. Instead use HbDeviceDialogPlugin::GenericDeviceDialogGroup and set
+    HbDeviceDialogPlugin::CriticalLayer. 
+*/
+
+/*!
+    \enum HbDeviceDialogPlugin::ShowLevel
+    Defines a level (z-value) a device dialog is shown.
+
+    \sa deviceDialogInfo() DeviceDialogInfo
+*/
+/*!
+    \var HbDeviceDialogPlugin::ShowLevel HbDeviceDialogPlugin::NormalLevel
+    A default value to be used by applications.
+*/
+/*!
+    \var HbDeviceDialogPlugin::ShowLevel HbDeviceDialogPlugin::SecurityLevel
+    Reserved for platform use. Dialog is shown on top of normal dialogs.
+*/
+/*!
+    \var HbDeviceDialogPlugin::ShowLevel HbDeviceDialogPlugin::CriticalLevel
+    Reserved for platform use. Dialog is shown on top of security level dialogs.
 */
 
 /*!
@@ -380,6 +403,9 @@
 /*!
     \var HbDeviceDialogPlugin::DefaultPriority
     Default priority value to return in DeviceDialogInfo.
+
+    \deprecated HbDeviceDialogPlugin::DefaultPriority
+    is deprecated. Will be removed.
 */
 
 /*!
@@ -403,6 +429,13 @@
     <em>For future needs. Not used</em>.
     Device dialog display priority. Determines queuing order of dialogs. Fill with
     HbDeviceDialogPlugin::DefaultPriority.
+
+    \deprecated HbDeviceDialogPlugin::DeviceDialogInfo::priority
+    is deprecated. Will be removed.
+*/
+/*!
+    \var HbDeviceDialogPlugin::DeviceDialogInfo::showLevel
+    Level (z-value) the device dialog widget is shown. HbDeviceDialogPlugin::ShowLevel.
 */
 /*!
     \var HbDeviceDialogPlugin::DeviceDialogInfo::spare