emailservices/emailframework/commonlib/inc/cmailboxstateext.h
branchRCL_3
changeset 10 f5907b1a1053
child 13 8592a65ad3fb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/emailservices/emailframework/commonlib/inc/cmailboxstateext.h	Fri Mar 12 15:41:14 2010 +0200
@@ -0,0 +1,70 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Message extension interface
+*
+*/
+
+#ifndef CMAILBOXSTATEEXT_H
+#define CMAILBOXSTATEEXT_H
+
+#include "cemailextensionbase.h"
+#include "CFSMailCommon.h"
+
+// interface UID value passed to CFSMailClient::ExtensionL
+const TUid KEmailMailboxStateExtensionUid        = { 0x2001E28B };
+
+/**
+* Data providider interface.
+*/
+class MEmailMailboxState
+{
+public:
+    /**
+    * Returns currently active folder and related mailbox that
+    * is currently being used.
+    * @param aActiveMailboxId id of currently active mailbox 
+    * @param aActiveFolderId id of currently active mail folder
+    * @return Symbian OS error code
+    */
+    virtual TInt GetActiveFolderId( 
+        TFSMailMsgId& aActiveMailboxId,
+        TFSMailMsgId& aActiveFolderId ) const = 0;
+};
+
+/**
+ * Extension interface for passing UI context data to protocol plugins. 
+ */
+class CMailboxStateExtension : public CEmailExtension
+{
+public:
+    
+    /**
+     * Sets data provider interface
+     * @param aDataProvider data provider
+     */
+    virtual void SetStateDataProvider( MEmailMailboxState* aDataProvider ) = 0;
+
+protected:    
+    inline CMailboxStateExtension();
+
+protected:
+    MEmailMailboxState* iDataProvider;
+};
+
+inline CMailboxStateExtension::CMailboxStateExtension() :
+         CEmailExtension( KEmailMailboxStateExtensionUid )
+    {
+    }
+         
+#endif // CMAILBOXSTATEEXT_H