38 * per page will exceed |
38 * per page will exceed |
39 */ |
39 */ |
40 const TInt KHsErrorMaxInstanceCountExceeded = -87002; |
40 const TInt KHsErrorMaxInstanceCountExceeded = -87002; |
41 |
41 |
42 /** |
42 /** |
43 * unable to add widget because widget is too large to fit. |
43 * Unable to add widget because widget is too large to fit. |
44 * A smaller widget might fit though. |
44 * A smaller widget might fit though. |
45 */ |
45 */ |
46 const TInt KHsErrorDoesNotFit = -87003; |
46 const TInt KHsErrorDoesNotFit = -87003; |
47 |
47 |
48 |
48 |
49 |
49 |
50 /** |
50 /** |
51 * Content controller interface |
51 * Content controller interface defining the interface to modify |
|
52 * Home screen content. |
52 * |
53 * |
53 * |
54 * @since S60 v5.2 |
54 * @code |
|
55 * |
|
56 * @endcode |
|
57 * |
|
58 * @lib hscontentcontrol.lib |
|
59 * @since S60 v5.0 |
|
60 */ |
55 */ |
61 class MHsContentController |
56 class MHsContentController |
62 { |
57 { |
63 public: |
58 public: |
64 /** |
59 /** |
65 * Returns the list of available Home screen widgets |
60 * Returns the list of available Home screen widgets |
|
61 * |
|
62 * @since S60 v5.2 |
66 * @param aArray List of widgets |
63 * @param aArray List of widgets |
67 * @return KErrNone on success, any of system wide error codes |
64 * @return KErrNone on success, any of system wide error codes |
68 */ |
65 */ |
69 virtual TInt WidgetListL( CHsContentInfoArray& aArray ) = 0; |
66 virtual TInt WidgetListL( CHsContentInfoArray& aArray ) = 0; |
70 |
67 |
71 /** |
68 /** |
72 * Returns the list of Home screen widgets included in an application |
69 * Returns the list of Home screen widgets included in an application |
73 * configuration or a view |
70 * configuration or a view |
|
71 * |
|
72 * @since S60 v5.2 |
74 * @param aInfo Content info defining the application configuration |
73 * @param aInfo Content info defining the application configuration |
75 * or the view which widget list is requested |
74 * or the view which widget list is requested |
76 * @param aArray List of widgets |
75 * @param aArray List of widgets |
77 * @return KErrNone on success, any of system wide error codes |
76 * @return KErrNone on success, any of system wide error codes |
78 */ |
77 */ |
79 virtual TInt WidgetListL( CHsContentInfo& aInfo, CHsContentInfoArray& aArray ) = 0; |
78 virtual TInt WidgetListL( CHsContentInfo& aInfo, CHsContentInfoArray& aArray ) = 0; |
80 |
79 |
81 /** |
80 /** |
82 * Returns the list of available Home screen views |
81 * Returns the list of available Home screen views |
|
82 * |
|
83 * @since S60 v5.2 |
83 * @param aArray List of views |
84 * @param aArray List of views |
84 * @return KErrNone on success, any of system wide error codes |
85 * @return KErrNone on success, any of system wide error codes |
85 */ |
86 */ |
86 virtual TInt ViewListL( CHsContentInfoArray& aArray ) = 0; |
87 virtual TInt ViewListL( CHsContentInfoArray& aArray ) = 0; |
87 |
88 |
88 /** |
89 /** |
89 * Returns the list of available Home screen views included in an |
90 * Returns the list of available Home screen views included in an |
90 * application configuration |
91 * application configuration |
|
92 * |
|
93 * @since S60 v5.2 |
91 * @param aInfo Content info defining the application configuration |
94 * @param aInfo Content info defining the application configuration |
92 * @param aArray List of views |
95 * @param aArray List of views |
93 * @return KErrNone on success, any of system wide error codes |
96 * @return KErrNone on success, any of system wide error codes |
94 */ |
97 */ |
95 virtual TInt ViewListL( CHsContentInfo& aInfo, CHsContentInfoArray& aArray ) = 0; |
98 virtual TInt ViewListL( CHsContentInfo& aInfo, CHsContentInfoArray& aArray ) = 0; |
96 |
99 |
97 /** |
100 /** |
98 * Returns the list of available Home screen application configurations |
101 * Returns the list of available Home screen application configurations |
|
102 * |
|
103 * @since S60 v5.2 |
99 * @param aArray List of application configurations |
104 * @param aArray List of application configurations |
100 * @return KErrNone on success, any of system wide error codes |
105 * @return KErrNone on success, any of system wide error codes |
101 */ |
106 */ |
102 virtual TInt AppListL( CHsContentInfoArray& aArray ) = 0; |
107 virtual TInt AppListL( CHsContentInfoArray& aArray ) = 0; |
103 |
108 |
104 /** |
109 /** |
105 * Adds a widget to the active Home screen view. |
110 * Adds a widget to the active Home screen view. |
|
111 * |
|
112 * @since S60 v5.2 |
106 * @param aInfo Widget request to be added |
113 * @param aInfo Widget request to be added |
107 * @return KErrNone on success, any of system wide error codes, |
114 * @return KErrNone on success, any of system wide error codes, |
108 * KHsErrorViewFull, KHsErrorMaxInstanceCountExceeded or |
115 * KHsErrorViewFull, KHsErrorMaxInstanceCountExceeded or |
109 * KHsErrorDoesNotFit |
116 * KHsErrorDoesNotFit |
110 */ |
117 */ |
111 virtual TInt AddWidgetL( CHsContentInfo& aInfo ) = 0; |
118 virtual TInt AddWidgetL( CHsContentInfo& aInfo ) = 0; |
112 |
119 |
113 /** |
120 /** |
114 * Removes a widget from the configuration. |
121 * Removes a widget from the configuration. |
|
122 * |
|
123 * @since S60 v5.2 |
115 * @param aInfo Widget request to be removed |
124 * @param aInfo Widget request to be removed |
116 * @return KErrNone on success, any of system wide error codes |
125 * @return KErrNone on success, any of system wide error codes |
117 */ |
126 */ |
118 virtual TInt RemoveWidgetL( CHsContentInfo& aInfo ) = 0; |
127 virtual TInt RemoveWidgetL( CHsContentInfo& aInfo ) = 0; |
119 |
128 |
120 /** |
129 /** |
121 * Adds a view to the active Home screen application configuration. |
130 * Adds a view to the active Home screen application configuration. |
|
131 * |
|
132 * @since S60 v5.2 |
122 * @param aInfo View request to be added |
133 * @param aInfo View request to be added |
123 * @return KErrNone on success, any of system wide error codes |
134 * @return KErrNone on success, any of system wide error codes |
124 */ |
135 */ |
125 virtual TInt AddViewL( CHsContentInfo& aInfo ) = 0; |
136 virtual TInt AddViewL( CHsContentInfo& aInfo ) = 0; |
126 |
137 |
127 /** |
138 /** |
128 * Removes a view from the configuration. |
139 * Removes a view from the configuration. |
|
140 * |
|
141 * @since S60 v5.2 |
129 * @param aInfo View request to be removed |
142 * @param aInfo View request to be removed |
130 * @return KErrNone on success, any of system wide error codes |
143 * @return KErrNone on success, any of system wide error codes |
131 */ |
144 */ |
132 virtual TInt RemoveViewL( CHsContentInfo& aInfo ) = 0; |
145 virtual TInt RemoveViewL( CHsContentInfo& aInfo ) = 0; |
133 |
146 |
134 /** |
147 /** |
135 * Activates the Home screen view |
148 * Activates the Home screen view |
|
149 * |
|
150 * @since S60 v5.2 |
136 * @param aInfo View request to be activated |
151 * @param aInfo View request to be activated |
137 * @return KErrNone on success, any of system wide error codes |
152 * @return KErrNone on success, any of system wide error codes |
138 */ |
153 */ |
139 virtual TInt ActivateViewL( CHsContentInfo& aInfo ) = 0; |
154 virtual TInt ActivateViewL( CHsContentInfo& aInfo ) = 0; |
140 |
155 |
141 /** |
156 /** |
142 * Activates the Home screen application configuration |
157 * Activates the Home screen application configuration |
|
158 * |
|
159 * @since S60 v5.2 |
143 * @param aInfo Application configuration request to be activated |
160 * @param aInfo Application configuration request to be activated |
144 * @return KErrNone on success, any of system wide error codes |
161 * @return KErrNone on success, any of system wide error codes |
145 */ |
162 */ |
146 virtual TInt ActivateAppL( CHsContentInfo& aInfo ) = 0; |
163 virtual TInt ActivateAppL( CHsContentInfo& aInfo ) = 0; |
147 |
164 |
148 /** |
165 /** |
149 * Returns the active Home screen view |
166 * Returns the active Home screen view |
|
167 * |
|
168 * @since S60 v5.2 |
150 * @param aInfo Active view |
169 * @param aInfo Active view |
151 * @return KErrNone on success, any of system wide error codes |
170 * @return KErrNone on success, any of system wide error codes |
152 */ |
171 */ |
153 virtual TInt ActiveViewL( CHsContentInfo& aInfo ) = 0; |
172 virtual TInt ActiveViewL( CHsContentInfo& aInfo ) = 0; |
154 |
173 |
155 /** |
174 /** |
156 * Returns the active Home screen application configuration |
175 * Returns the active Home screen application configuration |
|
176 * |
|
177 * @since S60 v5.2 |
157 * @param aInfo Active application configuration |
178 * @param aInfo Active application configuration |
158 * @return KErrNone on success, any of system wide error codes |
179 * @return KErrNone on success, any of system wide error codes |
159 */ |
180 */ |
160 virtual TInt ActiveAppL( CHsContentInfo& aInfo ) = 0; |
181 virtual TInt ActiveAppL( CHsContentInfo& aInfo ) = 0; |
161 |
182 |