1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/emailobserverplugin.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,70 @@
     1.4 +/*
     1.5 +* Copyright (c) 2009 - 2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  Interface header for Email Observer Plugin API.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +#ifndef EMAILOBSERVERPLUGIN_H
    1.22 +#define EMAILOBSERVERPLUGIN_H
    1.23 +
    1.24 +// System includes
    1.25 +#include <ecom/ecom.h>
    1.26 +
    1.27 +namespace EmailInterface {
    1.28 +
    1.29 +// Forward declarations
    1.30 +class MEmailObserverListener;
    1.31 +class MEmailData;
    1.32 +
    1.33 +/**
    1.34 + *  Class that client of this interface user instantiates
    1.35 + */
    1.36 +class CEmailObserverPlugin : public CBase
    1.37 +    {
    1.38 +public:
    1.39 +    /**
    1.40 +     * Contructor
    1.41 +     * @param aImplUid implementation identifier used by the ECOM framework
    1.42 +     * @param aListener callback interface provided by the client/instantiator.
    1.43 +     *        Plugin should call this when it wants the widget data to be updated
    1.44 +     * @return plugin instance
    1.45 +     */
    1.46 +    inline static CEmailObserverPlugin* NewL(
    1.47 +        TUid aImplUid,
    1.48 +        MEmailObserverListener* aListener );
    1.49 +
    1.50 +    /** destructor */
    1.51 +    inline virtual ~CEmailObserverPlugin();
    1.52 +
    1.53 +    /**
    1.54 +     * Accessor for data that needs to be published
    1.55 +     * Plugin must implement this.
    1.56 +     * When client calls this, plugin must ensure that all necessary data is accessible/updated
    1.57 +     * @return interface to email data
    1.58 +     */
    1.59 +    virtual MEmailData& EmailDataL() = 0;
    1.60 +
    1.61 +private:
    1.62 +    /**
    1.63 +     * Unique instance identifier key
    1.64 +     */
    1.65 +    TUid iDtor_ID_Key;
    1.66 +    };
    1.67 +
    1.68 +// Inline functions
    1.69 +#include "emailobserverplugin.inl"
    1.70 +
    1.71 +} // namespace
    1.72 +
    1.73 +#endif // EMAILOBSERVERPLUGIN_H