CAknsImageTableItemData 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 CAknsImageItemData.
Inherited by CAknsBmpAnimItemData.
Detailed Description
Icon table item data.
Icon table item data contains (in addition to base class members), an array containing item IDs of images. Item type for image
table item data objects is always EAknsITImageTable.
This is a public class with exported functions. The class is not intended for derivation outside the library.
Constructor & Destructor Documentation
| virtual CAknsImageTableItemData::~CAknsImageTableItemData |
( |
|
) |
[virtual] |
|
|
|
Destructor.
Destroys image array.
|
| CAknsImageTableItemData::CAknsImageTableItemData |
( |
const TAknsItemType
|
aType
|
) |
[protected] |
|
|
|
C++ protected constructor.
Constructs a new CAknsImageTableItemData without an array.
- Parameters:
-
|
aType
|
Item type of the new item data object. While this is always EAknsITImageTable for instances of this class, derived classes may specify another value.
|
|
Member Function Documentation
| IMPORT_C TAknsItemID CAknsImageTableItemData::ImageIID
|
( |
const TInt |
aIndex
|
) |
const |
|
|
|
Returns the item ID of an image.
- Parameters:
-
|
aIndex
|
Index of the image. This value must be within 0 (inclusive) and NumberOfImages (exclusive). |
- Returns:
- Item ID of the image.
|
| IMPORT_C TAknsItemID* CAknsImageTableItemData::Images
|
( |
|
) |
const |
|
|
|
Returns pointer to the first entry in the image array, owned by this object.
- Returns:
- Pointer to TAknsItemID.
|
|
|
Two-phased constructor.
Constructs a new CAknsImageTableItemData object. Values must be set separately using SetImagesL.
- Returns:
- Newly constructed CAknsImageTableItemData object.
- Exceptions:
- If allocation fails, function leaves with a system-wide error code.
Reimplemented in CAknsBmpAnimItemData.
|
| IMPORT_C TInt CAknsImageTableItemData::NumberOfImages |
( |
|
) |
const |
|
|
|
Returns the number of images.
- Returns:
- Number of images as an integer.
|
| IMPORT_C void CAknsImageTableItemData::SetImagesL |
( |
const TInt |
aNumberOfImages,
|
|
|
const TAknsItemID *
|
aImages |
|
) |
|
|
|
|
Sets image table values for this item data instance.
- Parameters:
-
|
aNumberOfImages
|
Number of images in aImages. |
|
aImages
|
Pointer to first image ID. Values are copied into an internal array. |
|
Field Documentation
The documentation for this class was generated from the following file:
