homescreensrv_plat/hs_content_control_api/inc/hscontentcontroller.h
branchRCL_3
changeset 18 bd874ee5e5e2
parent 2 b7904b40483f
child 64 b276298d5729
equal deleted inserted replaced
9:d0529222e3f0 18:bd874ee5e5e2
    60  */
    60  */
    61 class MHsContentController
    61 class MHsContentController
    62     {
    62     {
    63 public:
    63 public:
    64     /**
    64     /**
    65      * Fills an array of CHsContentInfo. Both widget and template types are appended.
    65      * Returns the list of available Home screen widgets
    66      * @param aArray Array of CHsContentInfo
    66      * @param aArray List of widgets
       
    67      * @return KErrNone on success, any of system wide error codes
    67      */
    68      */
    68     virtual TInt WidgetListL( CHsContentInfoArray& aArray ) = 0;
    69     virtual TInt WidgetListL( CHsContentInfoArray& aArray ) = 0;
    69 
    70 
    70     /**
    71     /**
    71      * Fills an array of CHsContentInfo. View types are appended.
    72      * Returns the list of Home screen widgets included in an application 
    72      * @param aArray Array of CHsContentInfo
    73      * configuration or a view
       
    74      * @param aInfo Content info defining the application configuration 
       
    75      *              or the view which widget list is requested
       
    76      * @param aArray List of widgets
       
    77      * @return KErrNone on success, any of system wide error codes
       
    78      */
       
    79     virtual TInt WidgetListL( CHsContentInfo& aInfo, CHsContentInfoArray& aArray ) = 0;
       
    80 
       
    81     /**
       
    82      * Returns the list of available Home screen views
       
    83      * @param aArray List of views
       
    84      * @return KErrNone on success, any of system wide error codes
    73      */
    85      */
    74     virtual TInt ViewListL( CHsContentInfoArray& aArray ) = 0;
    86     virtual TInt ViewListL( CHsContentInfoArray& aArray ) = 0;
    75 
    87 
    76     /**
    88     /**
    77      *
    89      * Returns the list of available Home screen application configurations
       
    90      * @param aArray List of application configurations
       
    91      * @return KErrNone on success, any of system wide error codes
    78      */
    92      */
    79     virtual TInt AppListL( CHsContentInfoArray& aArray ) = 0;
    93     virtual TInt AppListL( CHsContentInfoArray& aArray ) = 0;
    80 
    94 
    81     /**
    95     /**
    82      * Adds a widget to the active view.
    96      * Adds a widget to the active Home screen view.
    83      * @param aInfo Content info object
    97      * @param aInfo Widget request to be added
    84      * @return KErrNone on success, any of system wide error codes,
    98      * @return KErrNone on success, any of system wide error codes,
    85      *         KHsErrorViewFull, KHsErrorMaxInstanceCountExceeded or
    99      *         KHsErrorViewFull, KHsErrorMaxInstanceCountExceeded or
    86      *         KHsErrorDoesNotFit
   100      *         KHsErrorDoesNotFit
    87      */
   101      */
    88     virtual TInt AddWidgetL( CHsContentInfo& aInfo ) = 0;
   102     virtual TInt AddWidgetL( CHsContentInfo& aInfo ) = 0;
    89 
   103 
    90     /**
   104     /**
    91      * Removes a widget from the configuration.
   105      * Removes a widget from the configuration.
    92      * @param aInfo Content info object
   106      * @param aInfo Widget request to be removed
       
   107      * @return KErrNone on success, any of system wide error codes
    93      */
   108      */
    94     virtual TInt RemoveWidgetL( CHsContentInfo& aInfo ) = 0;
   109     virtual TInt RemoveWidgetL( CHsContentInfo& aInfo ) = 0;
    95 
   110 
    96     /**
   111     /**
    97      *
   112      * Adds a view to the active Home screen application configuration.
       
   113      * @param aInfo View request to be added
       
   114      * @return KErrNone on success, any of system wide error codes
    98      */
   115      */
    99     virtual TInt AddViewL( CHsContentInfo& aInfo ) = 0;
   116     virtual TInt AddViewL( CHsContentInfo& aInfo ) = 0;
   100 
   117 
   101     /**
   118     /**
   102      *
   119      * Removes a view from the configuration.
       
   120      * @param aInfo View request to be removed
       
   121      * @return KErrNone on success, any of system wide error codes
   103      */
   122      */
   104     virtual TInt RemoveViewL( CHsContentInfo& aInfo ) = 0;
   123     virtual TInt RemoveViewL( CHsContentInfo& aInfo ) = 0;
   105 
   124 
   106     /**
   125     /**
   107      *
   126      * Activates the Home screen view
       
   127      * @param aInfo View request to be activated
       
   128      * @return KErrNone on success, any of system wide error codes
   108      */
   129      */
   109     virtual TInt ActivateViewL( CHsContentInfo& aInfo ) = 0;
   130     virtual TInt ActivateViewL( CHsContentInfo& aInfo ) = 0;
   110 
   131 
   111     /**
   132     /**
   112      *
   133      * Activates the Home screen application configuration
       
   134      * @param aInfo Application configuration request to be activated
       
   135      * @return KErrNone on success, any of system wide error codes
   113      */
   136      */
   114     virtual TInt ActivateAppL( CHsContentInfo& aInfo ) = 0;
   137     virtual TInt ActivateAppL( CHsContentInfo& aInfo ) = 0;
   115 
   138 
   116     /**
   139     /**
   117      *
   140      * Returns the active Home screen view
       
   141      * @param aInfo Active view
       
   142      * @return KErrNone on success, any of system wide error codes
   118      */
   143      */
   119     virtual TInt ActiveViewL( CHsContentInfo& aInfo ) = 0;
   144     virtual TInt ActiveViewL( CHsContentInfo& aInfo ) = 0;
   120 
   145 
   121     /**
   146     /**
   122      *
   147      * Returns the active Home screen application configuration
       
   148      * @param aInfo Active application configuration
       
   149      * @return KErrNone on success, any of system wide error codes
   123      */
   150      */
   124     virtual TInt ActiveAppL( CHsContentInfo& aInfo ) = 0;
   151     virtual TInt ActiveAppL( CHsContentInfo& aInfo ) = 0;
   125 
   152 
   126     };
   153     };
   127 
   154