meetingrequest/mrutils/inc/esmrutilsapiext.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Wed, 31 Mar 2010 21:08:33 +0300
branchRCL_3
changeset 12 4ce476e64c59
parent 0 8466d47a6819
child 16 b5fbb9b25d57
permissions -rw-r--r--
Revision: 201011 Kit: 201013

/*
* Copyright (c)  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:  ESMRUI API extension definition
*
*/

#ifndef ESMRUTILSAPIEXT_H
#define ESMRUTILSAPIEXT_H

#include <cmrutils.h>

/**
 * Extension API query function.
 *
 * Usage:
 *  Class providing extension:
 *
 *  class CExtendable
 *      {
 *      public:
 *      .
 *      .
 *      .
 *      TAny* ExtensionL( TUid aExtUid );
 *      }; 
 *
 *   TAny* CExtendable::ExtensionL( TUid aExtUid )
 *      {
 *      if (aExtUid == KOwnExtension)
 *          {
 *          return static_cast<ExtensionApiType*>( this );
 *          }
 *      } 
 *
 *  Class using extension:
 *
 *
 *  CMRUtils* utils = ...;
 *  ExtensionApiType* ext = ExtensionApiL<ExtensionApiType>( iUtils );
 *
 * @param aUtils
 * @return Pointer to the requested extension API
 */
template<class ExtensionApiType>
ExtensionApiType* ExtensionApiL( CMRUtils& aUtils )
    {
    TAny* extApi = aUtils.ExtensionL( ExtensionApiType::ExtensionUid() );
    if ( extApi )
        {
        return static_cast<ExtensionApiType*>( extApi );
        }
    else
        {
        return NULL;        
        }
    }
    
#endif  // ESMRUTILSAPIEXT_H

// End of File