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 HNMDUINTEGERKEY_H_

    20 #define HNMDUINTEGERKEY_H_

    21 

    22 #include <e32base.h>

    23 #include "hnmdbasekey.h"

    24 

    25 /**

    26  * Defines particular key type which is unsigned integer.

    27  *

    28  *  @lib hierarchynavigatorengine

    29  *  @since S60 v5.0

    30  * @ingroup group_hnutilities

    31  */

    32 NONSHARABLE_CLASS( CHnMdUIntegerKey ) : public CHnMdBaseKey

    33     {

    34     friend class HnMdKeyFactory;

    35 

    36 public:

    37     

    38     /**

    39      * Standard factory method.

    40      * 

    41      * @return Fully constructed object.

    42      */

    43     static CHnMdUIntegerKey* NewL();

    44 

    45     /**

    46      * Standard factory method.

    47      * 

    48      * @return Fully constructed object.

    49      */

    50     static CHnMdUIntegerKey* NewLC();

    51 

    52     /**

    53      * Standard factory method.

    54      * 

    55      * @param aKey Reference key.

    56      * @return Fully constructed object.

    57      */

    58     static CHnMdUIntegerKey* NewL( const CHnMdUIntegerKey* aKey );

    59 

    60     /**

    61      * Standard factory method.

    62      * 

    63      * @param aKey Reference key.

    64      * @return Fully constructed object.

    65      */

    66     static CHnMdUIntegerKey* NewLC( const CHnMdUIntegerKey* aKey );

    67     

    68     /**

    69      * Factory method.

    70      *

    71      * since S60 v5.0

    72      * @return Fully constructed object.

    73      */

    74     virtual CHnMdBaseKey* CopyLC();

    75    

    76     /**

    77      * Standard destructor.

    78      */

    79     virtual ~CHnMdUIntegerKey();

    80     

    81     /**

    82      * Change to variant.

    83      * 

    84      * @since S60 v5.0

    85      * @param aRet Output variant.

    86      * 

    87      */

    88     virtual void ToVariantL( TLiwVariant& aRet ) const;

    89     

    90 protected:

    91 

    92     /**

    93      * Standard constructor.

    94      * 

    95      * @since S60 v5.0

    96      */

    97     CHnMdUIntegerKey();

    98 

    99     /**

   100      * Symbian constructor for performing 2nd stage construction.

   101      * 

   102      * @since S60 v5.0

   103      */

   104     void ConstructL();

   105 

   106     /**

   107      * Symbian constructor for performing 2nd stage construction.

   108      * 

   109      * @since S60 v5.0

   110      * @param aKey Reference key.

   111      */

   112     void ConstructL( const CHnMdUIntegerKey* aKey );

   113     };

   114 

   115 #endif // HNMDUINTEGERKEY_H_