S60 3rd Edition API Reference: aknsitemid.h Source File

00001 /*
00002 * ==============================================================================
00003 *  Name        : AknsItemID.h
00004 *  Part of     : Avkon Skins / Skin Server
00005 *  Interface   : ?Interface_category, ?Interface_name
00006 *  Description : Defines the item id class used to identify the skin items.
00007 *  Version     : ?Version
00008 *
00009 *  Copyright � 2002-2004 Nokia Corporation.
00010 *  This material, including documentation and any related 
00011 *  computer programs, is protected by copyright controlled by 
00012 *  Nokia Corporation. All rights are reserved. Copying, 
00013 *  including reproducing, storing, adapting or translating, any 
00014 *  or all of this material requires the prior written consent of 
00015 *  Nokia Corporation. This material also contains confidential 
00016 *  information which may not be disclosed to others without the 
00017 *  prior written consent of Nokia Corporation.
00018 * ==============================================================================
00019 */
00020 
00021 #ifndef AKNSITEMID_H
00022 #define AKNSITEMID_H
00023 
00024 //  INCLUDES
00025 #include <e32std.h>
00026 #include <e32base.h>
00027 
00028 // DATA TYPES
00029 
00035 enum TAknsItemType
00036     {
00040     EAknsITUnknown      =0, 
00041 
00045     EAknsITBitmap       =1, 
00046 
00051     EAknsITMaskedBitmap =2, 
00052 
00057     EAknsITColorTable   =3, 
00058 
00063     EAknsITImageTable   =4, 
00064 
00068     EAknsITImage        =5,
00069 
00073     EAknsITBmpAnim      =6,
00074 
00080     EAknsITString       =7,
00081 
00087     EAknsITEffectQueue  =8,
00088 
00092     EAknsITAnimation    =9
00093     };
00094 
00100 enum TAknsImageAttribute
00101     {
00106     EAknsImageAttributeNone     =0x00,
00107 
00113     EAknsImageAttributeCoords   =0x01,
00114 
00120     EAknsImageAttributeSize     =0x02,
00121 
00127     EAknsImageAttributeStretch  =0x04,
00128 
00133     EAknsImageAttributeTile     =0x08,
00134 
00139     EAknsImageAttributeAlign    =0x10,
00140     
00147     EAknsImageAttributeScale    =0x20,
00148 
00153     EAknsImageAttributeTileX    =0x40,
00154 
00159     EAknsImageAttributeTileY    =0x80,
00160 
00167     EAknsImageAttributeNBC     =0x100
00168     };
00169 
00175 enum TAknsImageAlignment
00176     {
00177     EAknsImageAlignNone     =0x00,
00178     EAknsImageAlignVTop     =0x01,
00179     EAknsImageAlignVBottom  =0x02,
00180     EAknsImageAlignVCenter  =0x04,
00181     EAknsImageAlignHLeft    =0x08,
00182     EAknsImageAlignHRight   =0x10,
00183     EAknsImageAlignHCenter  =0x20,
00184     EAknsImageAlignTL       =EAknsImageAlignVTop|EAknsImageAlignHLeft,
00185     EAknsImageAlignTR       =EAknsImageAlignVTop|EAknsImageAlignHRight,
00186     EAknsImageAlignTC       =EAknsImageAlignVTop|EAknsImageAlignHCenter,
00187     EAknsImageAlignBL       =EAknsImageAlignVBottom|EAknsImageAlignHLeft,
00188     EAknsImageAlignBR       =EAknsImageAlignVBottom|EAknsImageAlignHRight,
00189     EAknsImageAlignBC       =EAknsImageAlignVBottom|EAknsImageAlignHCenter,
00190     EAknsImageAlignCL       =EAknsImageAlignVCenter|EAknsImageAlignHLeft,
00191     EAknsImageAlignCR       =EAknsImageAlignVCenter|EAknsImageAlignHRight,
00192     EAknsImageAlignCC       =EAknsImageAlignVCenter|EAknsImageAlignHCenter,
00193     EAknsImageAlignVMask    =EAknsImageAlignVTop|EAknsImageAlignVBottom|
00194                              EAknsImageAlignVCenter,
00195     EAknsImageAlignHMask    =EAknsImageAlignHLeft|EAknsImageAlignHRight|
00196                              EAknsImageAlignHCenter
00197     };
00198 
00206 enum TAknsLayoutType 
00207     {
00208     EAknsLayoutUnknown      = 0,
00209     EAknsLayoutPortrait     = 1,
00210     EAknsLayoutLandscape    = 2,
00211     EAknsLayoutLegacy       = 3
00212     };
00213 
00214 // FORWARD DECLARATIONS
00215 
00216 class CFbsBitmap;
00217 
00218 // CLASS DECLARATION
00219 
00231 class TAknsItemID
00232     {    
00233     public: // New functions
00234 
00242         inline void Set( const TInt aMajor, const TInt aMinor );
00243 
00252         inline void Set( const TUid aMajor, const TInt aMinor );
00253         
00259         inline void Set( const TAknsItemID& aID );
00260 
00281         IMPORT_C static TInt LinearOrder(
00282             const TAknsItemID& aFirst, const TAknsItemID& aSecond );
00283 
00284     public: // Data
00285 
00286         TInt iMajor;    
00287         TInt iMinor;    
00288 
00289     };
00290 
00291 // DATA TYPES (continued)
00292 
00296 typedef RArray<TAknsItemID> RAknsItemIDArray;
00297 
00298 // FUNCTION PROTOTYPES
00299 
00311 inline TBool operator==( const TAknsItemID& aFirst, const TAknsItemID& aSecond );
00312 
00324 inline TBool operator!=( const TAknsItemID& aFirst, const TAknsItemID& aSecond );
00325 
00326 // INLINED MEMBERS
00327 
00328 #include "AknsItemID.inl"
00329 
00330 // AKNSITEMID_H   
00331 #endif
00332 
00333 // End of File