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 MPXCOLLECTIONOPENLRESULTDEFS_H

    21 #define MPXCOLLECTIONOPENLRESULTDEFS_H

    22 

    23 #include <e32base.h>

    24 #include <mpxattribute.h>

    25 

    26 /**

    27  * Structure to hold the offset and size of each data block

    28  */

    29 NONSHARABLE_STRUCT( TMPXOpenDataBlock )

    30     {

    31     TInt iOffset;

    32     TInt iSize;

    33     };

    34 

    35 /**

    36  * Content ID for opening incrementally

    37  */

    38 const TInt KMPXCollectionOpenLResults = 0x1028297E;

    39 

    40 /**

    41  *  Attributes supported for KMPXCollectionOpenLResults

    42  */    

    43 

    44 /**

    45  * TMPXOpenDataBlock structure to hold what block was fetched

    46  * contains the offset and the size of the datablock

    47  *

    48  * Used for the collection generic cache to merge in datasets

    49  * 

    50  */

    51 const TMPXAttributeData KMPXCollectionOpenLResultRange = {

    52                         KMPXCollectionOpenLResults, 0x01};

    53 

    54 /**

    55  * RArray<TMPXOpenDataBlock> serialized to a CBufBase* descriptor 

    56  * Migrate to RMPXArray<> in the future

    57  * 

    58  * This information will be provided by the generic cache

    59  *

    60  * Contains a cumulative list of all fetched blocks

    61  * Client should merge blocks together if overlapping results are fetched

    62  */

    63 const TMPXAttributeData KMPXCollectionOpenLAllResultRange = { 

    64                         KMPXCollectionOpenLResults, 0x02};

    65 

    66 /**

    67  * TBool supports KMPXCommandIdIncrementalOpenL commands

    68  * The collection plugin will set this to ETrue if a path supports

    69  * Incremental Opening. 

    70  *

    71  * The collection open utility will use this flag to determine

    72  * if incremental open is supported

    73  * ETrue if supported

    74  * EFalse or not set is not supported

    75  */

    76 const TMPXAttributeData KMPXCollectionOpenLSupportsIncremental = { 

    77                         KMPXCollectionOpenLResults, 0x04};

    78                         

    79 #endif // MPXCOLLECTIONOPENLRESULTDEFS_H