skins/AknSkins/inc/AknsBackgroundLayout.h
changeset 0 05e9090e2422
equal deleted inserted replaced
-1:000000000000 0:05e9090e2422
       
     1 /*
       
     2 * Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Defines internal data structures for background layouts.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef AKNSBACKGROUNDLAYOUT_H
       
    20 #define AKNSBACKGROUNDLAYOUT_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32std.h>
       
    24 #include <AknsItemID.h>
       
    25 #include <AknsImageAttributeData.h>
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 /**
       
    30 * Background information structure for ::EAknsCCOBackground.
       
    31 *
       
    32 * This is an internal class that contains no exported functions.
       
    33 * The class is not intended for derivation outside the library.
       
    34 *
       
    35 * @since 2.0
       
    36 *
       
    37 * @internal
       
    38 */
       
    39 class TAknsBackground
       
    40     {
       
    41     public: // Constructor
       
    42 
       
    43         /**
       
    44         * Default C++ constructor.
       
    45         * Initializes background layout structure to values
       
    46         *   iRect = (0,0,1,1), iImageID = KAknsIIDNone,
       
    47         *   iAttr = KAknsImageAttributeNone,
       
    48         *   iParentAbsolute = EFalse, iParentPos = (0,0) and
       
    49         *   iSecondLayout = NULL
       
    50         *
       
    51         * @internal
       
    52         */
       
    53         TAknsBackground();
       
    54 
       
    55     public: // Data
       
    56 
       
    57         /**
       
    58         * The layout background bitmap area as a rectangle.
       
    59         */
       
    60         TRect iRect;
       
    61 
       
    62         /**
       
    63         * Item ID of the image;
       
    64         */
       
    65         TAknsItemID iImageID;
       
    66 
       
    67         /**
       
    68         * Attribute overloads (if any) to be applied to background.
       
    69         */
       
    70         TAknsImageAttributeData iAttr;
       
    71 
       
    72         /**
       
    73         * Specifies whether absolute parent window coordinates are
       
    74         * give in iParentLeft and iParentTop members.
       
    75         */
       
    76         TBool iParentAbsolute;
       
    77 
       
    78         /**
       
    79         * The position of the top left corner of the parent window.
       
    80         * If iParentAbsolute is ETrue, this value is in absolute
       
    81         * screen coordinates. If iParentAbsolute is EFalse, this
       
    82         * value must be (0,0).
       
    83         */
       
    84         TPoint iParentPos;
       
    85 
       
    86         /**
       
    87         * Pointer to the second layout. No ownership is
       
    88         * implied. Default value is NULL.
       
    89         */
       
    90         TAknsBackground* iNext;
       
    91 
       
    92     };
       
    93 
       
    94 #endif      // AKNSBACKGROUNDLAYOUT_H
       
    95 
       
    96 // End of File