|
1 /* |
|
2 * Copyright (c) 2005 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: Input Parameters to the Settings UI. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef C_LOCSETTINGSUIPARAMS_H_ |
|
20 #define C_LOCSETTINGSUIPARAMS_H_ |
|
21 |
|
22 // System Include |
|
23 #include <e32base.h> |
|
24 |
|
25 // Forward Declarations |
|
26 class MLocSettingsUiObserver; |
|
27 class CAknViewAppUi; |
|
28 |
|
29 // Class Defintions |
|
30 |
|
31 /** |
|
32 * Input Parameters to the Settings UI. |
|
33 * |
|
34 * The parameters are passed through the E-Comm frameworks Create function. |
|
35 * The E-Comm framework is not expected to understand the parameters, it |
|
36 * passes on the same to the creation funtion of the actual implementation. |
|
37 * The ownership of the object is vested with the class that calls the |
|
38 * creation function |
|
39 * |
|
40 * @lib locsysuiview.lib |
|
41 * @since S60 v3.1 |
|
42 */ |
|
43 class CLocSettingsUiParams : public CBase |
|
44 { |
|
45 public: |
|
46 /** |
|
47 * Creates the Settings Parameters. |
|
48 * |
|
49 * @param aObserver Settings UI Observer |
|
50 * @param aAppUi Pointer to the Application UI class that |
|
51 * launched the Settings Application |
|
52 */ |
|
53 inline static CLocSettingsUiParams* NewL( MLocSettingsUiObserver& aObserver, |
|
54 CAknViewAppUi& aAppUi ); |
|
55 /** |
|
56 * Creates the Settings Parameters. |
|
57 * |
|
58 * @param aObserver Settings UI Observer |
|
59 * @param aAppUi Pointer to the Application UI class that |
|
60 * launched the Settings Application |
|
61 */ |
|
62 inline static CLocSettingsUiParams* NewLC( MLocSettingsUiObserver& aObserver, |
|
63 CAknViewAppUi& aAppUi ); |
|
64 |
|
65 /** |
|
66 * Destructor |
|
67 */ |
|
68 inline virtual ~CLocSettingsUiParams(); |
|
69 |
|
70 /** |
|
71 * SettingsUIObserver Accessor function |
|
72 * |
|
73 * @return MLocSettingsUiObserver& Reference to the Settings UI Observer |
|
74 */ |
|
75 inline MLocSettingsUiObserver& SettingsUiObserver(); |
|
76 |
|
77 /** |
|
78 * CAknViewAppUi Accessor function |
|
79 * |
|
80 * @return CAknViewAppUi& Reference to the AppUi Object |
|
81 */ |
|
82 inline CAknViewAppUi& AppUi(); |
|
83 |
|
84 private: |
|
85 /** |
|
86 * Overloaded Constructor |
|
87 * |
|
88 * @param aObserver Settings UI Observer |
|
89 * @param aAppUi Pointer to the Application UI class that |
|
90 * launched the Settings Application |
|
91 */ |
|
92 inline CLocSettingsUiParams( MLocSettingsUiObserver& aObserver, |
|
93 CAknViewAppUi& aAppUi ); |
|
94 |
|
95 /** |
|
96 * Second Phase construction |
|
97 */ |
|
98 inline void ConstructL(); |
|
99 |
|
100 private: |
|
101 /** |
|
102 * Observer for the Settings UI Class |
|
103 */ |
|
104 MLocSettingsUiObserver& iSettingsUiObserver; |
|
105 |
|
106 /** |
|
107 * Reference to the Application Ui to which the Settings UI would belong to |
|
108 */ |
|
109 CAknViewAppUi& iAppUi; |
|
110 }; |
|
111 |
|
112 #include "locsettingsuiparams.inl" |
|
113 |
|
114 #endif // C_LOCSETTINGSUIPARAMS_H_ |
|
115 |