epoc32/include/mw/AknIconHeader.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description:  Describes functionalities for Extended Bitmap Icon Header.
williamr@4
    15
*  Author : Shakti Prakash Chittara
williamr@4
    16
*
williamr@4
    17
*/
williamr@4
    18
williamr@4
    19
williamr@4
    20
williamr@4
    21
#ifndef AKNICONHEADER_
williamr@4
    22
#define AKNICONHEADER_
williamr@4
    23
williamr@4
    24
// INCLUDES
williamr@4
    25
#include <e32std.h>
williamr@4
    26
williamr@4
    27
struct THeader         // be aware of padding!
williamr@4
    28
{
williamr@4
    29
  TUint16	sign;             
williamr@4
    30
  TUint8	version;
williamr@4
    31
  TUint8	headerSize;
williamr@4
    32
  TUint32	reserved1;
williamr@4
    33
  TUint16	reserved2;
williamr@4
    34
  TUint8	reserved3;
williamr@4
    35
  TUint8  reserved4:4;                /// flags 
williamr@4
    36
  TUint8  isMarginCorrection:1;           /// flags
williamr@4
    37
	TUint8  isMask:1;  // flags
williamr@4
    38
  TUint8  aspectRatio:2;             /// flags
williamr@4
    39
  TInt32	rotation;
williamr@4
    40
  TInt32	iconColor;
williamr@4
    41
  TInt32	bitmapid;
williamr@4
    42
} ;
williamr@4
    43
williamr@4
    44
williamr@4
    45
williamr@4
    46
// CONSTANTS
williamr@4
    47
static const TInt KIconHeaderLength = sizeof(THeader);
williamr@4
    48
class TAknIconHeader
williamr@4
    49
    {
williamr@4
    50
    
williamr@4
    51
public:
williamr@4
    52
    inline  TAknIconHeader(TDes8 &aData);
williamr@4
    53
williamr@4
    54
    inline ~TAknIconHeader();
williamr@4
    55
    
williamr@4
    56
    inline void Initialize();
williamr@4
    57
    
williamr@4
    58
    inline void SetRotation(TInt aAngle);
williamr@4
    59
  
williamr@4
    60
    inline TInt GetRotation() const;
williamr@4
    61
  
williamr@4
    62
   inline void SetScaleMode(TInt aMode);
williamr@4
    63
  
williamr@4
    64
    inline TInt GetScaleMode() const;
williamr@4
    65
  
williamr@4
    66
     inline void SetIconColor(TUint32 aColor);
williamr@4
    67
  
williamr@4
    68
    inline TUint32 GetIconColor() const;
williamr@4
    69
  
williamr@4
    70
    inline void SetMarginCorrection(TBool isMarginFlag);
williamr@4
    71
  
williamr@4
    72
    inline TBool IsMarginCorrection() const;
williamr@4
    73
  
williamr@4
    74
     inline void SetBitmapId(TInt aBitmapId);
williamr@4
    75
  
williamr@4
    76
    inline TInt GetBitmapId() const;
williamr@4
    77
williamr@4
    78
  inline void SetIsMask(TBool isMask);
williamr@4
    79
  
williamr@4
    80
  inline TBool IsMask() const;
williamr@4
    81
  
williamr@4
    82
private:  
williamr@4
    83
williamr@4
    84
   THeader *iHeader;
williamr@4
    85
    };
williamr@4
    86
williamr@4
    87
#include "AknIconHeader.inl"
williamr@4
    88
#endif /*AKNICONHEADER_*/