skins/AknSkins/alinc/AknsAlAnimationFactory.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:  Animation Factory.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef AKNSALANIMATIONFACTORY_H
       
    20 #define AKNSALANIMATIONFACTORY_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32std.h>
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class CAknsRlEffectPlugin;
       
    27 class MAknsAlAnimationValue;
       
    28 class MAknsAlTimingModel;
       
    29 
       
    30 // CLASS DECLARATION
       
    31 /**
       
    32 * A toolkit class for creating animation related objects (RL effect plugins,
       
    33 * animation values and timing models).
       
    34 *
       
    35 * @since 3.0
       
    36 */
       
    37 class AknsAlAnimationFactory
       
    38     {
       
    39     public:
       
    40 
       
    41         /**
       
    42         * Creates a standard effect plugin (RenderLibrary). Ownership is
       
    43         * transferred to the caller. Can leave if constructing the plugin
       
    44         * fails.
       
    45         *
       
    46         * @return The created plugin, NULL is returned if there is no plugin
       
    47         *         that matches the provided UID.
       
    48         */
       
    49         IMPORT_C static CAknsRlEffectPlugin* CreateEffectPluginL( TUid aUid );
       
    50 
       
    51         /**
       
    52         * Creates an animation value. Ownership is transferred to the caller.
       
    53         * Can leave if constructing the animation value fails.
       
    54         *
       
    55         * @return The created animation value, NULL is returned if there is no
       
    56         *         value that matches the provided UID.
       
    57         */
       
    58         IMPORT_C static MAknsAlAnimationValue* CreateAnimationValueL( TUid aUid );
       
    59 
       
    60         /**
       
    61         * Creates a timing model. Ownership is transferred to the caller.
       
    62         * Can leave if constructing the timing model fails.
       
    63         *
       
    64         * @return The created timing model, NULL is returned if there is no
       
    65         *         timing model that matches the provided UID.
       
    66         */
       
    67         IMPORT_C static MAknsAlTimingModel* CreateTimingModelL( TUid aUid );
       
    68 
       
    69     private: // Prohibited constructors and destructor
       
    70         // Static class, prohibited.
       
    71         AknsAlAnimationFactory();
       
    72         // Static class, prohibited.
       
    73         ~AknsAlAnimationFactory();
       
    74     };
       
    75 
       
    76 #endif // AKNSALANIMATIONFACTORY_H
       
    77 
       
    78 // End of File