Collapse all Symbian^3 Product Developer Library

CAknsStringItemData Class Reference

class CAknsStringItemData : public CAknsItemData

String item data. String item data contains (in addition to base class members), a single string value. Item type for string item data objects is always EAknsITString.

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

AknSkins.lib

Since: 2.6

Inherits from

CAknsStringItemData
- CAknsItemData
  - CBase

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

Protected Member Functions
	CAknsStringItemData(const TAknsItemType)

Inherited Functions
	CAknsItemData::CAknsItemData(const TAknsItemType)
	CAknsItemData::SetType(const TAknsItemType)
	CAknsItemData::Type()const
	CAknsItemData::~CAknsItemData()
	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
	CAknsItemData::iType

Constructor & Destructor Documentation

CAknsStringItemData(const TAknsItemType)

CAknsStringItemData

(

const TAknsItemType

aType

)

[protected]

C++ protected constructor. Constructs a new CAknsStringItemData without an array.

Parameters

const TAknsItemType aType

Item type of the new item data object. While this is always EAknsITString for instances of this class, derived classes may specify another value.

~CAknsStringItemData()

~CAknsStringItemData

(

)

[virtual]

Destructor. Destroys owned string instance.

Member Functions Documentation

NewL()

IMPORT_C CAknsStringItemData *

NewL

(

)

[static]

Two-phased constructor. Constructs a new CAknsStringItemData object. String value must be set separately using SetStringL.

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

SetStringL(const TDesC &)

IMPORT_C void

SetStringL

(

const TDesC &

aValue

)

Sets the string value of this item data instance.

Since: 2.6

Parameters

const TDesC & aValue

New value. The value is copied to a newly created internal buffer, and any previous value is discarded.

String()

IMPORT_C const TDesC &

String

(

)

const

Returns a reference to the string value. The value is still owned by the item data object and caller must take its lifetime properly into account.

Since: 2.6

Member Data Documentation

HBufC * iString

HBufC *

iString

[protected]