|
1 /* |
|
2 * Copyright (c) 2002-2005 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 class for resource file& bitmap changing feature. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MCAOPBRANDVARIANT_H |
|
21 #define MCAOPBRANDVARIANT_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32base.h> |
|
25 |
|
26 // CONSTANTS |
|
27 _LIT( KChatAppModuleId, "IMApp" ); |
|
28 _LIT( KChatEngModuleId, "IMEng" ); |
|
29 |
|
30 // FORWARD DECLARATIONS |
|
31 class CCoeEnv; |
|
32 |
|
33 // CLASS DECLARATION |
|
34 |
|
35 /** |
|
36 * Interface class for resource file& bitmap changing feature. |
|
37 * @lib chat.app |
|
38 * @since 1.2s |
|
39 */ |
|
40 class MCAOpBrandVariant |
|
41 { |
|
42 |
|
43 public: // New functions |
|
44 |
|
45 /** |
|
46 * Removes application resource in CreateDocumentL method. |
|
47 * @since 1.2s |
|
48 * @param aCoeEnv, control environment. |
|
49 * @param aAppResFileOffset, resource file offset, kept by the client. |
|
50 */ |
|
51 virtual void RemoveAppResourceL( CCoeEnv* aCoeEnv, |
|
52 TInt& aAppResFileOffset ) = 0; |
|
53 |
|
54 /** |
|
55 * Retrieves branded application resource file if there is one. |
|
56 * If not, the default |
|
57 * application resource file is loaded. |
|
58 * @since 1.2s |
|
59 * @param aCoeEnv, control environment. |
|
60 * @param aOrigAppResPath, original application resource path |
|
61 * @param aOrigEngResPath, original engine resource path |
|
62 * @param aOrigPresenceResPath, original presence resource path |
|
63 * @param aOrigCommUiResPath, original common ui resource path |
|
64 * @param aBitmapPath, bitmap path |
|
65 */ |
|
66 virtual void RetrieveSavedSettingsL( CCoeEnv* aCoeEnv, |
|
67 const TDesC& aOrigAppResPath, |
|
68 const TDesC& aOrigEngResPath, |
|
69 const TDesC& aOrigPresenceResPath, |
|
70 const TDesC& aOrigVariationResPath, |
|
71 const TDesC& aOrigCommUiResPath, |
|
72 TDes& aBitmapPath ) = 0; |
|
73 /** |
|
74 * Activates a brand, changes application's and engine's resource files. |
|
75 * @since 1.2s |
|
76 * @param aServer server name |
|
77 * @param aBitmapPath |
|
78 */ |
|
79 virtual void ActivateBrandL( const TDesC& aServer, TDes& aBitmapPath ) = 0; |
|
80 |
|
81 /** |
|
82 * Removes application's resource when exiting application. |
|
83 * @since 1.2s |
|
84 * @param aCoeEnv, control environment. |
|
85 */ |
|
86 virtual void DeleteResource( CCoeEnv* aCoeEnv ) = 0; |
|
87 |
|
88 /** |
|
89 * Returns true if default graphics aren't used. |
|
90 * @since 1.2s |
|
91 * @return TBool, false if using default bitmaps. |
|
92 */ |
|
93 virtual TBool BrandBitmapsActivatedL() const = 0; |
|
94 |
|
95 /** |
|
96 * Returns resource file path for certain resource. |
|
97 * @since 1.2s |
|
98 * @param aServer, server name |
|
99 * @param aResourceFile, resource file name |
|
100 * @param aFullPath, empty if not found, otherwise contains full path |
|
101 * to resource |
|
102 */ |
|
103 virtual void CurrentResourceFileL( const TDesC& aServer, const TDesC& aResourceFile, |
|
104 TDes& aFullPath ) = 0; |
|
105 |
|
106 }; |
|
107 |
|
108 #endif // MCAOPBRANDVARIANT_H |
|
109 |
|
110 // End of File |