commonuis/CommonUi/LibLoad/inc/commonuimpengineapiloader.h
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     1 /*
       
     2 * Copyright (c) 2006 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:  Loads MPEngine.dll dynamically.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_COMMONUIMPENGINEAPILOADER
       
    20 #define C_COMMONUIMPENGINEAPILOADER
       
    21 
       
    22 #include <e32base.h>
       
    23 #include <f32file.h>
       
    24 
       
    25 class MDesCArray;
       
    26 class CStreamingLinkModel;
       
    27 
       
    28 /**
       
    29 *  Interface class for creating a new RAM file.
       
    30 *  
       
    31 *  @lib CommonUiMPEngineApiLoader.lib
       
    32 *  @since Series 60 3.1
       
    33 */
       
    34 class MCommonUiMPEngineApiLoader
       
    35     {
       
    36     public:
       
    37 
       
    38         /**
       
    39         * Pure virtual method for creating a new RAM file.
       
    40         * @param aNewRamFileName, New RAM file.
       
    41         * @param aLinkArray, Array which contains links which are 
       
    42             saved to RAM file.
       
    43         * @param aOverWrite, Overwrite existing file or not.
       
    44         * @return KErrNone or one of the system wide error codes. 
       
    45         * @since Series 60 3.1
       
    46         */
       
    47         virtual TInt CreateNewLinkFileL(
       
    48             const TDesC& aFileName, 
       
    49             MDesCArray* aLinkArray, 
       
    50             TBool aOverWrite ) = 0;
       
    51     };
       
    52 
       
    53 /**
       
    54 *  This class is for dynamically loading commonuimpengineapiloader.dll that 
       
    55 *  enables creating a new RAM file.
       
    56 *
       
    57 *  @lib commonuimpengineapiloader.lib
       
    58 *  @since Series 60 3.1
       
    59 */
       
    60 class CCommonUiMPEngineApiLoader : public CBase, public MCommonUiMPEngineApiLoader
       
    61     {
       
    62 public:
       
    63     /**
       
    64     * Two-phased constructor.
       
    65     * @return new instance of CCommonUiMPEngineApiLoader.
       
    66     */
       
    67     static CCommonUiMPEngineApiLoader* NewL();
       
    68 
       
    69     /**
       
    70     * Destructor.
       
    71     */
       
    72     virtual ~CCommonUiMPEngineApiLoader();
       
    73 
       
    74     /**
       
    75     * Create a new RAM file.
       
    76     * @param aNewRamFileName, New RAM file.
       
    77     * @param aLinkArray, Array which contains links which are 
       
    78         saved to RAM file.
       
    79     * @param aOverWrite, Overwrite existing file or not.
       
    80     * @return KErrNone or one of the system wide error codes. 
       
    81     */
       
    82     TInt CreateNewLinkFileL(
       
    83         const TDesC& aFileName, 
       
    84         MDesCArray* aLinkArray, 
       
    85         TBool aOverWrite );
       
    86 
       
    87 private:
       
    88 
       
    89     /**
       
    90     * C++ default constructor.
       
    91     */
       
    92     CCommonUiMPEngineApiLoader();
       
    93 
       
    94     /**
       
    95     * By default Symbian 2nd phase constructor is private.
       
    96     */
       
    97     void ConstructL();
       
    98     
       
    99 private: // data
       
   100 
       
   101     CStreamingLinkModel* iMPlayerModel;
       
   102 
       
   103     };
       
   104 
       
   105 // Environment gate function
       
   106 IMPORT_C TAny* GateFunction();
       
   107 
       
   108 #endif // C_COMMONUIMPENGINEAPILOADER
       
   109 
       
   110 // End of File