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 

    20 #ifndef C_HNMDSTRING8KEY_H

    21 #define C_HNMDSTRING8KEY_H

    22 

    23 #include <e32base.h>

    24 

    25 #include "hnmdbasekey.h"

    26 

    27 /**

    28  *  Defines particular key type which is narrow string.

    29  *

    30  *  @lib hierarchynavigatorengine

    31  *  @since S60 v5.0

    32  *  @ingroup group_hnutilities

    33  */

    34 NONSHARABLE_CLASS( CHnMdString8Key ) : public CHnMdBaseKey

    35     {

    36 public:

    37     

    38     /**

    39      * Standard factory method.

    40      * 

    41      * @return Fully constructed object.

    42      */

    43     static CHnMdString8Key* NewL();

    44 

    45     /**

    46      * Standard factory method.

    47      * 

    48      * @return Fully constructed object.

    49      */

    50     static CHnMdString8Key* NewLC();

    51 

    52     /**

    53      * Standard factory method.

    54      * 

    55      * @param aKey Reference key.

    56      * @return Fully constructed object.

    57      */

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

    59 

    60     /**

    61      * Standard factory method.

    62      * 

    63      * @param aKey Reference key.

    64      * @return Fully constructed object.

    65      */

    66     static CHnMdString8Key* NewLC( const CHnMdString8Key* 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 ~CHnMdString8Key();

    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     friend class HnMdKeyFactory;  

    92 

    93     /**

    94      * Standard constructor.

    95      * 

    96      * @since S60 v5.0

    97      */

    98     CHnMdString8Key();

    99 

   100     /**

   101      * Symbian constructor for performing 2nd stage construction.

   102      * 

   103      * @since S60 v5.0

   104      */

   105     void ConstructL();

   106         

   107     /**

   108      * Symbian constructor for performing 2nd stage construction.

   109      * 

   110      * @since S60 v5.0

   111      * @param aKey Reference key.

   112      */

   113     void ConstructL( const CHnMdString8Key* aKey );

   114     };

   115 

   116 #endif // C_HNMDSTRING8KEY_H