1 /* |
|
2 * Copyright (c) 2006-2009 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 UI interface class. All the components intending to |
|
15 * provide UI services through the Location UI Server must implement |
|
16 * this class |
|
17 * |
|
18 */ |
|
19 |
|
20 |
|
21 #ifndef M_LOCATIONUI_H_ |
|
22 #define M_LOCATIONUI_H_ |
|
23 |
|
24 // System Includes |
|
25 #include <e32base.h> |
|
26 |
|
27 // User Include |
|
28 |
|
29 // Forward Declarations |
|
30 |
|
31 // Class Definition |
|
32 /** |
|
33 * Observer for notification regarding the termination of the Launch call. |
|
34 * |
|
35 * @lib locsysuiengine.lib |
|
36 * @since S60 v3.2 |
|
37 */ |
|
38 class MLocationUIObserver |
|
39 { |
|
40 public: |
|
41 /** |
|
42 * Notifies the termination of the Location UI |
|
43 * |
|
44 * @since S60 v3.2 |
|
45 * @param aErrorCode The termination reason. KErrNone for normal |
|
46 * terminations. In case of error or pre-mature |
|
47 * aborting System wide Error codes. |
|
48 */ |
|
49 virtual void LocationUIDismissed( TInt aErrorCode ) = 0; |
|
50 }; |
|
51 |
|
52 /** |
|
53 * Location UI interface class. All the components intending to provide Location |
|
54 * UI related services must implement this class. This class provides the interface |
|
55 * to Launch and Close a Location UI component |
|
56 * |
|
57 * @lib locsysuiengine.lib |
|
58 * @since S60 v3.2 |
|
59 */ |
|
60 class MLocationUI |
|
61 { |
|
62 public: |
|
63 /** |
|
64 * Launches a Location UI component. |
|
65 * |
|
66 * @param aUiInputParams Flags that define specific configuration of the |
|
67 * Location UI, that the user of the API wants to |
|
68 * launch. If more than one functionality is |
|
69 * requested then the various combinations are to be |
|
70 * ORed. The interpretation of these flag values is |
|
71 * a part of the understanding between the API user |
|
72 * and the corresponding Location UI. |
|
73 * @param aObserver Observer where the termination of the Launch call |
|
74 * needs to be notified. |
|
75 * |
|
76 */ |
|
77 virtual void LaunchLocationUIL( TInt aUiInputParams, |
|
78 MLocationUIObserver* aObserver ) = 0; |
|
79 |
|
80 /** |
|
81 * Launches a Location UI component. |
|
82 * |
|
83 * @param aUiInputParams String passed as a parameter to the |
|
84 * Location UI, that the user of the API wants to |
|
85 * launch. The interpretation of this string is |
|
86 * a part of the understanding between the API user |
|
87 * and the corresponding Location UI. |
|
88 * @param aObserver Observer where the termination of the Launch call |
|
89 * needs to be notified. |
|
90 * |
|
91 */ |
|
92 virtual void LaunchLocationUIL( const TDesC& aUiInputParams, |
|
93 MLocationUIObserver* aObserver ) = 0; |
|
94 |
|
95 /** |
|
96 * Closes the running Location UI prematurely. |
|
97 */ |
|
98 virtual void Close() = 0; |
|
99 |
|
100 }; |
|
101 |
|
102 #endif // M_LOCATIONUI_H_ |
|
103 |
|