--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/conversations_plat/im_cv_appui_api/inc/cimcvmenuextension.h Tue Feb 02 10:12:18 2010 +0200
@@ -0,0 +1,110 @@
+/*
+* Copyright (c) 2008 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: Abstract interface for menu extensions.
+*
+*/
+
+#ifndef __CIMCVMENUEXTENSION_H__
+#define __CIMCVMENUEXTENSION_H__
+
+
+// INCLUDES
+#include <e32base.h>
+#include <ecom/ecom.h>
+
+// FORWARD DECLARATIONS
+class CEikMenuPane;
+class MIMCVCommandMapper;
+
+
+//CONSTANTS
+const TUid KMenuCustomisationInterfaceUid = { 0x20026768 };
+// CLASS DECLARATION
+
+/**
+ * Abstract interface for menuextensions. extension plugins can
+ * extend service tab menu by implementing a class derived from this.
+ */
+class CIMCVMenuExtension : public CBase
+ {
+
+ public:
+
+ static CIMCVMenuExtension* CreateImplementationL( TUid aUid );
+
+ virtual ~CIMCVMenuExtension();
+
+ public: // Interface
+ /**
+ * Filters the menu pane of the plugin connected to this.
+ *
+ * @param aPreviousId Menu command id after which the plugins menu
+ * should come.
+ * @param aMenuPane Menu pane which will be filtered.
+ * @param aServiceId service id.
+ */
+ virtual void DynInitMenuPaneL
+ (TInt aPreviousId, CEikMenuPane& aMenuPane,TUint aServiceId) = 0;
+
+ /**
+ * Handles service tab extension commands.
+ *
+ * @param aCommandId Command ID.
+ *
+ * @return ETrue if command was handled, otherwise EFalse.
+ */
+ virtual TBool HandleCommandL(const TInt& aCommand ) = 0;
+
+ /**
+ * Registers command ID mapper. This method is called automatically
+ * by Servicetab menu extneions at initialization phase.
+ *
+ * @param aMapper Command ID mapper
+ */
+ virtual void RegisterCommandMapper( MIMCVCommandMapper& aMapper ) = 0;
+
+ /**
+ * Gets STM_COMMAND_INFO_ARRAY resource. Resource should be loaded.
+ *
+ * @return Resource ID or KErrNotFound
+ */
+ virtual TInt CommandInfoResource() const = 0;
+
+
+ private:
+ /**
+ * Instance identifier key. When instance of an implementation is
+ * created by ECOM framework, the framework will assign a UID for
+ * it. The UID is used in the destructor to notify framework that
+ * this instance is being destroyed and resources can be released.
+ * Plugin implementations should leave this untouched, as the inline
+ * destructor and constructor method take care of ECom releasing.
+ */
+ TUid iDtor_ID_Key;
+
+
+ };
+inline CIMCVMenuExtension* CIMCVMenuExtension::CreateImplementationL( TUid aUid )
+ {
+ TAny* ptr = REComSession::CreateImplementationL( aUid, _FOFF( CIMCVMenuExtension, iDtor_ID_Key ) );
+ CIMCVMenuExtension* impl = static_cast<CIMCVMenuExtension*> (ptr);
+ return impl;
+ }
+
+inline CIMCVMenuExtension::~CIMCVMenuExtension()
+ {
+ REComSession::DestroyedImplementation( iDtor_ID_Key );
+ }
+
+#endif // __CIMCVMENUEXTENSION_H__