46 /** |
46 /** |
47 * Destructor. |
47 * Destructor. |
48 */ |
48 */ |
49 virtual ~MFSMailBrandManager() { } |
49 virtual ~MFSMailBrandManager() { } |
50 |
50 |
51 /** |
51 /** |
52 * Returns a branded graphical element. |
52 * Returns a branded graphical element. |
53 * |
53 * |
54 * @param aElement Id of the branded element. This identifies which |
54 * @param aElement Id of the branded element. This identifies which |
55 * graphic user wishes to retrieve. |
55 * graphic user wishes to retrieve. |
56 * @param aMailBoxId mailbox whose branded element is retrieved. |
56 * @param aMailBoxId mailbox whose branded element is retrieved. |
57 * |
57 * |
58 * @return A pointer to a CGulIcon object. The caller of this method is |
58 * @return A pointer to a CGulIcon object. The caller of this method is |
59 * responsible of destroying the object. Returns NULL if the |
59 * responsible of destroying the object. Returns NULL if the |
60 * brand doesn't contain the requested branding element. |
60 * brand doesn't contain the requested branding element. |
61 */ |
61 */ |
62 virtual CGulIcon* GetGraphicL( TFSBrandElement aElement, |
62 virtual CGulIcon* GetGraphicL( TFSBrandElement aElement, |
63 const TFSMailMsgId& aMailboxId ) = 0; |
63 const TFSMailMsgId& aMailboxId ) = 0; |
64 |
64 |
65 /** |
65 /** |
66 * Returns a branded graphical element. |
66 * Returns a branded graphical element. |
67 * |
67 * |
68 * @param aElement Id of the branded element. This identifies which |
68 * @param aElement Id of the branded element. This identifies which |
69 * graphic user wishes to retrieve. |
69 * graphic user wishes to retrieve. |
70 * @param aBrandId is the domain. |
70 * @param aBrandId is the domain. |
73 * responsible of destroying the object. Returns NULL if the |
73 * responsible of destroying the object. Returns NULL if the |
74 * brand doesn't contain the requested branding element. |
74 * brand doesn't contain the requested branding element. |
75 */ |
75 */ |
76 virtual CGulIcon* GetGraphicL( TFSBrandElement aElement, |
76 virtual CGulIcon* GetGraphicL( TFSBrandElement aElement, |
77 const TDesC& aBrandId ) = 0; |
77 const TDesC& aBrandId ) = 0; |
78 |
78 |
79 /** |
79 /** |
80 * Returns a branded text element. |
80 * Returns a branded text element. |
81 * |
|
82 * @param aElement Id of the branded element. This identifies which |
|
83 * text user wishes to retrieve. |
|
84 * @param aMailBoxId mailbox whose branded element is retrieved. |
|
85 * |
|
86 * @return A TPtrC object. Returns TPtrC to a null descriptor if the |
|
87 * brand doesn't contain the requested branding element. |
|
88 */ |
|
89 virtual TPtrC GetTextL( TFSBrandElement aElement, |
|
90 const TFSMailMsgId& aMailboxId ) = 0; |
|
91 |
|
92 /** |
|
93 * Returns a branded text element. |
|
94 * This function is for WhiteLabelBranding, because branded mailbox name is |
|
95 * needed before mailbox creation. |
|
96 * |
|
97 * @param aElement Id of the branded element. This identifies which |
|
98 * text user wishes to retrieve. |
|
99 * @param aMailBoxId mailbox whose branded element is retrieved. |
|
100 * |
|
101 * @return A TPtrC object. Returns TPtrC to a null descriptor if the |
|
102 * brand doesn't contain the requested branding element. |
|
103 */ |
|
104 virtual TPtrC GetTextL( TFSBrandElement aElement, |
|
105 const TDesC& aBrandId ) = 0; |
|
106 |
|
107 /** |
|
108 * Returns a branded text element. |
|
109 * |
|
110 * @param aElement The id of the branded element. This identifies which |
|
111 * color user wishes to retrieve. |
|
112 * @param aMailBoxId mailbox whose branded element is retrieved. |
|
113 * @param aColor A reference to a TRgb object. The color is returned |
|
114 * using this reference. |
|
115 * |
81 * |
116 * @return Error code. KErrNotFound if the brand doesn't contain the requested |
82 * @param aElement Id of the branded element. This identifies which |
117 * branding element. |
83 * text user wishes to retrieve. |
118 */ |
84 * @param aMailBoxId mailbox whose branded element is retrieved. |
119 virtual TInt GetColorL( TFSBrandElement aElement, |
85 * |
120 const TFSMailMsgId& aMailboxId, |
86 * @return A TPtrC object. Returns TPtrC to a null descriptor if the |
121 TRgb& aColor ) = 0; |
87 * brand doesn't contain the requested branding element. |
122 |
88 */ |
123 /** |
89 virtual TPtrC GetTextL( TFSBrandElement aElement, |
124 * This function will change 'mailbox name' as branded name. |
90 const TFSMailMsgId& aMailboxId ) = 0; |
125 * If aMailboxId is NULL function goes through all mailboxes and check if mailbox is branded. |
91 |
126 * If it is, function will change 'mailbox name' as branded name. |
92 /** |
127 * This function should be called after mailbox settings has changed. |
93 * Returns a branded text element. |
128 * |
94 * This function is for WhiteLabelBranding, because branded mailbox name is |
129 * @param aMailboxId Id of the mailbox |
95 * needed before mailbox creation. |
130 */ |
96 * |
131 virtual void UpdateMailboxNamesL( const TFSMailMsgId aMailboxId ) = 0; |
97 * @param aElement Id of the branded element. This identifies which |
|
98 * text user wishes to retrieve. |
|
99 * @param aMailBoxId mailbox whose branded element is retrieved. |
|
100 * |
|
101 * @return A TPtrC object. Returns TPtrC to a null descriptor if the |
|
102 * brand doesn't contain the requested branding element. |
|
103 */ |
|
104 virtual TPtrC GetTextL( TFSBrandElement aElement, |
|
105 const TDesC& aBrandId ) = 0; |
|
106 |
|
107 /** |
|
108 * Returns a branded text element. |
|
109 * |
|
110 * @param aElement The id of the branded element. This identifies which |
|
111 * color user wishes to retrieve. |
|
112 * @param aMailBoxId mailbox whose branded element is retrieved. |
|
113 * @param aColor A reference to a TRgb object. The color is returned |
|
114 * using this reference. |
|
115 * |
|
116 * @return Error code. KErrNotFound if the brand doesn't contain the requested |
|
117 * branding element. |
|
118 */ |
|
119 virtual TInt GetColorL( TFSBrandElement aElement, |
|
120 const TFSMailMsgId& aMailboxId, |
|
121 TRgb& aColor ) = 0; |
|
122 |
|
123 /** |
|
124 * This function will change 'mailbox name' as branded name. |
|
125 * If aMailboxId is NULL function goes through all mailboxes and check if mailbox is branded. |
|
126 * If it is, function will change 'mailbox name' as branded name. |
|
127 * This function should be called after mailbox settings has changed. |
|
128 * |
|
129 * @param aMailboxId Id of the mailbox |
|
130 */ |
|
131 virtual void UpdateMailboxNamesL( const TFSMailMsgId aMailboxId ) = 0; |
132 |
132 |
133 /** |
133 /** |
134 * Returns branded graphic element of given type. |
134 * Returns branded graphic element of given type. |
135 * |
135 * |
136 * @param aElementId brand element |
136 * @param aElementId brand element |
137 * @param aMailBoxId mailbox whose branded element is retrieved. |
137 * @param aMailBoxId mailbox whose branded element is retrieved. |
138 * @param aIconIds Icon path and ids |
138 * @param aIconIds Icon path and ids |
139 * |
139 * |
140 * @return Error code |
140 * @return Error code |
141 */ |
141 */ |
142 virtual TInt GetGraphicIdsL( TFSBrandElement aElement, |
142 virtual TInt GetGraphicIdsL( TFSBrandElement aElement, |
143 const TFSMailMsgId& aMailboxId, |
143 const TFSMailMsgId& aMailboxId, |
144 TDes& aIconIds ) = 0; |
144 TDes& aIconIds ) = 0; |
145 |
145 |
146 }; |
146 }; |
147 |
147 |
148 |
148 |
149 #endif // MFSMAILBRANDMANAGER_H |
149 #endif // MFSMAILBRANDMANAGER_H |