mmappfw_plat/mpx_collection_common_definition_api/inc/mpxincrementalopendefs.h
changeset 0 a2952bb97e68
equal deleted inserted replaced
-1:000000000000 0:a2952bb97e68
       
     1 /*
       
     2 * Copyright (c) 2006 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:  Definitions for incremental open command type
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MPXINCREMENTALOPENDEFS_H
       
    21 #define MPXINCREMENTALOPENDEFS_H
       
    22 
       
    23 #include <mpxattribute.h>
       
    24 
       
    25 /**
       
    26  * Content ID for opening incrementally
       
    27  */
       
    28 const TInt KMPXCommandIdIncrementalOpenL = 0x1028297B;
       
    29 
       
    30 /**
       
    31  * Enumeration for ascending or decending
       
    32  */
       
    33 enum TReadDirection
       
    34     {
       
    35     EReadUnknown = -1,
       
    36     EReadDescending = 0,
       
    37     EReadAscending = 1
       
    38     };
       
    39 
       
    40 /**
       
    41  *  Attributes supported for KMPXCommandIdIncrementalOpenL
       
    42  */    
       
    43 
       
    44 /**
       
    45  * The collection path to open (CMPXCollectionPath)
       
    46  */    
       
    47 const TMPXAttributeData KMPXCollectionCommandIdIncOpenLPath = {
       
    48                         KMPXCommandIdIncrementalOpenL, 0x01};
       
    49 
       
    50 /**
       
    51  * Offset to start reading from (TInt)
       
    52  */ 
       
    53 const TMPXAttributeData KMPXCollectionCommandIdIncOpenLOffset = {
       
    54                         KMPXCommandIdIncrementalOpenL, 0x02};
       
    55 
       
    56 /**
       
    57  * Number of items to read (TInt)
       
    58  */                         
       
    59 const TMPXAttributeData KMPXCollectionCommandIdIncOpenLNumItems = {
       
    60                         KMPXCommandIdIncrementalOpenL, 0x04};
       
    61 
       
    62 /**
       
    63  * Read ascending or decending (EReadDescending for dsc, 
       
    64  *                              EReadAscending for asc)
       
    65  * 
       
    66  * Can use ascending read if a key item can be provided for faster access
       
    67  */                         
       
    68 const TMPXAttributeData KMPXCollectionCommandIdIncOpenLAscDsc = {
       
    69                         KMPXCommandIdIncrementalOpenL, 0x08};
       
    70 
       
    71 /**
       
    72  * Value of some key (TDesC) to accelerate open db
       
    73  *
       
    74  * For example, KMPXMediaGeneralTitle can be used
       
    75  * as a reference for plugins to quickly jump to the 
       
    76  * last retrieved item
       
    77  */                         
       
    78 const TMPXAttributeData KMPXCollectionCommandIdIncOpenLKeyItem = {
       
    79                         KMPXCommandIdIncrementalOpenL, 0x10};
       
    80                         
       
    81 #endif // MPXINCREMENTALOPENDEFS_H