mulwidgets/mulcoverflowwidget/inc/mulcoverflowenhancedtemplate.h
changeset 17 3eca7e70b1b8
parent 3 4526337fb576
equal deleted inserted replaced
3:4526337fb576 17:3eca7e70b1b8
     1 /*
       
     2 * Copyright (c) 2007-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:  template header for CoverFlow
       
    15 *
       
    16 */
       
    17 
       
    18 // This file defines the API for MulCoverFlowWidget.dll
       
    19 
       
    20 #ifndef MULCOVERFLOWENHANCEDTEMPLATE_H_
       
    21 #define MULCOVERFLOWENHANCEDTEMPLATE_H_
       
    22 
       
    23 #include "mulcoverflowbasetemplate.h"
       
    24 
       
    25 namespace osncore
       
    26 	{
       
    27 // Forward declarations
       
    28 class UString;
       
    29 	}
       
    30 
       
    31 namespace Alf
       
    32     {
       
    33 // Forward declarations
       
    34 class MulCoverFlowControl;
       
    35 class MulXmlUtility;
       
    36 
       
    37 struct TMulCoverFlowEnhancedTemplateImpl;
       
    38     
       
    39 class MulCoverFlowEnhancedTemplate :public MulCoverFlowBaseTemplate
       
    40     {
       
    41     
       
    42 public: // Constructor and Destructor 
       
    43         
       
    44     /**
       
    45      * Constructor
       
    46      */
       
    47 	MulCoverFlowEnhancedTemplate(MulCoverFlowControl &aControl,UString &aTemplateID, MulXmlUtility& aMulXmlUtility ,DuiNode* aRootNode);
       
    48     
       
    49     /**
       
    50      * Destructor
       
    51      */  
       
    52     ~MulCoverFlowEnhancedTemplate();
       
    53 
       
    54 public: // New Methods
       
    55     
       
    56     /**
       
    57      * Returns the enhanced max size in TMulCoverFlowItem structure. 
       
    58      * 
       
    59      * @return Returns reference to TMulCoverFlowItem structure. 
       
    60      */
       
    61     const TMulCoverFlowItem& EnhancedMaxSize();
       
    62    
       
    63     /**
       
    64      * Returns the enhanced min size in TMulCoverFlowItem structure. 
       
    65      * 
       
    66      * @return Returns reference to TMulCoverFlowItem structure.
       
    67      */
       
    68     const TMulCoverFlowItem& EnhancedMinSize();
       
    69     
       
    70     /**
       
    71      * Returns the counter position and size in TMulCoverFlowItem structure. 
       
    72      * 
       
    73      * @return Returns reference to TMulCoverFlowItem structure.
       
    74      */
       
    75     const TMulCoverFlowItem& EnhacedCounterPos();
       
    76  
       
    77     /**
       
    78      * Returns the path of the image that should be used as ecf shadow border. 
       
    79      * 
       
    80      * @return Returns path of the image that should be used as ecf shadow border.
       
    81      */   
       
    82     const UString& EnhancedBorderImagePath();
       
    83        
       
    84 private:
       
    85         
       
    86     /**
       
    87      * Parses xml tags of type <element> and in turn creates AlfElements 
       
    88      * which in turn are added in the control.
       
    89      *
       
    90      * All tags with <element> will be parsed here
       
    91      *
       
    92      * @param aNode the orientation node depending on the orientation
       
    93      * being used . 
       
    94      */
       
    95     void ParseNode( DuiNode& aNode );
       
    96     
       
    97     /**
       
    98      * Parses the enhanced size tag in the xml .
       
    99      * 
       
   100      * @param aNode the node at which the tag is <enhancedsize>.
       
   101      */
       
   102     void ParseEnhancedTag( DuiNode& aNode );
       
   103 
       
   104     /**
       
   105      * Parses the counter size tag in the xml .
       
   106      * 
       
   107      * @param aNode the node at which the tag is <counter>.
       
   108      */
       
   109     void ParseCounterTag( DuiNode& aNode );
       
   110     	
       
   111     /**
       
   112      * Parses the sizes tag and stores those values in corresponding variables.
       
   113      * 
       
   114      * @param aNode the node at which sizes are to be parsed from.
       
   115      */
       
   116 	void ProcessSizeTag( DuiNode& aNode );
       
   117 	
       
   118     /**
       
   119      * Parses the imagepath tag and stores those values in corresponding variables.
       
   120      * 
       
   121      * @param aNode the node at which sizes are to be parsed from.
       
   122      * @param aPath, Reference to Ustring in which the parsed value should be stored
       
   123      */	
       
   124 	bool GetStaticImagePath(DuiNode& aNode, UString& aPath);
       
   125 	
       
   126 private:
       
   127     auto_ptr<TMulCoverFlowEnhancedTemplateImpl> mData;    // owns it
       
   128     
       
   129     }; // class 
       
   130     
       
   131     }//namespace Alf
       
   132 
       
   133 #endif /*MULCOVERFLOWENHANCEDTEMPLATE_H_*/
       
   134 
       
   135 //End of file