epoc32/include/mw/clfcontentlisting.rh
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
#ifndef CLFCONTENTLISTING_RH
williamr@2
    19
#define CLFCONTENTLISTING_RH
williamr@2
    20
williamr@2
    21
williamr@2
    22
//  INCLUDES
williamr@2
    23
#include <CLFContentListing.hrh>
williamr@2
    24
williamr@2
    25
//  STRUCTURE DEFINITIONS
williamr@2
    26
williamr@2
    27
// -----------------------------------------------------------------------------
williamr@2
    28
// CLF_FIELD_ID
williamr@2
    29
// Field ID
williamr@2
    30
// -----------------------------------------------------------------------------
williamr@2
    31
//
williamr@2
    32
STRUCT CLF_FIELD_ID
williamr@2
    33
    {
williamr@2
    34
    LONG field_id;  // TCLFFieldId
williamr@2
    35
    }
williamr@2
    36
williamr@2
    37
// -----------------------------------------------------------------------------
williamr@2
    38
// CLF_SORTING_STYLE
williamr@2
    39
// Sorting style
williamr@2
    40
// Example:
williamr@2
    41
// RESOURCE CLF_SORTING_STYLE r_sorting_style
williamr@2
    42
//     {
williamr@2
    43
//     ordering = ECLFOrderingAscending;
williamr@2
    44
//     data_type = ECLFItemDataTypeDesC;
williamr@2
    45
//     fields =
williamr@2
    46
//         {
williamr@2
    47
//         CLF_FIELD_ID { field_id = ECLFFieldIdSongName; },
williamr@2
    48
//         CLF_FIELD_ID { field_id = ECLFFieldIdAlbum; }
williamr@2
    49
//         };
williamr@2
    50
//     }
williamr@2
    51
// -----------------------------------------------------------------------------
williamr@2
    52
//
williamr@2
    53
STRUCT CLF_SORTING_STYLE
williamr@2
    54
    {
williamr@2
    55
    WORD version = 1;
williamr@2
    56
    LONG ordering;      // TCLFSortingStyleOrdering
williamr@2
    57
    LONG data_type;     // TCLFItemDataType data type of fields
williamr@2
    58
                                   // TCLFUndefinedItemPosition
williamr@2
    59
    BYTE undefined_item_position = ECLFSortingStyleUndefinedEnd;
williamr@2
    60
    STRUCT fields[];    // CLF_FIELD_ID
williamr@2
    61
    }
williamr@2
    62
williamr@2
    63
// -----------------------------------------------------------------------------
williamr@2
    64
// CLF_MIME_TYPE_ARRAY
williamr@2
    65
// List of mime types
williamr@2
    66
// Example:
williamr@2
    67
// RESOURCE CLF_MIME_TYPE_ARRAY r_mime_type_array
williamr@2
    68
//     {
williamr@2
    69
//     mime_types =
williamr@2
    70
//         {
williamr@2
    71
//         LBUF { txt = "image/*"; },
williamr@2
    72
//         LBUF { txt = "audio/*"; }
williamr@2
    73
//         };
williamr@2
    74
//     }
williamr@2
    75
// -----------------------------------------------------------------------------
williamr@2
    76
//
williamr@2
    77
STRUCT CLF_MIME_TYPE_ARRAY
williamr@2
    78
    {
williamr@2
    79
    WORD version = 1;
williamr@2
    80
    STRUCT mime_types[]; // LBUF
williamr@2
    81
    }
williamr@2
    82
williamr@2
    83
// -----------------------------------------------------------------------------
williamr@2
    84
// CLF_MEDIA_TYPE
williamr@2
    85
// List of mime types
williamr@2
    86
// -----------------------------------------------------------------------------
williamr@2
    87
//
williamr@2
    88
STRUCT CLF_MEDIA_TYPE
williamr@2
    89
    {
williamr@2
    90
    LONG media_type;    // TCLFMediaType
williamr@2
    91
    }
williamr@2
    92
williamr@2
    93
// -----------------------------------------------------------------------------
williamr@2
    94
// CLF_MEDIA_TYPE_ARRAY
williamr@2
    95
// List of media types
williamr@2
    96
