/*

* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Defines public item data classes.

*

*/

#ifndef AKNSITEMDATA_H

#define AKNSITEMDATA_H

// INCLUDES

#include <AknsItemID.h>

#include <AknsRlEffect.h>

#include <gdi.h>

// FORWARD DECLARATIONS

class CFbsBitmap;

struct TAknsAppIconInfo;

struct TAknsImageAttributeData;

struct TAknsColorTableEntry;

struct TAknsBmpAnimFrameInfo;

class CAknsEffectParameter;

class MAknsRlCommandIterator;

class MAknsAlIterator;

class CAknsNamedReference;

class CAknsSizeBoundParameter;

struct TAknsAlAnimationCommandData;

struct TAknsAlTimingModelData;

struct TAknsAlAnimationValueData;

struct TAknsAlNamedReferenceData;

struct TAknsAlSizeBoundParameterData;

// CLASS DECLARATIONS

/**

* Base class for item data classes.

* Item data encapsulates type information and resource instance (such as 

* CFbsBitmap object) of a specific skin item. Since actual data entries vary 

* depending on the type of the item, CAknsItemData contains only type 

* information and can not be instantiated. 

*

* This is a public class with exported functions.

* The class is not intended for derivation outside the library.

*

* @lib AknSkins.lib

*

* @since 2.0

*/

NONSHARABLE_CLASS(CAknsItemData) : public CBase

    {

    public:  // Constructors and destructor

        /**

        * Destructor.

        * CAknsItemData itself has no dynamically allocated members, but

        * derived classes may have them.

        */

        virtual ~CAknsItemData();

    public: // New functions

        /**

        * Sets the perceived type of this item without affecting the

        * real instance inheritance.

        *

        * @since 2.8

        *

        * @internal

        *

        * @param aType New type.

        */

        void SetType( const TAknsItemType aType );

        /**

        * Returns the type of the item data object. 

        * This method can be used to provide run-time type information.

        * Corresponding classes are listed in definition of ::TAknsItemType.

        *

        * @since 2.0

        *

        * @return Type of the item data as TAknsItemType.

        */

        IMPORT_C TAknsItemType Type() const;

    protected: // C++ protected constructor for derived classes

        /**

        * C++ constructor for derived classes.

        * Constructs item data object with given item type.

        *

        * @param aType Item type of the new item data object.

        *

        * @internal

        */

        CAknsItemData( const TAknsItemType aType );    

    protected:  // Data

        TAknsItemType iType;    //!< Type of the item data object.

    };

/**

* Image item data.

* Image item data contains (in addition to base class members) image 

* attributes, such as size or alignment. Item type for image item data

* objects is ::EAknsITImage.

*

* This is a public class with exported functions.

* The class is not intended for derivation outside the library.

*

* @lib AknSkins.lib

*

* @since 2.0

*/

NONSHARABLE_CLASS(CAknsImageItemData) : public CAknsItemData

    {

    public:  // Constructors and destructor

        /**

        * Destructor.        

        */

        virtual ~CAknsImageItemData();

    public: // New functions

        /**

        * Sets the image attributes for this image item data object.

        *

        * @since 2.0

        *

        * @param aAttributes Attribute data structure containing the new 

        *   values.

        */

        IMPORT_C void SetAttributesL( 

            const TAknsImageAttributeData& aAttributes );

        /**

        * Returns a pointer to the image attribute structure owned by the

        * item data object.

        *

        * @since 2.0

        *

        * @return Pointer to the image attribute structure, or @c NULL if

        *   there is none.

        */

        IMPORT_C const TAknsImageAttributeData* Attributes() const;

        IMPORT_C void SetParentIID(const TAknsItemID& aIID);

        IMPORT_C void SetDrawRect(const TRect& aRect);

        IMPORT_C TAknsItemID ParentIID();

        IMPORT_C TRect DrawRect();

    protected: // C++ protected constructor for derived classes

        /**

        * C++ constructor for derived classes.

        * Constructs an image item data object with given item type.

        *

        * @param aType Item type of the new item data object.

        *

        * @internal

        */

        CAknsImageItemData( const TAknsItemType aType );

    protected:  // Data

        TAknsImageAttributeData* iAttributeData;

        TAknsItemID iParentIID;

        TRect iDrawRect;

    };

/**

* Bitmap item data.

* Bitmap item data contains (in addition to base class members) CFbsBitmap

* instance of the bitmap. Item type for bitmap item data is always 

* ::EAknsITBitmap.

*

* This is a public class with exported functions.

* The class is not intended for derivation outside the library.

*

* @lib AknSkins.lib

*

* @since 2.0

*/

