1 /*

     2 * Copyright (c) 2004 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:  Lookup key container.

    15 *

    16 */

    17 

    18 #ifndef __CVIMPSTSETTINGSLOOKUPKEYVALUEPAIR_H

    19 #define __CVIMPSTSETTINGSLOOKUPKEYVALUEPAIR_H

    20 

    21 //  INCLUDES

    22 #include "cvimpstsettingskeyvaluepair.h"

    23 

    24 

    25 // CLASS DECLARATION

    26 /**

    27  * Lookup key container.

    28  *

    29  * Lookup key holder to be able to do linear order

    30  * based key-value pair lookups without memory allocation.

    31  *

    32  * @since 3.0

    33  **/

    34 NONSHARABLE_CLASS( CVIMPSTSettingsLookupKeyValuePair ): public CVIMPSTSettingsKeyValuePair

    35     {

    36     public:  // Constructors and destructor

    37 

    38         /**

    39          * Two phased constructor.

    40          *

    41          * @since 3.0

    42          */

    43         static CVIMPSTSettingsLookupKeyValuePair* NewL();

    44 

    45         /**

    46          * Destructor.

    47          */

    48         virtual ~CVIMPSTSettingsLookupKeyValuePair();

    49 

    50 

    51 

    52     private:  // Constructor

    53 

    54         /**

    55          * C++ default constructor.

    56          */

    57         CVIMPSTSettingsLookupKeyValuePair();

    58 

    59 

    60 

    61     public:  //Data access

    62 

    63         /**

    64          * Key accessor.

    65          *

    66          * Gets the look up key associated with

    67          * this key-value object. Overwritten

    68          * from base.

    69          *

    70          * @since 3.0

    71          * @return The lookup key.

    72          */

    73         const TDesC& Key() const;

    74 

    75 

    76         /**

    77          * Lookup key setter.

    78          *

    79          * Sets the look up key associated with

    80          * this key-value object.

    81          *

    82          * @since 3.0

    83          * @param aLookUpKey The lookup key to use.

    84          */

    85         void SetLookupKey( const TDesC& aLookUpKey );

    86 

    87 

    88         /**

    89          * Lookup key reset.

    90          *

    91          * Resets the look up key to empty one.

    92          *

    93          * @since 3.0

    94          */

    95         void ResetLookupKey();

    96 

    97 

    98     private:    // Data

    99 

   100         TPtrC   iLookupKey;     //OWN: Lookup key

   101 

   102     };

   103 

   104 #endif      // __CVIMPSTSETTINGSLOOKUPKEYVALUEPAIR_H

   105 

   106 

   107 //  End of File

   108