aknsitemid.h File Reference

API published in: S60 2nd Ed

Link against: aknskins.lib aknskinsrv.lib aknswallpaperutils.lib

Capability Information

Required Capabilities

None

#include <e32std.h>
#include <e32base.h>
#include "AknsItemID.inl"

Go to the source code of this file.


Data Structures
class   TAknsItemID
  Item identifier used to identify items supplied through skin interfaces. More...

Typedefs
typedef RArray< TAknsItemID >  RAknsItemIDArray
  Simple array of item ID objects.

Enumerations
enum   TAknsItemType {
  EAknsITUnknown = 0, EAknsITBitmap = 1, EAknsITMaskedBitmap = 2, EAknsITColorTable = 3,
  EAknsITImageTable = 4, EAknsITImage = 5, EAknsITBmpAnim = 6, EAknsITString = 7,
  EAknsITEffectQueue = 8, EAknsITAnimation = 9
}
  Type enumeration for skin items. More...
enum   TAknsImageAttribute {
  EAknsImageAttributeNone = 0x00, EAknsImageAttributeCoords = 0x01, EAknsImageAttributeSize = 0x02, EAknsImageAttributeStretch = 0x04,
  EAknsImageAttributeTile = 0x08, EAknsImageAttributeAlign = 0x10, EAknsImageAttributeScale = 0x20, EAknsImageAttributeTileX = 0x40,
  EAknsImageAttributeTileY = 0x80, EAknsImageAttributeNBC = 0x100
}
  Image attribute enumeration for image skin items. More...
enum   TAknsImageAlignment {
  EAknsImageAlignNone = 0x00, EAknsImageAlignVTop = 0x01, EAknsImageAlignVBottom = 0x02, EAknsImageAlignVCenter = 0x04,
  EAknsImageAlignHLeft = 0x08, EAknsImageAlignHRight = 0x10, EAknsImageAlignHCenter = 0x20, EAknsImageAlignTL = EAknsImageAlignVTop|EAknsImageAlignHLeft,
  EAknsImageAlignTR = EAknsImageAlignVTop|EAknsImageAlignHRight, EAknsImageAlignTC = EAknsImageAlignVTop|EAknsImageAlignHCenter, EAknsImageAlignBL = EAknsImageAlignVBottom|EAknsImageAlignHLeft, EAknsImageAlignBR = EAknsImageAlignVBottom|EAknsImageAlignHRight,
  EAknsImageAlignBC = EAknsImageAlignVBottom|EAknsImageAlignHCenter, EAknsImageAlignCL = EAknsImageAlignVCenter|EAknsImageAlignHLeft, EAknsImageAlignCR = EAknsImageAlignVCenter|EAknsImageAlignHRight, EAknsImageAlignCC = EAknsImageAlignVCenter|EAknsImageAlignHCenter,
  EAknsImageAlignVMask, EAknsImageAlignHMask
}
  Image alignment enumeration for image skin items. More...

Functions
TBool  operator== (const TAknsItemID &aFirst, const TAknsItemID &aSecond)
  C++ equal operator.
TBool  operator!= (const TAknsItemID &aFirst, const TAknsItemID &aSecond)
  C++ not equal operator.

Typedef Documentation

typedef RArray<TAknsItemID> RAknsItemIDArray
 

Simple array of item ID objects.

Enumeration Type Documentation

enum TAknsImageAlignment
 

Image alignment enumeration for image skin items.

Enumerator:
EAknsImageAlignNone 
EAknsImageAlignVTop 
EAknsImageAlignVBottom 
EAknsImageAlignVCenter 
EAknsImageAlignHLeft 
EAknsImageAlignHRight 
EAknsImageAlignHCenter 
EAknsImageAlignTL 
EAknsImageAlignTR 
EAknsImageAlignTC 
EAknsImageAlignBL 
EAknsImageAlignBR 
EAknsImageAlignBC 
EAknsImageAlignCL 
EAknsImageAlignCR 
EAknsImageAlignCC 
EAknsImageAlignVMask 
EAknsImageAlignHMask 
enum TAknsImageAttribute
 

Image attribute enumeration for image skin items.

Enumerator:
EAknsImageAttributeNone  No attribute defined.
EAknsImageAttributeCoords  Image should be placed acording to the given coordinates.

Currently unsupported.

EAknsImageAttributeSize  Image size should stretched to the given size.

Currently used only with application icons as a search shortcut.

EAknsImageAttributeStretch  Image should be stretched to cover the entire layout area.

Aspect ratio is not preserved.

EAknsImageAttributeTile  Image should be tiled (in both directions) to fill the area.
EAknsImageAttributeAlign  Image should be aligned according to the given parameter.
EAknsImageAttributeScale  Image should be scaled to fill the area maintaining the aspect ratio.

Currently unsupported.

EAknsImageAttributeTileX  Image should be tiled in X-axis direction to fill the area.
EAknsImageAttributeTileY  Image should be tiled in Y-axis direction to fill the area.
EAknsImageAttributeNBC  The item is already scalability-aware and backward compatibility should not be applied to it.
enum TAknsItemType
 

Type enumeration for skin items.

Enumerator:
EAknsITUnknown  Unknown type, used by CAknsItemDef.
EAknsITBitmap  Bitmap type, used by CAknsBitmapItemData and CAknsBitmapItemDef.
EAknsITMaskedBitmap  Masked bitmap type, used by CAknsMaskedBitmapItemData and CAknsMaskedBitmapItemDef.
EAknsITColorTable  Color table type, used by CAknsColorTableItemData and CAknsColorTableItemDef.
EAknsITImageTable  Image table type, used by CAknsImageTableItemData and CAknsImageTableItemDef.
EAknsITImage  Image type, used by CAknsImageItemData and CAknsImageItemDef.
EAknsITBmpAnim  Bitmap animation type, used by CAknsBmpAnimItemData and CAknsBmpAnimItemDef.
EAknsITString  String property type, used by CAknsStringItemData.
EAknsITEffectQueue  Scalable item effect queue type, used by CAknsEffectQueueItemData.
EAknsITAnimation  Animation type, used by CAknsAnimationItemData.

Function Documentation

TBool operator!= (  const TAknsItemID &  aFirst,
const TAknsItemID &  aSecond
)  [inline]
 

C++ not equal operator.

Checks whether two item ID objects (i.e. their major and minor parts) have identical content.

Parameters:
aFirst  First object to be compared.
aSecond  Second object to be compared.
Returns:
false if objects have identical content, true otherwise.
TBool operator== (  const TAknsItemID &  aFirst,
const TAknsItemID &  aSecond
)  [inline]
 

C++ equal operator.

Checks whether two item ID objects (i.e. their major and minor parts) have identical content.

Parameters:
aFirst  First object to be compared.
aSecond  Second object to be compared.
Returns:
true if objects have identical content, false otherwise.
Copyright © Nokia Corporation 2001-2008
Back to top