1 /*

     2 * Copyright (c) 2004-2008 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Base class for concrete plugins.

    15 *

    16 */

    17 

    18 

    19 #ifndef AKNSRLEFFECTPLUGIN_H

    20 #define AKNSRLEFFECTPLUGIN_H

    21 

    22 //  INCLUDES

    23 #include <e32base.h>

    24 #include <AknsRlEffect.h>

    25 

    26 // CONSTANTS

    27 

    28 const TInt KAknsRlEffectPluginInterfaceEffect = 0;

    29 

    30 // CLASS DECLARATION

    31 

    32 /**

    33 * Base class for concrete plugins.

    34 *

    35 * @since 2.8

    36 */

    37 NONSHARABLE_CLASS(CAknsRlEffectPlugin) : public CBase

    38     {

    39     public: // Constructors and destructor

    40 

    41         /**

    42         * Default constructor.

    43         *

    44         * @since 2.8

    45         */

    46         CAknsRlEffectPlugin();

    47 

    48         /**

    49         * Destructor.

    50         *

    51         * @since 2.8

    52         */

    53         virtual ~CAknsRlEffectPlugin();

    54 

    55     public: // New functions

    56 

    57         /**

    58         * Gets the UID of the effect implemented by this plugin.

    59         *

    60         * @return UID of the effect.

    61         *

    62         * @since 2.8

    63         */

    64         virtual TUid EffectUid() const =0;

    65 

    66         /**

    67         * Gets a pointer to the effect interface implemented by this plugin.

    68         *

    69         * @param aInterface Always @c KAknsRlEffectPluginInterfaceEffect.

    70         *

    71         * @return If @c aInterface is @c KAknsRlEffectPluginInterfaceEffect,

    72         *   pointer to the effect interface. The pointer must be non-null and

    73         *   valid for the lifetime of the plugin.

    74         *   If @c aInterface has another value, @c null must be returned.

    75         */

    76         virtual MAknsRlEffect* Effect( const TInt aInterface ) =0;

    77     };

    78 

    79 #endif // AKNSRLEFFECTPLUGIN_H

    80 

    81 // End of File