1.1 --- a/epoc32/include/mw/mclfmodifiableitem.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/mclfmodifiableitem.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,100 @@
     1.4 -mclfmodifiableitem.h
     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 +
    1.23 +#ifndef MCLFMODIFIABLEITEM_H
    1.24 +#define MCLFMODIFIABLEITEM_H
    1.25 +
    1.26 +//  INCLUDES
    1.27 +#include <MCLFItem.h>
    1.28 +
    1.29 +// FORWARD DECLARATIONS
    1.30 +class MCLFModifiableItemExt;
    1.31 +
    1.32 +// CLASS DECLARATION
    1.33 +
    1.34 +/**
    1.35 +*  Modifiable item for Content Listing Framework.
    1.36 +*  Use ContentListingFactory to create modifiable items. These new items are
    1.37 +*  used as groups in the custom grouper (see MCLFCustomGrouper). Modifiable
    1.38 +*  item is like MCLFItem but you can add new fields to the modifiable item.
    1.39 +*  One item can contain multiple fields, but normally it is not needed in
    1.40 +*  a custom grouper. The field consists of a Field ID and field data. Type
    1.41 +*  of the field is defined with Field ID. See TCLFDefaultFieldId in
    1.42 +*  CLFContentListing.hrh.<br><br>
    1.43 +*  Example:
    1.44 +*  @code
    1.45 +*  // Create a modifiable item and add one string field to it.
    1.46 +*  // Field id is ECLFFieldIdArtist and field value is "test".
    1.47 +*  _LIT( KTest, "test" );
    1.48 +*  MCLFModifiableItem* item = ContentListingFactory::NewModifiableItemLC();
    1.49 +*  item->AddFieldL( ECLFFieldIdArtist, KTest );
    1.50 +*  CleanupStack::Pop(); // item
    1.51 +*  @endcode
    1.52 +*
    1.53 +*  @lib ContentListingFramework.lib
    1.54 +*  @since S60 3.1
    1.55 +*/
    1.56 +class MCLFModifiableItem : public MCLFItem
    1.57 +    {
    1.58 +    public:  // Destructor
    1.59 +        /**
    1.60 +        * Destructor.
    1.61 +        */
    1.62 +        virtual ~MCLFModifiableItem() {}
    1.63 +
    1.64 +    public: // New functions
    1.65 +
    1.66 +        /**
    1.67 +        * Add new string field to the item.
    1.68 +        * @since S60 3.1
    1.69 +        * @param aFieldId Field ID
    1.70 +        * @param aValue Field value
    1.71 +        */
    1.72 +        virtual void AddFieldL( TCLFFieldId aFieldId,
    1.73 +                                const TDesC& aValue ) = 0;
    1.74 +
    1.75 +        /**
    1.76 +        * Add new integer field to the item.
    1.77 +        * @since S60 3.1
    1.78 +        * @param aFieldId Field ID
    1.79 +        * @param aValue Field value
    1.80 +        */
    1.81 +        virtual void AddFieldL( TCLFFieldId aFieldId,
    1.82 +                                TInt32 aValue ) = 0;
    1.83 +
    1.84 +        /**
    1.85 +        * Add new time field to the item.
    1.86 +        * @since S60 3.1
    1.87 +        * @param aFieldId Field ID
    1.88 +        * @param aValue Field value
    1.89 +        */
    1.90 +        virtual void AddFieldL( TCLFFieldId aFieldId,
    1.91 +                                const TTime& aValue ) = 0;
    1.92 +
    1.93 +    private: // Extension interface
    1.94 +
    1.95 +        /**
    1.96 +        * This member is internal and not intended for use.
    1.97 +        */
    1.98 +        virtual MCLFModifiableItemExt* ModifiableItemExtension() { return NULL; }
    1.99 +
   1.100 +    };
   1.101 +
   1.102 +#endif      // MCLFMODIFIABLEITEM_H
   1.103 +
   1.104 +// End of File