epoc32/include/mw/eikrutil.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/eikrutil.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations

// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// 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
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#ifndef __EIKRUTIL_H__
#define __EIKRUTIL_H__

#include <e32std.h>
#include <gulutil.h>

class CFbsFont;
class CEikonEnv;
class CWsScreenDevice;
class TResourceReader;


/** Provides utilities for reading standard resources. 

@publishedAll 
@released */
NONSHARABLE_CLASS(EikResourceUtils)
	{
public:
	inline static CFbsFont* CreateScreenFontL(TResourceReader& aResourceReader,CWsScreenDevice& aScreenDevice);
	IMPORT_C static CFbsFont* CreateScreenFontL(TInt aResourceId,CEikonEnv* aEnv=NULL);
	inline static TInt8 ReadTInt8L(TInt aResourceId,CEikonEnv* aEnv=NULL);
	inline static TInt16 ReadTInt16L(TInt aResourceId,CEikonEnv* aEnv=NULL);
	inline static TInt32 ReadTInt32L(TInt aResourceId,CEikonEnv* aEnv=NULL);
	IMPORT_C static CColorArray* CreateColorArrayL(TInt aResourceId,CEikonEnv* aEnv=NULL);
	IMPORT_C static CColorArray* CreateColorArrayLC(TInt aResourceId,CEikonEnv* aEnv=NULL);
private:
	enum TResourceTypeInt { EResourceInt8,EResourceInt16,EResourceInt32 };
private:
	IMPORT_C static TInt32 ReadResourceIntL(TInt aResourceId, CEikonEnv* aEnv, TResourceTypeInt aSize);
	EikResourceUtils();
	};

/** Create a screen font from resource.

Creates a font for the specified screen device by reading a font UID and font 
flags from the given position in a resource. Returns a pointer to the font 
and transfers ownership.

@param aResourceReader The resource reader to use to read the font. 
@param aScreenDevice The screen device for which the font will be created. 
@return Screen font object. */
inline CFbsFont* EikResourceUtils::CreateScreenFontL(TResourceReader& aResourceReader,CWsScreenDevice& aScreenDevice)
	{	return(ResourceUtils::CreateScreenFontL(aResourceReader,aScreenDevice));	}

/** Gets the 8 bit signed integer held in a specified resource location.

@param aResourceId The location in the resource to be read. 
@param aEnv The UI environment. 
@return The eight bits that follow the specified location in the resource. */
inline TInt8 EikResourceUtils::ReadTInt8L(TInt aResourceId,CEikonEnv* aEnv)
	{	return static_cast<TInt8>(ReadResourceIntL(aResourceId,aEnv,EResourceInt8));	}

/** Gets the 16 bit signed integer held in a specified resource location.

@param aResourceId The location in the resource to be read. 
@param aEnv The UI environment. 
@return The 16 bits that follow the specified location in the resource. */
inline TInt16 EikResourceUtils::ReadTInt16L(TInt aResourceId,CEikonEnv* aEnv)
	{	return static_cast<TInt16>(ReadResourceIntL(aResourceId,aEnv,EResourceInt16));	}

/** Gets the 32 bit signed integer held in a specified resource location.

@param aResourceId The location in the resource to be read. 
@param aEnv The UI environment. 
@return The 32 bits that follow the specified location in the resource. */
inline TInt32 EikResourceUtils::ReadTInt32L(TInt aResourceId,CEikonEnv* aEnv)
	{	return static_cast<TInt32>(ReadResourceIntL(aResourceId,aEnv,EResourceInt32));	}

#endif	// __EIKRUTIL_H__