Collapse all Symbian^3 Application Developer Library

CAknsStringItemDef Class Reference

class CAknsStringItemDef : public CAknsItemDef

String item definition. String item definition consists of (in addition to base class data) a single string value. Item type for string item definitions is EAknsITString

This is a public class with exported functions. The class is not intended for derivation outside the library.

AknSkinSrv.lib

Since: 2.6

Inherits from

CAknsStringItemDef
- CAknsItemDef
  - CBase

Public Member Functions
	~CAknsStringItemDef ()
IMPORT_C CAknsStringItemDef *	NewL (const TAknsItemID &)
IMPORT_C void	SetStringL (const TDesC &)
IMPORT_C const TDesC &	String ()

Protected Member Functions
	CAknsStringItemDef (const TAknsItemType , const TAknsItemID &)

Inherited Functions
	CAknsItemDef::CAknsItemDef(const TAknsItemType,const TAknsItemID &)
	CAknsItemDef::ID()const
	CAknsItemDef::LinearOrder(const CAknsItemDef &,const CAknsItemDef &)
	CAknsItemDef::Type()const
	CAknsItemDef::~CAknsItemDef()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Protected Attributes
HBufC *	iString

Inherited Attributes
	CAknsItemDef::iID
	CAknsItemDef::iSpare1
	CAknsItemDef::iSpare2
	CAknsItemDef::iType

Constructor & Destructor Documentation

CAknsStringItemDef(const TAknsItemType, const TAknsItemID &)

CAknsStringItemDef	(	const TAknsItemType	aType,
		const TAknsItemID &	aID
	)	[protected]

C++ constructor for internal use. Constructs an string item definition object with given ID.

Since: 2.6

Parameters

const TAknsItemType aType	Type of the definition object. While this is always EAknsITString for CAknsStringItemDef objects, derived classes may specify other values.
const TAknsItemID & aID	Item ID of the new item definition.

~CAknsStringItemDef()

~CAknsStringItemDef

(

)

[virtual]

Destructor.

Member Functions Documentation

NewL(const TAknsItemID &)

IMPORT_C CAknsStringItemDef *

NewL

(

const TAknsItemID &

aID

)

[static]

Two-phased constructor. Constructs a new string item definition object.

Since: 2.6

Exceptions:: If allocation fails, function leaves with a system-wide error code.

Parameters

const TAknsItemID & aID

Item ID of the new object.

SetStringL(const TDesC &)

IMPORT_C void

SetStringL

(

const TDesC &

aString

)

Sets the string, content of the descriptor is copied into an internal buffer. If CAknsStringItemDef object already owns a filename descriptor, it is deleted.

Since: 2.6

Exceptions:: If allocation fails, function leaves with a system-wide error code.

Parameters

const TDesC & aString

Reference to the descriptor containing new value. Content of the descriptor is copied into an internal buffer owned by CAknsStringItemDef.

String()

IMPORT_C const TDesC &

String

(

)

const

Returns a reference to the string value of this item definition.

Since: 2.6

Member Data Documentation

HBufC * iString

HBufC *

iString

[protected]