NONSHARABLE_CLASS(CAknsBitmapItemData) : public CAknsImageItemData

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        * Constructs a new CAknsBitmapItemData object with bitmap set to

        * @c NULL. Bitmap must be set afterwards by using 

        * SetBitmap(CFbsBitmap* aBitmap) method.

        *

        * @return Newly constructed CAknsBitmapItemData object.

        *

        * @par Exceptions:

        *   If allocation fails, function leaves with a system-wide error

        *   code.

        */

        IMPORT_C static CAknsBitmapItemData* NewL();

        /**

        * Destructor.

        * Deletes bitmap object, if present.

        */

        virtual ~CAknsBitmapItemData();

    public: // New functions

        /**

        * Sets the bitmap object for this item data instance.

        *

        * @since 2.0

        *

        * @c NULL value can be used to detach bitmap from item data.

        *

        * @param aBitmap Pointer to bitmap instance. Ownership of the bitmap

        *   object is transferred to item data. @c NULL value is also valid.

        */

        IMPORT_C void SetBitmap( CFbsBitmap* aBitmap );

        /**

        * Sets the bitmap object for this item data instance and destroys 

        * previous one, if any.

        *

        * @since 2.0

        *

        * @param aBitmap Pointer to bitmap instance. Ownership of the bitmap

        *   object is transferred to item data. @c NULL value is also valid.

        */

        IMPORT_C void DestroyAndSetBitmap( CFbsBitmap* aBitmap );

        /**

        * Returns the current bitmap object owned by item data instance.

        *

        * @since 2.0

        *

        * @return Pointer to bitmap instance, or @c NULL if none is currently

        *   associated with this item data.

        */

        IMPORT_C CFbsBitmap* Bitmap();

    protected:  // C++ protected constructor

        /**

        * C++ protected constructor.

        * Constructs a new CAknsBitmapItemData with bitmap set to @c NULL.

        *

        * @param aType Item type of the new item data object. While this

        *   is always ::EAknsITBitmap for instances of this class, derived

        *   classes may specify another value.

        *

        * @internal

        */

        CAknsBitmapItemData( const TAknsItemType aType );

    protected:  // Data

        CFbsBitmap* iBitmap;    //!< Pointer to associated bitmap instance.

    };

/**

* Masked bitmap item data.

* Masked bitmap item data contains (in addition to base class members) an

* additional member of type CFbsBitmap for the bitmap mask.

* Item type for bitmap item data is always ::EAknsITMaskedBitmap.

*

* This is a public class with exported functions.

* The class is not intended for derivation outside the library.

*

* @lib AknSkins.lib

*

* @since 2.0

*/

NONSHARABLE_CLASS(CAknsMaskedBitmapItemData) : public CAknsBitmapItemData

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        * Constructs a new CAknsMaskedBitmapItemData object with bitmaps set to

        * @c NULL. Bitmaps must be set afterwards by using 

        * SetBitmap(CFbsBitmap* aBitmap) and SetMask(CFbsBitmap* aBitmap) methods.

        *

        * @return Newly constructed CAknsMaskedBitmapItemData object.

        *

        * @par Exceptions:

        *   If allocation fails, function leaves with a system-wide error

        *   code.

        */

        IMPORT_C static CAknsMaskedBitmapItemData* NewL();

        /**

        * Destructor.

        * Deletes bitmap objects, if present.

        */

        virtual ~CAknsMaskedBitmapItemData();

    public: // New functions

        /**

        * Sets the mask bitmap object for this item data instance.

        * @c NULL value can be used to detach bitmap mask from item data.

        *

        * @since 2.0

        *

        * @param aMask Pointer to mask instance. Ownership of the bitmap

        *   object is transferred to item data. @c NULL value is also valid.

        */

        IMPORT_C void SetMask( CFbsBitmap* aMask );

        /**

        * Sets the mask bitmap object for this item data instance and destroys 

        * previous one, if any.

        *

        * @since 2.0

        *

        * @param aMask Pointer to mask instance. Ownership of the bitmap

        *   object is transferred to item data. @c NULL value is also valid.

        */

        IMPORT_C void DestroyAndSetMask( CFbsBitmap* aMask );

        /**

        * Returns the current bitmap mask object owned by item data instance.

        *

        * @since 2.0

        *

        * @return Pointer to mask instance, or @c NULL if none is currently

        *   associated with this item data.

        */

        IMPORT_C CFbsBitmap* Mask();

    protected:  // C++ protected constructor

        /**

        * C++ protected constructor.

        * Constructs a new CAknsMaskedBitmapItemData with bitmaps set to @c NULL.

        *

        * @param aType Item type of the new item data object. While this

        *   is always ::EAknsITMaskedBitmap for instances of this class, derived

        *   classes may specify another value.

        *

        * @internal

        */

        CAknsMaskedBitmapItemData( const TAknsItemType aType );    

    protected:  // Data

        CFbsBitmap* iMask;    //!< Pointer to associated mask bitmap instance.

    };

