epoc32/include/mw/clfcontentlisting.rh
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/clfcontentlisting.rh	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/clfcontentlisting.rh	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,168 @@
     1.4 -clfcontentlisting.rh
     1.5 +/*
     1.6 +* Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies). 
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description: 
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +#ifndef CLFCONTENTLISTING_RH
    1.23 +#define CLFCONTENTLISTING_RH
    1.24 +
    1.25 +
    1.26 +//  INCLUDES
    1.27 +#include <CLFContentListing.hrh>
    1.28 +
    1.29 +//  STRUCTURE DEFINITIONS
    1.30 +
    1.31 +// -----------------------------------------------------------------------------
    1.32 +// CLF_FIELD_ID
    1.33 +// Field ID
    1.34 +// -----------------------------------------------------------------------------
    1.35 +//
    1.36 +STRUCT CLF_FIELD_ID
    1.37 +    {
    1.38 +    LONG field_id;  // TCLFFieldId
    1.39 +    }
    1.40 +
    1.41 +// -----------------------------------------------------------------------------
    1.42 +// CLF_SORTING_STYLE
    1.43 +// Sorting style
    1.44 +// Example:
    1.45 +// RESOURCE CLF_SORTING_STYLE r_sorting_style
    1.46 +//     {
    1.47 +//     ordering = ECLFOrderingAscending;
    1.48 +//     data_type = ECLFItemDataTypeDesC;
    1.49 +//     fields =
    1.50 +//         {
    1.51 +//         CLF_FIELD_ID { field_id = ECLFFieldIdSongName; },
    1.52 +//         CLF_FIELD_ID { field_id = ECLFFieldIdAlbum; }
    1.53 +//         };
    1.54 +//     }
    1.55 +// -----------------------------------------------------------------------------
    1.56 +//
    1.57 +STRUCT CLF_SORTING_STYLE
    1.58 +    {
    1.59 +    WORD version = 1;
    1.60 +    LONG ordering;      // TCLFSortingStyleOrdering
    1.61 +    LONG data_type;     // TCLFItemDataType data type of fields
    1.62 +                                   // TCLFUndefinedItemPosition
    1.63 +    BYTE undefined_item_position = ECLFSortingStyleUndefinedEnd;
    1.64 +    STRUCT fields[];    // CLF_FIELD_ID
    1.65 +    }
    1.66 +
    1.67 +// -----------------------------------------------------------------------------
    1.68 +// CLF_MIME_TYPE_ARRAY
    1.69 +// List of mime types
    1.70 +// Example:
    1.71 +// RESOURCE CLF_MIME_TYPE_ARRAY r_mime_type_array
    1.72 +//     {
    1.73 +//     mime_types =
    1.74 +//         {
    1.75 +//         LBUF { txt = "image/*"; },
    1.76 +//         LBUF { txt = "audio/*"; }
    1.77 +//         };
    1.78 +//     }
    1.79 +// -----------------------------------------------------------------------------
    1.80 +//
    1.81 +STRUCT CLF_MIME_TYPE_ARRAY
    1.82 +    {
    1.83 +    WORD version = 1;
    1.84 +    STRUCT mime_types[]; // LBUF
    1.85 +    }
    1.86 +
    1.87 +// -----------------------------------------------------------------------------
    1.88 +// CLF_MEDIA_TYPE
    1.89 +// List of mime types
    1.90 +// -----------------------------------------------------------------------------
    1.91 +//
    1.92 +STRUCT CLF_MEDIA_TYPE
    1.93 +    {
    1.94 +    LONG media_type;    // TCLFMediaType
    1.95 +    }
    1.96 +
    1.97 +// -----------------------------------------------------------------------------
    1.98 +// CLF_MEDIA_TYPE_ARRAY
    1.99 +// List of media types
   1.100 +// -----------------------------------------------------------------------------
   1.101 +//
   1.102 +STRUCT CLF_MEDIA_TYPE_ARRAY
   1.103 +    {
   1.104 +    WORD version = 1;
   1.105 +    STRUCT media_types[];   //  CLF_MEDIA_TYPE_ARRAY
   1.106 +    }
   1.107 +
   1.108 +// -----------------------------------------------------------------------------
   1.109 +// CLF_LIST_MODEL
   1.110 +// List model
   1.111 +// Example:
   1.112 +// RESOURCE CLF_LIST_MODEL r_list_model
   1.113 +//     {
   1.114 +//     mime_type_array = CLF_MIME_TYPE_ARRAY
   1.115 +//         {
   1.116 +//         mime_types =
   1.117 +//             {
   1.118 +//             LBUF { txt = "image/*"; },
   1.119 +//             LBUF { txt = "audio/*"; }
   1.120 +//             };
   1.121 +//         };
   1.122 +//     media_type_array = CLF_MEDIA_TYPE_ARRAY
   1.123 +//         {
   1.124 +//         media_types =
   1.125 +//             {
   1.126 +//             CLF_MEDIA_TYPE { media_type = ECLFMediaTypeMusic; }
   1.127 +//             };
   1.128 +//         };
   1.129 +//     sorting_style = CLF_SORTING_STYLE
   1.130 +//         {
   1.131 +//         ordering = ECLFOrderingAscending;
   1.132 +//         data_type = ECLFItemDataTypeDesC;
   1.133 +//         fields =
   1.134 +//             {
   1.135 +//             CLF_FIELD_ID { field_id = ECLFFieldIdSongName; },
   1.136 +//             CLF_FIELD_ID { field_id = ECLFFieldIdAlbum; }
   1.137 +//             };
   1.138 +//         };
   1.139 +//     }
   1.140 +// -----------------------------------------------------------------------------
   1.141 +//
   1.142 +STRUCT CLF_LIST_MODEL
   1.143 +    {
   1.144 +    WORD version = 1;
   1.145 +    LONG grouping = ECLFNoGrouping; // TCLFGrouping
   1.146 +    STRUCT mime_type_array;         // CLF_MIME_TYPE_ARRAY
   1.147 +    STRUCT media_type_array;        // CLF_MEDIA_TYPE_ARRAY
   1.148 +    STRUCT sorting_style;           // CLF_SORTING_STYLE
   1.149 +    }
   1.150 +
   1.151 +// -----------------------------------------------------------------------------
   1.152 +// CLF_MEDIA_TYPE_ARRAY
   1.153 +// List of media types version 2
   1.154 +// There can be multible sortings styles.
   1.155 +// First sorting style is primary style, all items is sorted by this style,
   1.156 +// if there is items that doesn't have field (undefined items) which is defined in
   1.157 +// primary sorting style, then second sorting style is used to those items etc.
   1.158 +// -----------------------------------------------------------------------------
   1.159 +//
   1.160 +STRUCT CLF_LIST_MODEL_V2
   1.161 +    {
   1.162 +    WORD version = 2;
   1.163 +    LONG grouping = ECLFNoGrouping; // TCLFGrouping
   1.164 +    STRUCT mime_type_array;         // CLF_MIME_TYPE_ARRAY
   1.165 +    STRUCT media_type_array;        // CLF_MEDIA_TYPE_ARRAY
   1.166 +    STRUCT sorting_style_array[];   // array of CLF_SORTING_STYLE
   1.167 +    }
   1.168 +
   1.169 +
   1.170 +#endif      // CLFCONTENTLISTING_RH
   1.171 +
   1.172 +// End of File