1 /* |
|
2 * Copyright (c) 2005-2006 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: Location System UI Server's engine component. This class is |
|
15 * responsible for handling all the Location related UI components. |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef C_LOCSYSUIENGINE_H_ |
|
21 #define C_LOCSYSUIENGINE_H_ |
|
22 |
|
23 // System Includes |
|
24 #include <e32base.h> |
|
25 |
|
26 // User Include |
|
27 |
|
28 // Forward Declarations |
|
29 class MLocationUI; |
|
30 class CLocSettingsUiEngine; |
|
31 class CAknViewAppUi; |
|
32 class CLocPosSettings; |
|
33 |
|
34 // Class Definition |
|
35 |
|
36 /** |
|
37 * Encapulates the logic necessary to launch various Location UIs. |
|
38 * The Location UI AppServer will use this object for manipulating the Settings |
|
39 * components. The class contains funtionalities for discovering |
|
40 * various available Location UIs, launching a UI, cancelling a UI request, |
|
41 * terminating a UI after completion of the request.. |
|
42 * |
|
43 * @lib locsysuiengine.lib |
|
44 * @since S60 v3.2 |
|
45 */ |
|
46 class CLocSysUiEngine : public CBase |
|
47 { |
|
48 public: |
|
49 /** |
|
50 * Two Phase Constructor for creating the Location Settings UI engine. |
|
51 * |
|
52 * @param aAppUi Reference to the Application UI class. |
|
53 * @return CLocSysUiEngine* Reference to the created object. |
|
54 */ |
|
55 IMPORT_C static CLocSysUiEngine* NewL( |
|
56 CAknViewAppUi& aAppUi ); |
|
57 |
|
58 /** |
|
59 * Two Phase Constructor for creating the Location Settings UI engine. |
|
60 * Leaves the object on the cleanupstack. |
|
61 * |
|
62 * @param aAppUi Reference to the Application UI class. |
|
63 * @return CLocSysUiEngine* Reference to the created object. |
|
64 */ |
|
65 IMPORT_C static CLocSysUiEngine* NewLC( |
|
66 CAknViewAppUi& aAppUi ); |
|
67 |
|
68 /** |
|
69 * Destructor |
|
70 */ |
|
71 virtual ~CLocSysUiEngine(); |
|
72 |
|
73 /** |
|
74 * Creates the sub-Settings UI and appends it to the existing list. The ownership |
|
75 * of the created object is not returned to the callee function. The object would |
|
76 * be destroyed only on the destruction of the plug-in. |
|
77 * Incase the object alreacdy exists then the function would return a reference to |
|
78 * to the existing object. |
|
79 * |
|
80 * @param aImplementationUid The Implementation UID of the sub-settings plug-in that |
|
81 * has to be created. |
|
82 * @return MLocationUI* Reference to the sub-settings UI that has been created. |
|
83 */ |
|
84 IMPORT_C MLocationUI* CreateLocationSubSettingsUIL( TUid aImplementationUid ); |
|
85 |
|
86 /** |
|
87 * Creates an instance of Postioning Settings UI. The ownership |
|
88 * of the created object is not returned to the callee function. The object would |
|
89 * be destroyed only on the destruction of the plug-in. |
|
90 * Incase the object alreacdy exists then the function would return a reference to |
|
91 * to the existing object. |
|
92 * |
|
93 * @return MLocationUI* Reference to the Positioning UI that has been created. |
|
94 */ |
|
95 IMPORT_C MLocationUI* CreatePositioningSettingsUIL(); |
|
96 |
|
97 private: |
|
98 /** |
|
99 * Constructor |
|
100 */ |
|
101 CLocSysUiEngine( CAknViewAppUi& aAppUi ); |
|
102 |
|
103 private: |
|
104 /** |
|
105 * Reference to the applications UI |
|
106 */ |
|
107 CAknViewAppUi& iAppUi; |
|
108 |
|
109 /** |
|
110 * Reference to the Location Settings UI Engine. This object is used |
|
111 * when there is a request to launch a Location sub-settings UI. The object |
|
112 * is created at the time of the first Launch request. |
|
113 * Owns |
|
114 */ |
|
115 CLocSettingsUiEngine* iSettingsEngine; |
|
116 |
|
117 /** |
|
118 * Reference to the Positioning Settings UI. This object is used |
|
119 * when there is a request to launch Positioning Settings UI. The object |
|
120 * is created at the time of the first Launch request. |
|
121 */ |
|
122 CLocPosSettings* iPosSettings; |
|
123 }; |
|
124 |
|
125 #endif // C_LOCSYSUIENGINE_H_ |
|
126 |
|