diff -r e7aa27f58ae1 -r e1b6206813b4 emailservices/emailframework/inc/MFSMailBrandManager.h --- a/emailservices/emailframework/inc/MFSMailBrandManager.h Tue Feb 02 00:02:40 2010 +0200 +++ b/emailservices/emailframework/inc/MFSMailBrandManager.h Fri Feb 19 22:37:30 2010 +0200 @@ -48,21 +48,21 @@ */ virtual ~MFSMailBrandManager() { } - /** - * Returns a branded graphical element. - * - * @param aElement Id of the branded element. This identifies which - * graphic user wishes to retrieve. - * @param aMailBoxId mailbox whose branded element is retrieved. - * - * @return A pointer to a CGulIcon object. The caller of this method is - * responsible of destroying the object. Returns NULL if the - * brand doesn't contain the requested branding element. - */ - virtual CGulIcon* GetGraphicL( TFSBrandElement aElement, - const TFSMailMsgId& aMailboxId ) = 0; + /** + * Returns a branded graphical element. + * + * @param aElement Id of the branded element. This identifies which + * graphic user wishes to retrieve. + * @param aMailBoxId mailbox whose branded element is retrieved. + * + * @return A pointer to a CGulIcon object. The caller of this method is + * responsible of destroying the object. Returns NULL if the + * brand doesn't contain the requested branding element. + */ + virtual CGulIcon* GetGraphicL( TFSBrandElement aElement, + const TFSMailMsgId& aMailboxId ) = 0; - /** + /** * Returns a branded graphical element. * * @param aElement Id of the branded element. This identifies which @@ -75,75 +75,75 @@ */ virtual CGulIcon* GetGraphicL( TFSBrandElement aElement, const TDesC& aBrandId ) = 0; - - /** - * Returns a branded text element. - * - * @param aElement Id of the branded element. This identifies which - * text user wishes to retrieve. - * @param aMailBoxId mailbox whose branded element is retrieved. - * - * @return A TPtrC object. Returns TPtrC to a null descriptor if the - * brand doesn't contain the requested branding element. - */ - virtual TPtrC GetTextL( TFSBrandElement aElement, - const TFSMailMsgId& aMailboxId ) = 0; - - /** - * Returns a branded text element. - * This function is for WhiteLabelBranding, because branded mailbox name is - * needed before mailbox creation. - * - * @param aElement Id of the branded element. This identifies which - * text user wishes to retrieve. - * @param aMailBoxId mailbox whose branded element is retrieved. - * - * @return A TPtrC object. Returns TPtrC to a null descriptor if the - * brand doesn't contain the requested branding element. - */ - virtual TPtrC GetTextL( TFSBrandElement aElement, - const TDesC& aBrandId ) = 0; - - /** - * Returns a branded text element. - * - * @param aElement The id of the branded element. This identifies which - * color user wishes to retrieve. - * @param aMailBoxId mailbox whose branded element is retrieved. - * @param aColor A reference to a TRgb object. The color is returned - * using this reference. + + /** + * Returns a branded text element. + * + * @param aElement Id of the branded element. This identifies which + * text user wishes to retrieve. + * @param aMailBoxId mailbox whose branded element is retrieved. + * + * @return A TPtrC object. Returns TPtrC to a null descriptor if the + * brand doesn't contain the requested branding element. + */ + virtual TPtrC GetTextL( TFSBrandElement aElement, + const TFSMailMsgId& aMailboxId ) = 0; + + /** + * Returns a branded text element. + * This function is for WhiteLabelBranding, because branded mailbox name is + * needed before mailbox creation. + * + * @param aElement Id of the branded element. This identifies which + * text user wishes to retrieve. + * @param aMailBoxId mailbox whose branded element is retrieved. * - * @return Error code. KErrNotFound if the brand doesn't contain the requested - * branding element. - */ - virtual TInt GetColorL( TFSBrandElement aElement, - const TFSMailMsgId& aMailboxId, - TRgb& aColor ) = 0; - - /** - * This function will change 'mailbox name' as branded name. - * If aMailboxId is NULL function goes through all mailboxes and check if mailbox is branded. - * If it is, function will change 'mailbox name' as branded name. - * This function should be called after mailbox settings has changed. - * - * @param aMailboxId Id of the mailbox - */ - virtual void UpdateMailboxNamesL( const TFSMailMsgId aMailboxId ) = 0; + * @return A TPtrC object. Returns TPtrC to a null descriptor if the + * brand doesn't contain the requested branding element. + */ + virtual TPtrC GetTextL( TFSBrandElement aElement, + const TDesC& aBrandId ) = 0; + + /** + * Returns a branded text element. + * + * @param aElement The id of the branded element. This identifies which + * color user wishes to retrieve. + * @param aMailBoxId mailbox whose branded element is retrieved. + * @param aColor A reference to a TRgb object. The color is returned + * using this reference. + * + * @return Error code. KErrNotFound if the brand doesn't contain the requested + * branding element. + */ + virtual TInt GetColorL( TFSBrandElement aElement, + const TFSMailMsgId& aMailboxId, + TRgb& aColor ) = 0; + + /** + * This function will change 'mailbox name' as branded name. + * If aMailboxId is NULL function goes through all mailboxes and check if mailbox is branded. + * If it is, function will change 'mailbox name' as branded name. + * This function should be called after mailbox settings has changed. + * + * @param aMailboxId Id of the mailbox + */ + virtual void UpdateMailboxNamesL( const TFSMailMsgId aMailboxId ) = 0; /** * Returns branded graphic element of given type. * * @param aElementId brand element - * @param aMailBoxId mailbox whose branded element is retrieved. + * @param aMailBoxId mailbox whose branded element is retrieved. * @param aIconIds Icon path and ids - * - * @return Error code + * + * @return Error code */ - virtual TInt GetGraphicIdsL( TFSBrandElement aElement, - const TFSMailMsgId& aMailboxId, + virtual TInt GetGraphicIdsL( TFSBrandElement aElement, + const TFSMailMsgId& aMailboxId, TDes& aIconIds ) = 0; - + }; -#endif // MFSMAILBRANDMANAGER_H \ No newline at end of file +#endif // MFSMAILBRANDMANAGER_H \ No newline at end of file