/**

* Color table item data.

* Color table item data contains (in addition to base class members) color 

* array of TRGB values. Item type for color item data is always 

* ::EAknsITColorTable.

*

* This is a public class with exported functions.

* The class is not intended for derivation outside the library.

*

* @lib AknSkins.lib

*

* @since 2.0

*/

NONSHARABLE_CLASS(CAknsColorTableItemData) : public CAknsImageItemData

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        * Constructs a new CAknsColorTableItemData object. Values must

        * be set separately using SetColorsL.

        *

        * @return Newly constructed CAknsColorTableItemData object.

        *

        * @par Exceptions:

        *   If allocation fails, function leaves with a system-wide error

        *   code.

        */

        IMPORT_C static CAknsColorTableItemData* NewL();

        /**

        * Destructor.

        * Destroys color value array.

        */

        virtual ~CAknsColorTableItemData();

    public: // New functions

        /**

        * Sets color values for this item data instance.

        *        

        * @since 2.0

        *

        * @param aNumberOfColors Number of colors in aColors.

        *

        * @param aColors Pointer to first color value. Values are copied

        *   into an internal array.

        */

        IMPORT_C void SetColorsL( const TInt aNumberOfColors, 

            const TAknsColorTableEntry* aColors );

        /**

        * Returns the indexed color value.

        *

        * @since 2.0

        *

        * @param aIndex Index of the color to be retrieved. This must

        *   be within 0 (inclusive) and aNumberOfColors (exclusive).

        *

        * @return Color value as TInt. If the value is -1, RGB value

        *   should be queried instead.

        *

        * @par Note:

        *   This method does not perform any bounds checking. An access

        *   violation or panic will occur, if the given index is not

        *   within the bounds of the internal array. Use @c GetColorL

        *   instead, if such checking is required.

        */

        IMPORT_C TInt ColorIndexed( const TInt aIndex ) const;

        /**

        * Returns the RGB color value.

        *

        * @since 2.0

        *

        * @param aIndex Index of the color to be retrieved. This must

        *   be within 0 (inclusive) and aNumberOfColors (exclusive).

        *

        * @return Color value as TRgb. Note that the value is only

        *   valid if ColorIndexed() returned -1.

        *

        * @par Note:

        *   This method does not perform any bounds checking. An access

        *   violation or panic will occur, if the given index is not

        *   within the bounds of the internal array. Use @c GetColorL

        *   instead, if such checking is required.

        */

        IMPORT_C TRgb ColorRgb( const TInt aIndex ) const;

        /**

        * Retrieves a color value (indexed or RGB) with bounds checking.

        *

        * @since 2.6

        *

        * @param aIndex Index of the color to be retrieved.

        *

        * @param aColor On return, contains the color as an RGB value.

        *   If the color is indexed, the appropriate mapping using current

        *   palette is used.

        *

        * @par Exceptions:

        *   If the given index is outside the bounds of the array,

        *   the method leaves with an error code.

        */

        IMPORT_C void GetColorL( const TInt aIndex, TRgb& aColor ) const;

    protected:  // C++ protected constructor

        /**

        * C++ protected constructor.

        * Constructs a new CAknsColorItemData without an array.

        *

        * @param aType Item type of the new item data object. While this

        *   is always ::EAknsITColorTable for instances of this class, derived

        *   classes may specify another value.

        *

        * @internal

        */

        CAknsColorTableItemData( const TAknsItemType aType );

    protected:  // Data

        TAknsColorTableEntry* iColorArray; //!< Color array.

        TInt iColorArraySize;

    };

/**

* 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.

*

* @lib AknSkins.lib

*

* @since 2.0

*/

NONSHARABLE_CLASS(CAknsImageTableItemData) : public CAknsImageItemData

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        * Constructs a new CAknsImageTableItemData object. Values must

        * be set separately using SetImagesL.

        *

        * @return Newly constructed CAknsImageTableItemData object.

        *

        * @par Exceptions:

        *   If allocation fails, function leaves with a system-wide error

        *   code.

        */

        IMPORT_C static CAknsImageTableItemData* NewL();

        /**

        * Destructor.

        * Destroys image array.

        */