Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: EIKRUTIL.H
Link against: eikcore.lib

Class EikResourceUtils

class EikResourceUtils;

Description

Provides utilities for reading standard resources.

Members

Defined in EikResourceUtils:
CreateColorArrayL(), CreateColorArrayLC(), CreateScreenFontL(), CreateScreenFontL(), ReadTInt16L(), ReadTInt32L(), ReadTInt8L()


Member functions


CreateScreenFontL()

static inline CFbsFont *CreateScreenFontL(TResourceReader &aResourceReader, CWsScreenDevice &aScreenDevice);

Description

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.

Parameters

TResourceReader &aResourceReader

The resource reader to use to read the font.

CWsScreenDevice &aScreenDevice

The screen device for which the font will be created.

Return value

CFbsFont *

Screen font object.


CreateScreenFontL()

static IMPORT_C CFbsFont *CreateScreenFontL(TInt aResourceId, CEikonEnv *aEnv=0);

Description

Creates a screen font.

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

Parameters

TInt aResourceId

ID of the resource from which to read the font.

CEikonEnv *aEnv

The UI environment for which the screen font will be created.

Return value

CFbsFont *

Pointer to the created screen font.


ReadTInt8L()

static inline TInt8 ReadTInt8L(TInt aResourceId, CEikonEnv *aEnv=0);

Description

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

Parameters

TInt aResourceId

The location in the resource to be read.

CEikonEnv *aEnv

The UI environment.

Return value

TInt8

The eight bits that follow the specified location in the resource.


ReadTInt16L()

static inline TInt16 ReadTInt16L(TInt aResourceId, CEikonEnv *aEnv=0);

Description

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

Parameters

TInt aResourceId

The location in the resource to be read.

CEikonEnv *aEnv

The UI environment.

Return value

TInt16

The 16 bits that follow the specified location in the resource.


ReadTInt32L()

static inline TInt32 ReadTInt32L(TInt aResourceId, CEikonEnv *aEnv=0);

Description

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

Parameters

TInt aResourceId

The location in the resource to be read.

CEikonEnv *aEnv

The UI environment.

Return value

TInt32

The 32 bits that follow the specified location in the resource.


CreateColorArrayL()

static IMPORT_C CColorArray *CreateColorArrayL(TInt aResourceId, CEikonEnv *aEnv=0);

Description

Creates an array of colours from a resource definition.

Parameters

TInt aResourceId

ID of the resource from which to read the colours.

CEikonEnv *aEnv

The UI environment in which the control colours are to be created. This is optional.

Return value

CColorArray *

Array of control colours.


CreateColorArrayLC()

static IMPORT_C CColorArray *CreateColorArrayLC(TInt aResourceId, CEikonEnv *aEnv=0);

Description

Creates an array of control colours from a resource definition and returns it on the cleanup stack.

Parameters

TInt aResourceId

ID of the resource from which to create the array of control colours.

CEikonEnv *aEnv

The UI environment in which the control colours are to be created.

Return value

CColorArray *

Array of control colours.