// -----------------------------------------------------------------------------
williamr@2
    97
//
williamr@2
    98
STRUCT CLF_MEDIA_TYPE_ARRAY
williamr@2
    99
    {
williamr@2
   100
    WORD version = 1;
williamr@2
   101
    STRUCT media_types[];   //  CLF_MEDIA_TYPE_ARRAY
williamr@2
   102
    }
williamr@2
   103
williamr@2
   104
// -----------------------------------------------------------------------------
williamr@2
   105
// CLF_LIST_MODEL
williamr@2
   106
// List model
williamr@2
   107
// Example:
williamr@2
   108
// RESOURCE CLF_LIST_MODEL r_list_model
williamr@2
   109
//     {
williamr@2
   110
//     mime_type_array = CLF_MIME_TYPE_ARRAY
williamr@2
   111
//         {
williamr@2
   112
//         mime_types =
williamr@2
   113
//             {
williamr@2
   114
//             LBUF { txt = "image/*"; },
williamr@2
   115
//             LBUF { txt = "audio/*"; }
williamr@2
   116
//             };
williamr@2
   117
//         };
williamr@2
   118
//     media_type_array = CLF_MEDIA_TYPE_ARRAY
williamr@2
   119
//         {
williamr@2
   120
//         media_types =
williamr@2
   121
//             {
williamr@2
   122
//             CLF_MEDIA_TYPE { media_type = ECLFMediaTypeMusic; }
williamr@2
   123
//             };
williamr@2
   124
//         };
williamr@2
   125
//     sorting_style = CLF_SORTING_STYLE
williamr@2
   126
//         {
williamr@2
   127
//         ordering = ECLFOrderingAscending;
williamr@2
   128
//         data_type = ECLFItemDataTypeDesC;
williamr@2
   129
//         fields =
williamr@2
   130
//             {
williamr@2
   131
//             CLF_FIELD_ID { field_id = ECLFFieldIdSongName; },
williamr@2
   132
//             CLF_FIELD_ID { field_id = ECLFFieldIdAlbum; }
williamr@2
   133
//             };
williamr@2
   134
//         };
williamr@2
   135
//     }
williamr@2
   136
// -----------------------------------------------------------------------------
williamr@2
   137
//
williamr@2
   138
STRUCT CLF_LIST_MODEL
williamr@2
   139
    {
williamr@2
   140
    WORD version = 1;
williamr@2
   141
    LONG grouping = ECLFNoGrouping; // TCLFGrouping
williamr@2
   142
    STRUCT mime_type_array;         // CLF_MIME_TYPE_ARRAY
williamr@2
   143
    STRUCT media_type_array;        // CLF_MEDIA_TYPE_ARRAY
williamr@2
   144
    STRUCT sorting_style;           // CLF_SORTING_STYLE
williamr@2
   145
    }
williamr@2
   146
williamr@2
   147
// -----------------------------------------------------------------------------
williamr@2
   148
// CLF_MEDIA_TYPE_ARRAY
williamr@2
   149
// List of media types version 2
williamr@2
   150
// There can be multible sortings styles.
williamr@2
   151
// First sorting style is primary style, all items is sorted by this style,
williamr@2
   152
// if there is items that doesn't have field (undefined items) which is defined in
williamr@2
   153
// primary sorting style, then second sorting style is used to those items etc.
williamr@2
   154
// -----------------------------------------------------------------------------
williamr@2
   155
//
williamr@2
   156
STRUCT CLF_LIST_MODEL_V2
williamr@2
   157
    {
williamr@2
   158
    WORD version = 2;
williamr@2
   159
    LONG grouping = ECLFNoGrouping; // TCLFGrouping
williamr@2
   160
    STRUCT mime_type_array;         // CLF_MIME_TYPE_ARRAY
williamr@2
   161
    STRUCT media_type_array;        // CLF_MEDIA_TYPE_ARRAY
williamr@2
   162
    STRUCT sorting_style_array[];   // array of CLF_SORTING_STYLE
williamr@2
   163
    }
williamr@2
   164
williamr@2
   165
williamr@2
   166
#endif      // CLFCONTENTLISTING_RH
williamr@2
   167
williamr@2
   168
// End of File