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 "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: CMSParameterAgent class definition |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef C_MSPARAMETERAGENT_H |
|
20 #define C_MSPARAMETERAGENT_H |
|
21 |
|
22 // INCLUDES |
|
23 #include <e32base.h> |
|
24 #include "mediaservant.hrh" |
|
25 |
|
26 // template parameters |
|
27 struct TMSTemplate |
|
28 { |
|
29 TInt templateType; // mediatype |
|
30 TInt selectedTemplate; // selected template |
|
31 TBuf<KMaxFileName> templateName; // template name |
|
32 }; |
|
33 |
|
34 // FORWARD DECLARATIONS |
|
35 |
|
36 /** |
|
37 * CMSParameterAgent class. |
|
38 * |
|
39 * @since S60 5.1 |
|
40 */ |
|
41 NONSHARABLE_CLASS( CMSParameterAgent ): public CBase |
|
42 { |
|
43 |
|
44 public: |
|
45 |
|
46 /** |
|
47 * Constructor. |
|
48 */ |
|
49 CMSParameterAgent(); |
|
50 |
|
51 /** |
|
52 * Destructor. |
|
53 */ |
|
54 virtual ~CMSParameterAgent(); |
|
55 |
|
56 /** |
|
57 * Sets selected rule template |
|
58 * |
|
59 * @since S60 5.1 |
|
60 * @param aTemplate, selected template |
|
61 * @return None |
|
62 */ |
|
63 void SetRuleTemplate( TMSTemplate aTemplate ); |
|
64 |
|
65 /** |
|
66 * Returns selected rule template |
|
67 * |
|
68 * @since S60 5.1 |
|
69 * @return TMSRuleTemplate, selected template |
|
70 * @return None |
|
71 */ |
|
72 TMSTemplate GetRuleTemplate() const; |
|
73 |
|
74 /** |
|
75 * Sets selected index of main view |
|
76 * |
|
77 * @since S60 5.1 |
|
78 * @param aIndex, selected listbox item index |
|
79 * @return None |
|
80 */ |
|
81 void SetMainViewFocusIndex( TInt aIndex ); |
|
82 |
|
83 /** |
|
84 * Returns focus index of main view. |
|
85 * |
|
86 * @since S60 5.1 |
|
87 * @return TInt, focus index of main view |
|
88 * @return None |
|
89 */ |
|
90 TInt MainViewFocusIndex() const; |
|
91 |
|
92 /** |
|
93 * Sets selected index of fill view |
|
94 * |
|
95 * @since S60 5.1 |
|
96 * @param aIndex, selected listbox item index |
|
97 * @return None |
|
98 */ |
|
99 void SetFillViewFocusIndex( TInt aIndex ); |
|
100 |
|
101 /** |
|
102 * Returns focus index of fill view. |
|
103 * |
|
104 * @since S60 5.1 |
|
105 * @return TInt, focus index of fill view |
|
106 * @return None |
|
107 */ |
|
108 TInt FillViewFocusIndex() const; |
|
109 |
|
110 /** |
|
111 * Sets selected index of store view |
|
112 * |
|
113 * @since S60 5.1 |
|
114 * @param aIndex, selected listbox item index |
|
115 * @return None |
|
116 */ |
|
117 void SetStoreViewFocusIndex( TInt aIndex ); |
|
118 |
|
119 /** |
|
120 * Returns focus index of store view. |
|
121 * |
|
122 * @since S60 5.1 |
|
123 * @param None |
|
124 * @return TInt, focus index of store view |
|
125 */ |
|
126 TInt StoreViewFocusIndex() const; |
|
127 |
|
128 /** |
|
129 * Sets uid of current view |
|
130 * |
|
131 * @since S60 5.1 |
|
132 * @param aViewId, view id |
|
133 * @return None |
|
134 */ |
|
135 void SetPreviousViewId( TUid aViewId ); |
|
136 |
|
137 /** |
|
138 * Returns uid of previous view. |
|
139 * |
|
140 * @since S60 5.1 |
|
141 * @param None |
|
142 * @return TUid, focus index of previous view |
|
143 */ |
|
144 TUid PreviousViewId() const; |
|
145 |
|
146 /** |
|
147 * Sets browse target |
|
148 * |
|
149 * @since S60 5.1 |
|
150 * @param aBrowseTarget, browse target |
|
151 * @return None |
|
152 */ |
|
153 void SetBrowseTarget( TMSBrowseTarget aBrowseTarget ); |
|
154 |
|
155 /** |
|
156 * Gets browse target |
|
157 * |
|
158 * @since S60 5.1 |
|
159 * @param None |
|
160 * @return TMSBrowseTarget, browse target |
|
161 */ |
|
162 TMSBrowseTarget GetBrowseTarget() const; |
|
163 |
|
164 private: |
|
165 |
|
166 /** |
|
167 * previous view focus index |
|
168 */ |
|
169 TInt iPreviousFocusIndex; |
|
170 /** |
|
171 * previous view focus index |
|
172 */ |
|
173 TUid iPreviousViewId; |
|
174 /** |
|
175 * selected template |
|
176 */ |
|
177 TMSTemplate iTemplate; |
|
178 /** |
|
179 * Browse target |
|
180 */ |
|
181 TMSBrowseTarget iBrowseTarget; |
|
182 /** |
|
183 * Main view focus index |
|
184 */ |
|
185 TInt iMainViewFocusIndex; |
|
186 /** |
|
187 * Fill view focus index |
|
188 */ |
|
189 TInt iFillViewFocusIndex; |
|
190 /** |
|
191 * Store view focus index |
|
192 */ |
|
193 TInt iStoreViewFocusIndex; |
|
194 }; |
|
195 |
|
196 #endif // C_MSPARAMETERAGENT_H |
|
197 |
|
198 |
|
199 // End of File |
|