51
|
1 |
/*
|
|
2 |
* Copyright (c) 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: MBSAccess
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
#ifndef __MBSACCESS_H
|
|
21 |
#define __MBSACCESS_H
|
|
22 |
|
|
23 |
#include <e32std.h>
|
|
24 |
#include <mbselement.h>
|
|
25 |
#include <bamdesca.h>
|
|
26 |
#include <f32file.h>
|
|
27 |
|
|
28 |
|
|
29 |
// forward declarations
|
|
30 |
class MBSBrandChangeObserver;
|
|
31 |
class MBSBackupRestoreStateObserver;
|
|
32 |
class CFbsBitmap;
|
|
33 |
|
|
34 |
/**
|
|
35 |
* An interface for getting branding information
|
|
36 |
*
|
|
37 |
* @since
|
|
38 |
*/
|
|
39 |
class MBSAccess
|
|
40 |
{
|
|
41 |
public:
|
|
42 |
|
|
43 |
/*
|
|
44 |
* Get text type item
|
|
45 |
* @param aId ID of the item
|
|
46 |
* @return the text item
|
|
47 |
*/
|
|
48 |
virtual HBufC* GetTextL( const TDesC8& aId ) = 0;
|
|
49 |
|
|
50 |
/*
|
|
51 |
* Get text type item
|
|
52 |
* @param aId ID of the item
|
|
53 |
* @return the text item
|
|
54 |
*/
|
|
55 |
virtual HBufC* GetTextLC( const TDesC8& aId ) = 0;
|
|
56 |
|
|
57 |
/*
|
|
58 |
* Get 8-bit data type item
|
|
59 |
* @param aId ID of the item
|
|
60 |
* @return the data buffer item
|
|
61 |
*/
|
|
62 |
virtual HBufC8* GetBufferL( const TDesC8& aId ) = 0;
|
|
63 |
|
|
64 |
/*
|
|
65 |
* Get 8-bit data type item
|
|
66 |
* @param aId ID of the item
|
|
67 |
* @return the data buffer item
|
|
68 |
*/
|
|
69 |
virtual HBufC8* GetBufferLC( const TDesC8& aId ) = 0;
|
|
70 |
|
|
71 |
/*
|
|
72 |
* Get integer type item
|
|
73 |
* @param aId ID of the item
|
|
74 |
* @return the integer item
|
|
75 |
*/
|
|
76 |
virtual TInt GetIntL( const TDesC8& aId ) = 0;
|
|
77 |
|
|
78 |
|
|
79 |
/*
|
|
80 |
* Get an array of items
|
|
81 |
* @param aIds ID's of the items
|
|
82 |
* @return the items
|
|
83 |
*/
|
|
84 |
virtual MBSElement* GetSeveralL( MDesC8Array& aIds ) = 0;
|
|
85 |
|
|
86 |
|
|
87 |
/*
|
|
88 |
* Get a file item
|
|
89 |
* @param aId ID of the item
|
|
90 |
* @param aFile on return will contain an open file handle
|
|
91 |
* to the file
|
|
92 |
*/
|
|
93 |
virtual void GetFileL( const TDesC8& aId,
|
|
94 |
RFile& aFile ) = 0;
|
|
95 |
|
|
96 |
/*
|
|
97 |
* Get a structure type item
|
|
98 |
* @param aIds ID of the item
|
|
99 |
* @return structure branding element
|
|
100 |
*/
|
|
101 |
virtual MBSElement* GetStructureL( const TDesC8& aId ) = 0;
|
|
102 |
|
|
103 |
/*
|
|
104 |
* Register to observer brand data updates
|
|
105 |
* @param aObserver the observer interface
|
|
106 |
*/
|
|
107 |
virtual void RegisterObserverL( MBSBrandChangeObserver* aObserver, MBSBackupRestoreStateObserver* aBackupObserver ) = 0;
|
|
108 |
|
|
109 |
/*
|
|
110 |
* Unregister a brand data update observer
|
|
111 |
* @param aObserver the observer interface
|
|
112 |
*/
|
|
113 |
virtual void UnRegisterObserverL( MBSBrandChangeObserver* aObserver, MBSBackupRestoreStateObserver *aBackupObserver ) = 0;
|
|
114 |
|
|
115 |
/*
|
|
116 |
* Get a bitmap type item.
|
|
117 |
* Note that this method supports skins, but as skin support
|
|
118 |
* requires CONE, it will only try to load skin bitmaps if
|
|
119 |
* CONE is available. Else it will only load normal bitmaps.
|
|
120 |
* @param aBitmapId the ID of the bitmap item itself
|
|
121 |
* @param aBitmap on return will contain the bitmap
|
|
122 |
* @param aMask on return will contain the mask
|
|
123 |
*/
|
|
124 |
virtual void GetBitmapL( const TDesC8& aBitmapId,
|
|
125 |
CFbsBitmap*& aBitmap,
|
|
126 |
CFbsBitmap*& aMask ) = 0;
|
|
127 |
|
|
128 |
|
|
129 |
virtual TInt isBrandUpdateRequiredL () = 0;
|
|
130 |
/*
|
|
131 |
* Closes the handle to server and deletes the object.
|
|
132 |
*/
|
|
133 |
virtual void Close() = 0;
|
|
134 |
|
|
135 |
protected:
|
|
136 |
|
|
137 |
/*
|
|
138 |
* Destructor
|
|
139 |
*/
|
|
140 |
virtual ~MBSAccess() {};
|
|
141 |
};
|
|
142 |
|
|
143 |
#endif //__MBSACCESS_H
|