|
1 /* |
|
2 * Copyright (c) 2004-2008 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: Interface for accesing icon data in SIM. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MSATSICONAPI_H |
|
21 #define MSATSICONAPI_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32std.h> |
|
25 #include <etelsat.h> |
|
26 #include "MSatIconObserver.h" |
|
27 |
|
28 // CLASS DECLARATION |
|
29 |
|
30 /** |
|
31 * Interface for accessing icon data in SIM. |
|
32 * |
|
33 * @lib SatEngine.lib |
|
34 * @since 2.6 |
|
35 */ |
|
36 class MSatSIconAPI |
|
37 { |
|
38 public: // Constructors and destructor |
|
39 |
|
40 /** |
|
41 * Destructor. |
|
42 */ |
|
43 virtual ~MSatSIconAPI() {}; |
|
44 |
|
45 public: // New functions |
|
46 |
|
47 /** |
|
48 * Gets the icon info from SIM. |
|
49 * @param aRecordNumber Specifies the EF_IMG in SIM. |
|
50 * @param aIconEf Contains the icon informations from SIM in returning |
|
51 * of the method. |
|
52 * @param aObserver Observer for icon info get completion. |
|
53 */ |
|
54 virtual void GetIconInfo( |
|
55 TUint8 aRecordNumber, |
|
56 RSat::TIcon& aIconEf, |
|
57 MSatIconObserver& aObserver ) = 0; |
|
58 |
|
59 /** |
|
60 * Gets the icon image. |
|
61 * @param aInstance Informatio of the icon, which data is |
|
62 * fetched from SIM. |
|
63 * @param aInstance Contains the icon data from SIM in returning of the |
|
64 * method. |
|
65 * @param aObserver Observer for icon image get completion. |
|
66 */ |
|
67 virtual void GetIconInstance( |
|
68 const RSat::TInstanceInfoV3& aInstanceInfo, |
|
69 TDes8& aInstance, |
|
70 MSatIconObserver& aObserver ) = 0; |
|
71 |
|
72 /** |
|
73 * Gets color lookup table of the icon. |
|
74 * @param aInstanceNumber Image instance number. |
|
75 * @param aOffset Offset of the clut. |
|
76 * @param aClut Contains the Clut of the icon in returning of the |
|
77 * method. |
|
78 * @param aObserver Observer for clut get completion. |
|
79 */ |
|
80 virtual void GetClut( |
|
81 TUint aInstanceNumber, |
|
82 TUint aOffset, |
|
83 TDes8& aClut, |
|
84 MSatIconObserver& aObserver ) = 0; |
|
85 /* |
|
86 * Set a mode to determine whether to fetch icons from NAA syncronously |
|
87 * or asynchronously. |
|
88 * |
|
89 * @param aMode Synchronous or asynchronous mode. Icons would be |
|
90 * fetched from NAA in sychronous mode if SAT UI was closed by |
|
91 * using the End Key. Otherwise, in asynchronous mode. |
|
92 * @return None |
|
93 */ |
|
94 virtual void SetIconFetchingMode( TBool aMode ) = 0; |
|
95 |
|
96 protected: |
|
97 |
|
98 // Constructor |
|
99 MSatSIconAPI() {}; |
|
100 |
|
101 private: |
|
102 |
|
103 // Prohibit copy constructor if not deriving from CBase. |
|
104 MSatSIconAPI( const MSatSIconAPI& ); |
|
105 |
|
106 // Prohibit assigment operator if not deriving from CBase. |
|
107 MSatSIconAPI& operator=( const MSatSIconAPI& ); |
|
108 |
|
109 }; |
|
110 |
|
111 #endif // MSATSICONAPI_H |
|
112 |
|
113 // End of File |