skins/AknSkins/rlinc/AknsRlInternalEffectPool.h
changeset 0 05e9090e2422
equal deleted inserted replaced
-1:000000000000 0:05e9090e2422
       
     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:  Effect pool class.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef AKNSRLINTERNALEFFECTPOOL_H
       
    20 #define AKNSRLINTERNALEFFECTPOOL_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include "AknsRlEffectPlugin.h"
       
    24 
       
    25 /**
       
    26 * Internal effect pool class that owns the effect plugins built into the
       
    27 * library.
       
    28 *
       
    29 * @since 2.8
       
    30 */
       
    31 NONSHARABLE_CLASS(CAknsRlInternalEffectPool) : public CBase
       
    32     {
       
    33     private: // Constructors and destructor
       
    34 
       
    35         /**
       
    36         * Default constructor is private.
       
    37         *
       
    38         * @since 2.8
       
    39         */
       
    40         CAknsRlInternalEffectPool();
       
    41 
       
    42     public: // Constructors and destructor
       
    43 
       
    44         /**
       
    45         * Static creator.
       
    46         *
       
    47         * @since 2.8
       
    48         */
       
    49         static CAknsRlInternalEffectPool* NewL();
       
    50 
       
    51         /**
       
    52         * Two-phased constructor.
       
    53         *
       
    54         * @since 2.8
       
    55         */
       
    56         void ConstructL();
       
    57 
       
    58         /**
       
    59         * Destructor.
       
    60         *
       
    61         * @since 2.8
       
    62         */
       
    63         virtual ~CAknsRlInternalEffectPool();
       
    64 
       
    65     public: // New functions
       
    66 
       
    67         /**
       
    68         * Gets the effect matching the given UID.
       
    69         *
       
    70         * @param aEffectUid UID of the effect to be retrieved.
       
    71         *
       
    72         * @return Pointer to the effect instance, or @c null if not found.
       
    73         *   The effect is initialized, but not activated.
       
    74         *   The caller must not release the effect.
       
    75         *
       
    76         * @since 2.8
       
    77         */
       
    78         MAknsRlEffect* GetEffect( const TUid aEffectUid );
       
    79 
       
    80     private: // New functions
       
    81 
       
    82         void AddInstanceL( CAknsRlEffectPlugin* aPlugin );
       
    83 
       
    84     private: // Data
       
    85 
       
    86         RPointerArray<CAknsRlEffectPlugin> iEffectArray;
       
    87 
       
    88     };
       
    89 
       
    90 #endif // AKNSRLINTERNALEFFECTPOOL_H
       
    91 
       
    92 // End of File