1 /* |
|
2 * Copyright (c) 2002 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 settings can be modified |
|
15 * and read with help of this API. |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 |
|
21 #ifndef MLOCPSYSETTINGS_H_ |
|
22 #define MLOCPSYSETTINGS_H_ |
|
23 |
|
24 // INCLUDES |
|
25 #include <lbscommon.h> // TPositionModuleId |
|
26 |
|
27 // FORWARD DECLARATIONS |
|
28 class MLocPsyEngObserver; |
|
29 class CLocPsyInfo; |
|
30 class MAknServerAppExitObserver; |
|
31 |
|
32 // CLASS DECLARATION |
|
33 |
|
34 /** |
|
35 * This location application engine API is only used by location application. |
|
36 * Location settings can be modified and read with help of this API. |
|
37 * |
|
38 * @lib locpsysettingseng.lib |
|
39 * @since 3.1 |
|
40 */ |
|
41 class MLocPsySettings |
|
42 { |
|
43 public: // Constructors and destructor |
|
44 |
|
45 /** |
|
46 * Destructor. |
|
47 */ |
|
48 virtual ~MLocPsySettings(){}; |
|
49 |
|
50 public: // New functions |
|
51 /** |
|
52 * Lists all PSYs |
|
53 * @since 3.1 |
|
54 * @return number of PSYs |
|
55 */ |
|
56 virtual TInt PSYCount() = 0; |
|
57 |
|
58 /** |
|
59 * Get psy information |
|
60 * @since 3.1 |
|
61 * @param aIndex |
|
62 * @return psy information |
|
63 */ |
|
64 virtual CLocPsyInfo* GetPsyL(TInt aIndex ) = 0; |
|
65 |
|
66 /** |
|
67 * Enable psy |
|
68 * @since 3.1 |
|
69 * @param psy |
|
70 * @return nothing. Leaves on Error. |
|
71 */ |
|
72 virtual void EnablePsyL( TInt aIndex ) = 0; |
|
73 |
|
74 /** |
|
75 * Disable psy |
|
76 * @since 3.1 |
|
77 * @param psy |
|
78 * @return nothing. Leaves on Error. |
|
79 */ |
|
80 virtual void DisablePsyL( TInt aIndex ) = 0; |
|
81 |
|
82 |
|
83 /** |
|
84 * Start psy configuration UI |
|
85 * @since 3.1 |
|
86 * @param aIndex |
|
87 * @return none |
|
88 */ |
|
89 virtual void ConfigurePsyL(TInt aIndex, |
|
90 MAknServerAppExitObserver& aObserver ) = 0; |
|
91 |
|
92 /** |
|
93 * Close psy configuration UI |
|
94 * @since 3.1 |
|
95 * @param none |
|
96 * @return none |
|
97 */ |
|
98 virtual void ClosePsyConfigurationApp() = 0; |
|
99 |
|
100 /** |
|
101 * Get psy information |
|
102 * @since 3.1 |
|
103 * @param aIndex |
|
104 * @return psy information |
|
105 */ |
|
106 virtual TBool IsPsyConfigurable( TInt aIndex ) = 0; |
|
107 |
|
108 /** |
|
109 * Get psy information |
|
110 * @since 3.1 |
|
111 * @param aIndex |
|
112 * @return psy information |
|
113 */ |
|
114 virtual TBool IsPsyEnabled( TInt aIndex ) = 0; |
|
115 |
|
116 /** |
|
117 * Sets settings observer |
|
118 * @since 3.1 |
|
119 * @param aObserver A reference to observer |
|
120 */ |
|
121 virtual void SetObserver(MLocPsyEngObserver& aObserver) = 0; |
|
122 |
|
123 /** |
|
124 * Removes settings observer |
|
125 * @since 3.1 |
|
126 */ |
|
127 virtual void RemoveModelObserver() = 0; |
|
128 }; |
|
129 |
|
130 #endif // MLOCPSYSETTINGS_H_ |
|
131 |
|
132 // End of File |
|