gsprofilesrv_plat/ftuwizardmodel_api/inc/ftuwizard.h
changeset 62 531951b2e59a
parent 39 c044bc2ea8f7
equal deleted inserted replaced
55:4c15d9aa2384 62:531951b2e59a
    55     QFileInfo mTocFocussedIcon;
    55     QFileInfo mTocFocussedIcon;
    56     /**
    56     /**
    57      * The text to be shown in table of contents UI component.
    57      * The text to be shown in table of contents UI component.
    58      */ 
    58      */ 
    59     QString   mTocLabel;
    59     QString   mTocLabel;
       
    60     
       
    61     /**
       
    62      * Secondary text to be shown in table of contents UI component.
       
    63      */ 
       
    64     QString   mTocSecondaryLabel;
       
    65         
    60 	 /**
    66 	 /**
    61      * Informs Framework whether a plugin is having any ftu view or not.
    67      * Informs Framework whether a plugin is having any ftu view or not.
    62 	 * It should be set to false by plugin if it has any FTU view to be shown 
    68 	 * It should be set to false by plugin if it has any FTU view to be shown 
    63 	 * when the plugin is activated. It should be set to true if plugin 
    69 	 * when the plugin is activated. It should be set to true if plugin 
    64 	 * is invoking any service/wizard, when plugin is selected/activated. 
    70 	 * is invoking any service/wizard, when plugin is selected/activated. 
   102      * emitted.
   108      * emitted.
   103 	 * @param cenrepOwnerId Id of the owner of Cenrep holding wizard completion Information.
   109 	 * @param cenrepOwnerId Id of the owner of Cenrep holding wizard completion Information.
   104 	 * @param wizardIdx Index of the Cenrep key for a wizard.
   110 	 * @param wizardIdx Index of the Cenrep key for a wizard.
   105 	 * If wizard is invoking another application, it should provide cenrepOwnerId and wizardIdx
   111 	 * If wizard is invoking another application, it should provide cenrepOwnerId and wizardIdx
   106 	 * to the application. Application should write 1 into the wizardIdx cenrep on completion.
   112 	 * to the application. Application should write 1 into the wizardIdx cenrep on completion.
   107      * @since S60 ?S60_version.
       
   108      */
   113      */
   109     virtual void initializeWizard(qint32 cenrepOwnerId, int wizardIdx) = 0;
   114     virtual void initializeWizard(qint32 cenrepOwnerId, int wizardIdx) = 0;
   110 
   115 
   111     /**
   116     /**
   112      * Called by the FTU fw when the wizard becomes the current wizard.  
   117      * Called by the FTU fw when the wizard becomes the current wizard.  
   236      * Emit this signal to indicate that the wizard plugin wants to be deactivated. 
   241      * Emit this signal to indicate that the wizard plugin wants to be deactivated. 
   237      * Wizard is deactivated and Table of Contents is shown by the application.
   242      * Wizard is deactivated and Table of Contents is shown by the application.
   238      * @param caller The calling wizard plugin instance.
   243      * @param caller The calling wizard plugin instance.
   239      */
   244      */
   240     void wizardDeactivated(FtuWizard *caller);
   245     void wizardDeactivated(FtuWizard *caller);
   241     
   246 	
       
   247     /**
       
   248      * Emit this signal to update the text/icons of the widget.
       
   249      * FTU framework reads settings through wizardSettings()and 
       
   250      * displays accordingly. It should be ensured by plugin/wizard
       
   251      * that the modified settings are reflected through wizardSettings().
       
   252      * @param caller The calling wizard plugin instance.
       
   253      */
       
   254     void wizardSettingsChanged(FtuWizard *caller);    
   242 };
   255 };
   243 
   256 
   244 #endif // FTUWIZARD_H
   257 #endif // FTUWIZARD_H
   245 
   258