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

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

     5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

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

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

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

    14 * Description:  Cone Resource Loader API enables adding and removing 

    14 * Description:

    15 *                localized resource files into the CONE environment.

    23 // forward declarations

    23 #include <e32std.h>

    24 

    26 /** 

    27 NONSHARABLE_CLASS(RConeResourceLoader)

    27 * Class encapsulates methods for opening and closing localised resource files

    28 /**

    28 * in the CONE environment. The actual reading of resources from an opened 

    29 @deprecated

    29 * resource file is done using various CCoeEnv provided resource-reading 

    30 @see RCoeResourceLoader

    30 * methods. Cone Resource Loader API consist of the RConeResourceLoader class.

    31 @note For compatibility with S60 only

    31 *

    32 * Only one resource at a time may be open by one RConeResourceLoader instance. 

    33 * You can use several RConeResourceLoader instances for accessing several 

    34 * resources simultaneously or use one instance and close the previous resource

    35 * before opening a new one.

    36 *

    37 * The implementation uses BaflUtils::NearestLanguageFile to search for

    38 * a localised resource in proper search order.

    39 * 

    40 * Usage example:  

    41 *

    42 * @code

    43 *  #include <ConeResLoader.h>  

    44 *

    45 *  // Get CCoeEnv instance

    46 *  CEikonEnv* eikEnv = CEikonEnv::Static();

    47 *

    48 *  // Initialize loader

    49 *  RConeResourceLoader rLoader(eikEnv);

    50 *

    51 *  // Open resource file

    52 *  _LIT( KSampleResourceFileName, "Z:\\System\\Apps\\sample\\sample.rsc" );

    53 *  TFileName fileName(KSampleResourceFileName);

    54 *  rLoader.OpenL(fileName);

    55 *

    56 *  // Push resource loader to cleanup stack, so that it will always be properly 

    57 *  // closed when popped.

    58 *  CleanupClosePushL(rLoader);

    59 *

    60 *  // Read a resource   

    61 *  iSomeArray = eikEnv->ReadDesC16ArrayResourceL(R_SOME_RESOURCE);

    62 *

    63 *  // Pop and destroy rLoader from stack. 

    64 *  // This also calls close on rLoader since CleanupClosePushL was used.

    65 *  CleanupStack::PopAndDestroy(); // rLoader

    66 *

    67 * @endcode

    68 *

    69 * @lib commonengine.lib

    70 * @since S60 2.0

    72 class RConeResourceLoader

    33 	{

    73     {

    34 public:

    74     public:

    35 	IMPORT_C RConeResourceLoader(CCoeEnv& aCoeEnv);

    75         /**

    36 	IMPORT_C TInt Open(TFileName& aFileName);

    76          * Constructor. 

    37 	IMPORT_C void OpenL(TFileName& aFileName);

    77          *

    38 	IMPORT_C void Close();

    78          * @param aEnv is a reference to Control environment in which resource

    39 private:

    79          * is loaded.

    40 	// Dummy members to make this the same size as a RCoeResourceLoader so

    80          */

    41 	// in-place construction of the RCoeResourceLoader will work

    81         IMPORT_C RConeResourceLoader(CCoeEnv& aEnv);

    42 	void* iDummy1;	// was CCoeEnv&

    43 	TInt iDummy2;	// was TInt

    44 	};

    83         /**

    46 #endif	// CONERESLOADER_H

    84          * Opens the resource file for reading. Only one resource may be open 

    85          * at a time. Panics if this instance already has a file open. 

    86          * The implementation uses BaflUtils::NearestLanguageFile to search 

    87          * for a localized resource file in proper search order.

    88          * 

    89          * @param aFileName is the resource file name to open. This parameter

    90          * value is changed to the best matching language file found. The drive

    91          * letter is required in the filename.

    92          * @return a Symbian OS error code.

    93          *

    94          * @panic KErrNotSupported The instance already has a file open.

    95          */

    96         IMPORT_C TInt Open(TFileName& aFileName);