1 /* |
|
2 * Copyright (c) 2002-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: This file contains the SAT Shell Controller Interface that is |
|
15 * responsible for the actual implementation of the following |
|
16 * functionality: |
|
17 * - add SAT UI application to Desk (or similar) |
|
18 * - remove SAT UI application from Desk (or similar) |
|
19 * - bring SAT UI application to foregroud if it already is up |
|
20 * and running |
|
21 * - launching the SAT UI application |
|
22 * - launching the Browser application |
|
23 * - resolving default access point |
|
24 * |
|
25 */ |
|
26 |
|
27 |
|
28 #ifndef MSATSHELLCONTROLLER_H |
|
29 #define MSATSHELLCONTROLLER_H |
|
30 |
|
31 #include <e32base.h> |
|
32 |
|
33 /** |
|
34 * This class is used to control adding, removing and launching of |
|
35 * the SAT UI Client application. It connects to appropriate module |
|
36 * and is used by the SAT Server. |
|
37 * |
|
38 * @lib SatEngine.lib |
|
39 * @since Series 60 2.0 |
|
40 * |
|
41 */ |
|
42 |
|
43 class MSatShellController |
|
44 { |
|
45 public: // Constructors and destructor |
|
46 |
|
47 /** |
|
48 * Destructor. |
|
49 */ |
|
50 virtual ~MSatShellController() {}; |
|
51 |
|
52 public: // New functions |
|
53 |
|
54 /** |
|
55 * Adds SAT UI Client to the Application Shell (or similar). |
|
56 * @param aName Name of the entry |
|
57 */ |
|
58 virtual void AddSatUiL( TDesC& aName ) = 0; |
|
59 |
|
60 /** |
|
61 * Adds SAT UI Client to the Application Shell (or similar). |
|
62 * @param aName Name of the entry |
|
63 * @param aIconId Id of the icon. |
|
64 */ |
|
65 virtual void AddSatUiL( TDesC& aName, TUint8 aIconId ) = 0; |
|
66 |
|
67 /** |
|
68 * Removes SAT UI Client from the Application Shell (or similar). |
|
69 */ |
|
70 virtual void RemoveSatUiL() = 0; |
|
71 |
|
72 /** |
|
73 * Launches the SAT UI Client. |
|
74 */ |
|
75 virtual void LaunchSatUiL() = 0; |
|
76 |
|
77 /** |
|
78 * Bring Browser to foreground after period of time. |
|
79 */ |
|
80 virtual void BringBrowserToForegroundAfterPeriod() = 0; |
|
81 |
|
82 /** |
|
83 * Bring the SAT UI Application to foreground. |
|
84 */ |
|
85 virtual void BringSatUiToForeground() = 0; |
|
86 |
|
87 /** |
|
88 * Sets SAT UI Application to background if needed. |
|
89 */ |
|
90 virtual void SetSatUiToBackground() const = 0; |
|
91 |
|
92 /** |
|
93 * Launch Browser |
|
94 * @since Series 60 2.6 |
|
95 * @param aUrl URL to be opened when launching browser. |
|
96 * @param aAccessPointUid ID number of access point in CommDb. |
|
97 * @return The result of the operation. |
|
98 */ |
|
99 virtual TInt LaunchBrowserL( |
|
100 const TDesC& aUrl, |
|
101 TUid aAccessPointUid ) = 0; |
|
102 }; |
|
103 |
|
104 #endif // MSATSHELLCONTROLLER_H |
|
105 |
|
106 // End of File |
|