/*

* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:    

*

*/

#ifndef C_HNMDSTRING16KEY_H

#define C_HNMDSTRING16KEY_H

#include <e32base.h>

#include "hnmdbasekey.h"

/**

 *  Defines particular key type which is unicode string.

 *

 *  @lib hierarchynavigatorengine

 *  @since S60 v5.0

 *  @ingroup group_hnutilities

 */

NONSHARABLE_CLASS( CHnMdString16Key ) : public CHnMdBaseKey

    {

    friend class HnMdKeyFactory;

public:

    /**

     * Standard factory method.

     * 

     * @return Fully constructed object.

     */

    static CHnMdString16Key* NewL();

    /**

     * Standard factory method.

     * 

     * @return Fully constructed object.

     */

    static CHnMdString16Key* NewLC();

    /**

     * Standard factory method.

     * 

     * @param aKey Reference key.

     * @return Fully constructed object.

     */

    static CHnMdString16Key* NewL( const CHnMdString16Key* aKey );

    /**

     * Standard factory method.

     * 

     * @param aKey Reference key.

     * @return Fully constructed object.

     */

    static CHnMdString16Key* NewLC( const CHnMdString16Key* aKey );

    /**

     * Factory method.

     *

     * since S60 v5.0

     * @return Fully constructed object.

     */

    virtual CHnMdBaseKey* CopyLC();

    /**

     * Standard destructor.

     */

    virtual ~CHnMdString16Key();

    /**

     * Change to variant.

     * 

     * @since S60 v5.0

     * @param aRet Output variant.

     * 

     */

    virtual void ToVariantL( TLiwVariant& aRet ) const;

protected:

    /**

     * Standard constructor.

     * 

     * @since S60 v5.0

     */

    CHnMdString16Key();

    /**

     * Symbian constructor for performing 2nd stage construction.

     * 

     * @since S60 v5.0

     */

    void ConstructL();

    /**

     * Symbian constructor for performing 2nd stage construction.

     * 

     * @since S60 v5.0

     * @param aKey Reference key.

     */

    void ConstructL( const CHnMdString16Key* aKey );

    };

#endif // C_HNMDSTRING16KEY_H