|
1 /* |
|
2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of the License "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 #ifndef M_VCXNSAPPCATEGORYPROVIDERIF_H |
|
22 #define M_VCXNSAPPCATEGORYPROVIDERIF_H |
|
23 |
|
24 // INCLUDES |
|
25 #include <e32base.h> |
|
26 |
|
27 // CLASS DECLARATION |
|
28 class MVcxNsCategoryProviderObserver; |
|
29 class CVcxNsCategory; |
|
30 |
|
31 /** |
|
32 * Class MVcxNsCategoryProviderIf |
|
33 * Interface for using UI engine's category provider |
|
34 * |
|
35 * @lib vcxnsuiengine.lib |
|
36 */ |
|
37 class MVcxNsCategoryProviderIf |
|
38 { |
|
39 |
|
40 public: |
|
41 |
|
42 /** |
|
43 * RegisterObserver. |
|
44 * @param aObserver Observer |
|
45 */ |
|
46 virtual void RegisterObserver( MVcxNsCategoryProviderObserver* aObserver ) = 0; |
|
47 |
|
48 /** |
|
49 * DeRegisterObserver. |
|
50 * @param aObserver Observer |
|
51 */ |
|
52 virtual void DeRegisterObserver( MVcxNsCategoryProviderObserver* aObserver ) = 0; |
|
53 |
|
54 /** |
|
55 * Get categories for active service. |
|
56 * @param aHighlight On return, hightlight index for category list. |
|
57 * @return Category array. Ownership of categories remains in ui engine. |
|
58 */ |
|
59 virtual RPointerArray<CVcxNsCategory>& GetCategoriesL( TInt& aHighlight ) = 0; |
|
60 |
|
61 /** |
|
62 * Get categories for active service. |
|
63 * @return Vod categorys. |
|
64 */ |
|
65 virtual RPointerArray<CVcxNsCategory>& GetCategorysL() = 0; |
|
66 |
|
67 /** |
|
68 * Opens selected category. |
|
69 * |
|
70 * @param aIndex Index of the category to be opened. |
|
71 */ |
|
72 virtual void OpenCategoryL( TInt aIndex ) = 0 ; |
|
73 |
|
74 /** |
|
75 * Return pointer to active category data |
|
76 * @return Pointer to active category data. |
|
77 * NULL returned, if category data not found |
|
78 */ |
|
79 virtual CVcxNsCategory* GetActiveCategoryDataL() = 0; |
|
80 |
|
81 /** |
|
82 * Return specified category data. |
|
83 * @param aServiceId Service Id |
|
84 * @param aCategoryId Category Id |
|
85 * @return Pointer to category data. |
|
86 * NULL returned, if specified category data not found |
|
87 */ |
|
88 virtual CVcxNsCategory* GetCategoryDataL( TUint32 aServiceId, TUint32 aCategoryId ) = 0; |
|
89 |
|
90 /** |
|
91 * Starts the category update. |
|
92 * |
|
93 * @return KErrNone or one of the system wide error codes. |
|
94 */ |
|
95 virtual TInt RefreshCategorysL() = 0; |
|
96 |
|
97 /** |
|
98 * Save category highlight. |
|
99 * @param aHighlight Highlight index to save. |
|
100 */ |
|
101 virtual void SetCategoryHighlight( TInt aHighlight ) = 0; |
|
102 |
|
103 }; |
|
104 |
|
105 #endif // MVCXNSAPPCATEGORYPROVIDERIF_H |