66     Device dialog widget can be derived from existing Hb class, eg. HbDialog or constructed from

    67     a docml using HbDocumentLoader. Structure of the plugin differs depending on which approach

    68     is selected. If docml is used the dialog widget cannot be multiple inherited from HbDialog

    69     and HbDeviceDialogInterface. In this case a container can be used to to create and manage the

    70     widget. See code example at the end.

    71 

   114     The example below is <b>not using docml</b> and dialog widget is derived from HbDialog and

   115     HbDeviceDialogInterface.

   196     The example below is <b>using docml</b> and dialog widget is managed by a container.

   197     \code

   198     class HbSampleDialogContainer : public QObject, public HbDeviceDialogInterface

   199     {

   200         Q_OBJECT

   201     \endcode

   202     - In the constructor create the dialog widget using HbDocumentLoader

   203     - Implement HbDeviceDialogInterface functions

   204       - From deviceDialogWidget() function return the created (docml) widget

   205       - From signalSender() function return the container (HbSampleDialogContainer)

   206     - Declare and emit deviceDialogClosed and optionally deviceDialogData signals.

   207     - Do not call show(), hide() or setVisible() in the plugin. Device dialog

   208       framework calls show() to display the widget.

   209     \code

   210     public:

   211         bool setDeviceDialogParameters(const QVariantMap &parameters);

   212         int deviceDialogError() const;

   213         void closeDeviceDialog(bool byClient);

   214         HbPopup *deviceDialogWidget() const;

   215         QObject *signalSender() const;

   216     signals:

   217         void deviceDialogClosed();

   218         void deviceDialogData(QVariantMap data);

   219     \endcode

   220     - Wrap the widget into a plugin derived from HbDeviceDialogPlugin

   221     \code

   222     class HbSampleDeviceDialogPlugin : public HbDeviceDialogPlugin

   223     {

   224         Q_OBJECT

   225     \endcode

   226     - Implement HbDeviceDialogPlugin pure virtual functions

   227       - Return the container (HbSampleDialogContainer) from createDeviceDialog() function

   228     \code

   229         bool accessAllowed(const QString &deviceDialogType,

   230             const QVariantMap &parameters, const QVariantMap &securityInfo) const;

   231         HbDeviceDialogInterface *createDeviceDialog(const QString &deviceDialogType, const QVariantMap &parameters);

   232         bool deviceDialogInfo(const QString &deviceDialogType,

   233             const QVariantMap &parameters, DeviceDialogInfo *info) const;

   234         QStringList deviceDialogTypes() const;

   235         PluginFlags pluginFlags() const;

   236         int error() const;

   237     \endcode

   238 

   239     <b> Class diagram of the sample plugin using docml:</b>

   240     \dot

   241     digraph G {

   242         rankdir=LR;

   243 

   244         subgraph cluster_class_diagram {

   245             style=solid;

   246 

   247             node [shape = box, style=solid, fontsize = 10];

   248             HbSampleDeviceDialogPlugin [label = "HbSampleDeviceDialogPlugin"];

   249             QObject [label = "QObject"];

   250             HbDeviceDialogPluginInterface [label = "HbDeviceDialogPluginInterface"];

   251             HbDeviceDialogPlugin [label = "HbDeviceDialogPlugin"];

   252             edge [fontsize = 10, style = filled];

   253             QObject -> HbDeviceDialogPlugin [label = "is a"];

   254             HbDeviceDialogPluginInterface -> HbDeviceDialogPlugin [label = "is a"];

   255             HbDeviceDialogPlugin -> HbSampleDeviceDialogPlugin [label = "is a"];

   256 

   257             HbSampleDialogContainer [label = "HbSampleDialogContainer"];

   258             QObject2 [label = "QObject"];

   259             HbDeviceDialogInterface [label = "HbDeviceDialogInterface"];

   260             QObject2 -> HbSampleDialogContainer [label = "is a"];

   261             HbDeviceDialogInterface -> HbSampleDialogContainer [label = "is a"];

   262 

   263             edge [fontsize = 10, style = dotted];

   264             HbSampleDeviceDialogPlugin -> HbSampleDialogContainer [label = "creates"];

   265 

   266             DialogWidget [label = "Dialog widget (docml)"];

   267             edge [fontsize = 10, style = dotted];

   268             HbSampleDialogContainer -> DialogWidget [label = "creates"];

   269         }

   270 

   271         subgraph cluster_key {

   272             label = "Key";

   273             style=solid;

   274             node [shape = box, style=solid, fontsize = 10];

   275             Class1 [label = "Class"];

   276             Class2 [label = "Class"];

   277             Class3 [label = "Class"];

   278 

   279             edge [fontsize = 10, style = filled];

   280             Class2 -> Class1 [label = "generalization"];

   281             edge [fontsize = 10, style = dotted];

   282             Class3 -> Class1 [label = "dependency"];

   283             }

   284     }

   285     \enddot

   286 

   370 */

   371 /*!

   372     \var HbDeviceDialogPlugin::DeviceDialogFlag HbDeviceDialogPlugin::ReceiveIndicatorStatus

   373     Indicates that the device dialog is interested in indicator activation/deactivation events.

   374     To receive indicator status the dialog has to implement two slots. Indicator activation is

   375     received by a slot indicatorActivated(HbIndicatorInterface*) and deactivation by a slot

   376     indicatorDeactivated(HbIndicatorInterface*).