gsprofilesrv_plat/ftuwizardmodel_api/inc/ftuwizard.h
changeset 21 851e19007849
parent 18 e3554c9069b6
child 23 7e4c5a2ff1a2
child 37 940f6b67827d
equal deleted inserted replaced
19:30540fccecae 21:851e19007849
    13 *
    13 *
    14 * Description:  FtuWizard class definition
    14 * Description:  FtuWizard class definition
    15 *
    15 *
    16 */
    16 */
    17 
    17 
       
    18 
    18 #ifndef FTUWIZARD_H
    19 #ifndef FTUWIZARD_H
    19 #define FTUWIZARD_H
    20 #define FTUWIZARD_H
    20 
    21 
    21 #include "ftuwizardmodellib.h"
    22 #include "ftuwizardmodellib.h"
    22 
    23 
    23 #include <QFileInfo>
    24 #include <QFileInfo>
    24 #include <QObject>
    25 #include <QObject>
    25 #include <QRectF>
    26 #include <QRectF>
    26 #include <QDate>
    27 #include <QDate>
       
    28 #include <hbmenu>
    27 
    29 
    28 class QGraphicsWidget;
    30 class QGraphicsWidget;
    29    
    31 
    30 /**
    32 /**
    31  * @ingroup group_ftuwizardmodel
    33  * @ingroup group_ftuwizardmodel
    32  * @brief Represents a wizard plugin visualization information.
    34  * @brief Represents a wizard plugin visualization information.
    33  *
    35  *
    34  * FtuWizardSetting struct contains the information needed to construct the GUI in
    36  * FtuWizardSetting struct contains the information needed to construct the GUI in
   105      * Called by the FTU fw during initialize cycle of the wizard, it is during
   107      * Called by the FTU fw during initialize cycle of the wizard, it is during
   106      * this phase the wizard widget
   108      * this phase the wizard widget
   107      * usually creates its initial view.
   109      * usually creates its initial view.
   108      * Once the initialization is done, wizardInitialized signal must be 
   110      * Once the initialization is done, wizardInitialized signal must be 
   109      * emitted.
   111      * emitted.
   110      * @since S60 ?S60_version.
   112 	 * @param cenrepOwnerId Id of the owner of Cenrep holding wizard completion Information.
   111      */
   113 	 * @param wizardIdx Index of the Cenrep key for a wizard.
   112     virtual void initializeWizard() = 0;
   114 	 * If wizard is invoking another application, it should provide cenrepOwnerId and wizardIdx
       
   115 	 * to the application. Application should write 1 into the wizardIdx cenrep on completion.
       
   116      * @since S60 ?S60_version.
       
   117      */
       
   118     virtual void initializeWizard(qint32 cenrepOwnerId, int wizardIdx) = 0;
   113 
   119 
   114     /**
   120     /**
   115      * Called by the FTU fw when the wizard becomes the current wizard.  
   121      * Called by the FTU fw when the wizard becomes the current wizard.  
   116      * @since S60 ?S60_version.
   122      * @since S60 ?S60_version.
   117      */
   123      */
   238      * Note that this signal does not need to be emitted if true is returned
   244      * Note that this signal does not need to be emitted if true is returned
   239      * from shutdownWizard.
   245      * from shutdownWizard.
   240      * @param caller The calling wizard plugin instance.
   246      * @param caller The calling wizard plugin instance.
   241      */
   247      */
   242     void shutdownCompleted(FtuWizard *caller);
   248     void shutdownCompleted(FtuWizard *caller);
   243 
   249     
       
   250     /**
       
   251      * Emit this signal to indicate that the wizard plugin wants a custom view menu to be shown. 
       
   252      * from shutdownWizard.
       
   253      * @param caller The calling wizard plugin instance.
       
   254      * @param menu   The HbMenu instance that needs to be shown on the view
       
   255      */
       
   256     void updateMainMenu(FtuWizard *caller, HbMenu * menu);
       
   257     
   244 };
   258 };
   245 
   259 
   246 #endif // FTUWIZARD_H
   260 #endif // FTUWIZARD_H
   247 
   261