1 /*

     2 * Copyright (c) 2007-2009 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:  Central repository key definitions for project MRUI

    15 *

    16 */

    17 

    18 #ifndef MRUIPRIVATECRKEYS_H

    19 #define MRUIPRIVATECRKEYS_H

    20 

    21 #include "mruidomaincrkeys.h"

    22 #include "esmrinternaluid.h"

    23 

    24 /**

    25  * MRUI Previous locations history repository uid.

    26  * Repository contains editor location field history settings.

    27  * 

    28  * Usage:

    29  * 

    30  * Product-configurable maximum amount of history items can be read from key

    31  * <c>KESMRUILocationHistoryItemMaxCount<c>.

    32  * 

    33  * Number of current history items can be read from key

    34  * <c>KESMRUILocationHistoryItemCount<c>

    35  * 

    36  * History items can be read from key range.

    37  * Number of initialized keyrange keys can be read from key

    38  * <c>KESMRUILocationHistoryItemKeyRangeCount<c>

    39  * 

    40  * Keys for reading history items must be formed by bitwise-or of

    41  * <c>KESMRUILocationHistoryItemFirstInt<c> and

    42  * <c>KESMRUILocationHistoryItemKeyMask<c>.

    43  * This creates a bitmask for accessing the key. The index of the actual key

    44  * must be added to this bitmask. Note that the first key index is defined by

    45  * <c>KESMRUILocationHistoryItemFirstIndex<c>.

    46  */

    47 const TUid KCRUidESMRUIPreviousLocations = { KESMRUIPreviousLocationsCRUid };

    48 

    49 /**

    50  * Read-only key for history list items maximum count.

    51  * 

    52  * Default value: 10

    53  * 

    54  * Integer data.

    55  */

    56 const TUint32 KESMRUILocationHistoryItemMaxCount = 0x1;

    57 

    58 /**

    59  * Key for current number of history items.

    60  * 

    61  * Default value: 0

    62  * 

    63  * Integer data.

    64  */

    65 const TUint32 KESMRUILocationHistoryItemCount = 0x2;

    66 

    67 /**

    68  * Key for current item list sort order.

    69  * 

    70  * Default value: "" (KNullDesC8)

    71  * 

    72  * 8-bit binary data (string8).

    73  */

    74 const TUint32 KESMRUILocationHistoryItemOrder = 0x3;

    75 

    76 // History item key range

    77 

    78 /**

    79  * Key for current history items key range key count.

    80  * Number of initialized keys in the key range.

    81  * Key range uses 8-bit index mask providing maximum amount of 254 separate keys.

    82  * 

    83  * Default value: 0

    84  * 

    85  * Integer data.

    86  */

    87 const TUint32 KESMRUILocationHistoryItemKeyRangeCount = 0x1000;

    88 

    89 /**

    90  * First key in range keys.

    91  */

    92 const TUint32 KESMRUILocationHistoryItemFirstInt = 0x1001;

    93 

    94 /**

    95  * Last key in range keys.

    96  */

    97 const TUint32 KESMRUILocationHistoryItemLastInt = 0x1fff;

    98 

    99 /**

   100  * Bitmask for key index.

   101  */

   102 const TUint32 KESMRUILocationHistoryItemIndexBits = 0x0ff0;

   103 

   104 /**

   105  * Bitmask for creating actual keys. Adding this bitmask to

   106  * First int creates first actual key.

   107  * 

   108  */

   109 const TUint32 KESMRUILocationHistoryItemIndexMask = 0x0010;

   110 

   111 /**

   112  * Staring index stored in index bits

   113  */

   114 const TUint32 KESMRUILocationHistoryItemFirstIndex = 1;

   115 

   116 /**

   117  * Sub-key for History item data.

   118  * 

   119  * Default value: "" (KNullDesC8)

   120  * 

   121  * 8-bit binary data (string8).

   122  */

   123 const TUint32 KESMRUILocationHistoryItemKeyMask = 0x0001;

   124 

   125 #endif // MRUIPRIVATECRKEYS_H