epoc32/include/mw/clfcontentlisting.hrh
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
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@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.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
williamr@2
    19
#ifndef CLFCONTENTLISTING_HRH
williamr@2
    20
#define CLFCONTENTLISTING_HRH
williamr@2
    21
williamr@2
    22
// DATA TYPES
williamr@2
    23
williamr@2
    24
/**
williamr@2
    25
*  Content Listing Framework list model media types.
williamr@2
    26
*/
williamr@2
    27
enum TCLFMediaType
williamr@2
    28
    {
williamr@2
    29
    /// Unknown media type
williamr@2
    30
    ECLFMediaTypeUnknown        = 0x0,
williamr@2
    31
    /// Music media type
williamr@2
    32
    ECLFMediaTypeMusic          = 0x1,
williamr@2
    33
    /// Sound media type
williamr@2
    34
    ECLFMediaTypeSound          = 0x2,
williamr@2
    35
    /// Image media type
williamr@2
    36
    ECLFMediaTypeImage          = 0x3,
williamr@2
    37
    /// Video media type
williamr@2
    38
    ECLFMediaTypeVideo          = 0x4,
williamr@2
    39
    /// Streaming URLs
williamr@2
    40
    ECLFMediaTypeStreamingURL   = 0x5,
williamr@2
    41
    /// Playlists
williamr@2
    42
    ECLFMediaTypePlaylist       = 0x6,
williamr@2
    43
    /// Presentations
williamr@2
    44
    ECLFMediaTypePresentations  = 0x8
williamr@2
    45
    };
williamr@2
    46
williamr@2
    47
/**
williamr@2
    48
*  Content Listing Framework list model grouping styles.
williamr@2
    49
*/
williamr@2
    50
enum TCLFGrouping
williamr@2
    51
    {
williamr@2
    52
    /// No grouping
williamr@2
    53
    ECLFNoGrouping          = 0x0,
williamr@2
    54
    /// Model groups items to music albums
williamr@2
    55
    ECLFMusicAlbumGrouping  = 0x1
williamr@2
    56
    };
williamr@2
    57
williamr@2
    58
/**
williamr@2
    59
*  Content Listing Framework sorting style orderings.
williamr@2
    60
*/
williamr@2
    61
enum TCLFSortingStyleOrdering
williamr@2
    62
    {
williamr@2
    63
    /// Ascending sorting order
williamr@2
    64
    ECLFOrderingAscending   = 0x0,
williamr@2
    65
    /// Descending sorting order
williamr@2
    66
    ECLFOrderingDescending  = 0x1
williamr@2
    67
    };
williamr@2
    68
williamr@2
    69
/**
williamr@2
    70
*  Content Listing Framework undefined item position.
williamr@2
    71
*/
williamr@2
    72
enum TCLFUndefinedItemPosition
williamr@2
    73
    {
williamr@2
    74
    /// Undefined items are added to end in the list
williamr@2
    75
    ECLFSortingStyleUndefinedEnd   = 0x0,
williamr@2
    76
    /// Undefined items are added to first in the list
williamr@2
    77
    ECLFSortingStyleUndefinedFirst  = 0x1
williamr@2
    78
    };
williamr@2
    79
williamr@2
    80
/**
williamr@2
    81
*  Content Listing Framework item fields data types.
williamr@2
    82
*/
williamr@2
    83
enum TCLFItemDataType
williamr@2
    84
    {
williamr@2
    85
    /// Undefined data type, do not use
williamr@2
    86
    ECLFItemDataTypeNull    = 0x0,
williamr@2
    87
    /// Data type is Integer
williamr@2
    88
    ECLFItemDataTypeTInt32  = 0x1,
williamr@2
    89
    /// Data type is descriptor
williamr@2
    90
    ECLFItemDataTypeDesC    = 0x2,
williamr@2
    91
    /// Data type is date/time
williamr@2
    92
    ECLFItemDataTypeTTime   = 0x3
williamr@2
    93
    };
williamr@2
    94
williamr@2
    95
/**
williamr@2
    96
*  Content Listing Framework item field IDs.
williamr@2
    97
*/
williamr@2
    98
enum TCLFDefaultFieldId
williamr@2
    99
    {
williamr@2
   100
    /// Null field ID, do not use
williamr@2
   101
    ECLFFieldIdNull                 = 0x00000000,
williamr@2
   102
    // File data
williamr@2
   103
    /// File name field:
williamr@2
   104
    /// descriptor
williamr@2
   105
    ECLFFieldIdFileName             = 0x00000001,
williamr@2
   106
    /// File name field:
williamr@2
   107
    /// descriptor
williamr@2
   108
    ECLFFieldIdFileExtension        = 0x00000002,
williamr@2
   109
    /// File path field:
williamr@2
   110
    /// descriptor
williamr@2
   111
    ECLFFieldIdPath                 = 0x00000003,
williamr@2
   112
    /// File drive field:
williamr@2
   113
    /// descriptor
williamr@2
   114
    ECLFFieldIdDrive                = 0x00000004,
williamr@2
   115
    /// File size field:
williamr@2
   116
    /// integer
williamr@2
   117
    ECLFFieldIdFileSize             = 0x00000005,
williamr@2
   118
    /// File date field:
williamr@2
   119
    /// date/time
williamr@2
   120
    ECLFFieldIdFileDate             = 0x00000006,
williamr@2
   121
    /// Mime type field:
williamr@2
   122
    /// descriptor
williamr@2
   123
    ECLFFieldIdMimeType             = 0x00000007,
williamr@2
   124
    /// Media type field:
williamr@2
   125
    /// integer
williamr@2
   126
    ECLFFieldIdMediaType            = 0x00000008,
williamr@2
   127
    /// Full name and path of the file:
williamr@2
   128
    /// descriptor
williamr@2
   129
    ECLFFieldIdFileNameAndPath      = 0x0000000B,
williamr@2
   130
williamr@2
   131
    /// Music file song name:
williamr@2
   132
    /// descriptor
williamr@2
   133
    ECLFFieldIdSongName             = 0x00001000,
williamr@2
   134
    /// Music file artist:
williamr@2
   135
    /// descriptor
williamr@2
   136
    ECLFFieldIdArtist               = 0x00001001,
williamr@2
   137
    /// Music file album:
williamr@2
   138
    /// descriptor
williamr@2
   139
    ECLFFieldIdAlbum                = 0x00001002,
williamr@2
   140
    /// Music file genre:
williamr@2
   141
    /// descriptor
williamr@2
   142
    ECLFFieldIdGenre                = 0x00001003,
williamr@2
   143
    /// Music file track number:
williamr@2
   144
    /// integer
williamr@2
   145
    ECLFFieldIdTrackNumber          = 0x00001004,
williamr@2
   146
    /// Music file composer:
williamr@2
   147
    /// descriptor
williamr@2
   148
    ECLFFieldIdComposer             = 0x00001104,
williamr@2
   149
williamr@2
   150
    /// Ram link first URL:
williamr@2
   151
    /// descriptor
williamr@2
   152
    ECLFFieldIdRamLinkFirstURL      = 0x00001200,
williamr@2
   153
williamr@2
   154
    /// Playlist song count:
williamr@2
   155
    /// integer
williamr@2
   156
    ECLFFieldIdPlaylistSongCount    = 0x00001201
williamr@2
   157
    };
williamr@2
   158
williamr@2
   159
#endif
williamr@2
   160
williamr@2
   161
// End of File