CAknsStringItemData Class Reference
API published in: S60 2nd Ed
Link against: aknskins.lib aknskinsrv.lib aknswallpaperutils.lib
Capability Information
Required Capabilities
None
#include <aknsitemdata.h>
Inherits CAknsItemData.
Detailed Description
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.
|
Public Member Functions
|
| virtual |
~CAknsStringItemData ()
|
| |
Destructor.
|
| IMPORT_C void |
SetStringL (const TDesC &aValue)
|
| |
Sets the string value of this item data instance.
|
| IMPORT_C const TDesC & |
String () const
|
| |
Returns a reference to the string value.
|
Static Public Member Functions
|
| static IMPORT_C CAknsStringItemData *
|
NewL ()
|
| |
Two-phased constructor.
|
Protected Member Functions
|
| |
CAknsStringItemData (const TAknsItemType aType)
|
| |
C++ protected constructor.
|
Protected Attributes
|
| HBufC * |
iString |
| |
Buffer for string value.
|
Constructor & Destructor Documentation
| virtual CAknsStringItemData::~CAknsStringItemData |
( |
|
) |
[virtual] |
|
|
|
Destructor.
Destroys owned string instance.
|
| CAknsStringItemData::CAknsStringItemData |
( |
const TAknsItemType
|
aType
|
) |
[protected] |
|
|
|
C++ protected constructor.
Constructs a new CAknsStringItemData without an array.
- Parameters:
-
|
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.
|
|
Member Function Documentation
|
|
Two-phased constructor.
Constructs a new CAknsStringItemData object. String value must be set separately using SetStringL.
- Returns:
- Newly constructed CAknsStringItemData object.
- Exceptions:
- If allocation fails, function leaves with a system-wide error code.
|
| IMPORT_C void CAknsStringItemData::SetStringL |
( |
const TDesC & |
aValue
|
) |
|
|
|
|
Sets the string value of this item data instance.
- Parameters:
-
|
aValue
|
New value. The value is copied to a newly created internal buffer, and any previous value is discarded. |
|
| IMPORT_C const TDesC& CAknsStringItemData::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.
- Returns:
- Reference to the value.
|
Field Documentation
The documentation for this class was generated from the following file:
