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:    

    15 *

    16 */

    17 

    18 

    19 #ifndef C_HNMDLISTKEY_H

    20 #define C_HNMDLISTKEY_H

    21 

    22 #include <liwcommon.h>

    23 #include <e32base.h>

    24 

    25 #include "hnmdbasekey.h"

    26 

    27 

    28 /**

    29  * Defines particular key type which is LIW list.

    30  *

    31  * @lib hierarchynavigatorengine

    32  * @since S60 v5.0

    33  * @ingroup group_hnutilities

    34  */

    35 NONSHARABLE_CLASS( CHnMdListKey ) : public CHnMdBaseKey

    36     {

    37     friend class HnMdKeyFactory;

    38 

    39 public:

    40     

    41     /**

    42      * Standard factory method.

    43      * 

    44      * @return Fully constructed object.

    45      */

    46     static CHnMdListKey* NewL();

    47 

    48     /**

    49      * Standard factory method.

    50      * 

    51      * @return Fully constructed object.

    52      */

    53     static CHnMdListKey* NewLC();

    54 

    55     /**

    56      * Standard factory method.

    57      * 

    58      * @param aKey Reference key.

    59      * @return Fully constructed object.

    60      */

    61     static CHnMdListKey* NewL( const CHnMdListKey* aKey );

    62 

    63     /**

    64      * Standard factory method.

    65      * 

    66      * @param aKey Reference key.

    67      * @return Fully constructed object.

    68      */

    69     static CHnMdListKey* NewLC( const CHnMdListKey* aKey );

    70    

    71     /**

    72      * Standard destructor.

    73      */

    74     virtual ~CHnMdListKey();

    75     

    76 // from base class CHnMdBaseKey

    77     

    78     /**

    79      * Factory method.

    80      *

    81      * since S60 v5.0

    82      * @return Fully constructed object.

    83      */

    84     virtual CHnMdBaseKey* CopyLC();

    85     

    86     /**

    87      * Change to variant.

    88      * 

    89      * @since S60 v5.0

    90      * @param aRet Output variant.

    91      */

    92     virtual void ToVariantL( TLiwVariant& aRet ) const;

    93     

    94 protected:

    95 

    96     /**

    97      * Standard constructor.

    98      * 

    99      * @since S60 v5.0

   100      */

   101     CHnMdListKey();

   102 

   103     /**

   104      * Symbian constructor for performing 2nd stage construction.

   105      * 

   106      * @since S60 v5.0

   107      */

   108     void ConstructL();

   109   

   110     /**

   111      * Symbian constructor for performing 2nd stage construction.

   112      * 

   113      * @since S60 v5.0

   114      * @param aKey Reference key.

   115      */

   116     void ConstructL( const CHnMdListKey* aKey );

   117 

   118 // from base class CHnMdBaseKey

   119 

   120     /**

   121      * Evaluates the key value.

   122      * 

   123      * @since S60 v5.0

   124      * @param aParamList List of parameters.

   125      * @param aPos Position in the param list. Default is 0.

   126      */

   127     void EvaluateKeyValueL( const CLiwGenericParamList& aParamList,

   128                             TInt aPos );

   129 

   130 private: // data

   131     

   132     /**

   133      * Own. Variant.

   134      */

   135     TLiwVariant iVariantContent;

   136     

   137     };

   138 

   139 #endif // C_HNMDLISTKEY_H