williamr@2: /*
williamr@2: * Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * 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: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description: 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef MCLFCUSTOMGROUPER_H
williamr@2: #define MCLFCUSTOMGROUPER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <e32std.h>
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class MCLFCustomGrouperExt;
williamr@2: class MCLFItem;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2: *  Custom grouper interface of Content Listing Framework.
williamr@2: *  With this interface, client can add own custom grouper
williamr@2: *  to its List Model. Custom grouper is used for grouping list model items.
williamr@2: *  For example, List Model of music files can be grouped by genre or artist
williamr@2: *  name by using this interface.
williamr@2: *  Use ContentListingFactory to create items for new groups (MCLFModifiableItem).
williamr@2: *  <br><br>
williamr@2: *  Example:
williamr@2: *  @code
williamr@2: *  // This grouper will overwrite the source list and add three items to model.
williamr@2: *  void CMyGrouper::GroupItemsL( const TArray<MCLFItem*>& aSourceList,
williamr@2: *                                RPointerArray<MCLFItem>& aGroupedList )
williamr@2: *      {
williamr@2: *      _LIT( KTest, "test" );
williamr@2: *      MCLFModifiableItem* item = ContentListingFactory::NewModifiableItemLC();
williamr@2: *      item->AddFieldL( ECLFFieldIdName, KTest );
williamr@2: *      aGroupedList.AppendL( item );
williamr@2: *      CleanupStack::Pop(); // item
williamr@2: *
williamr@2: *      _LIT( KTest1, "test1" );
williamr@2: *      item = ContentListingFactory::NewModifiableItemLC();
williamr@2: *      item->AddFieldL( ECLFFieldIdName, KTest1 );
williamr@2: *      aGroupedList.AppendL( item );
williamr@2: *      CleanupStack::Pop(); // item
williamr@2: *
williamr@2: *      _LIT( KTest2, "test2" );
williamr@2: *      item = ContentListingFactory::NewModifiableItemLC();
williamr@2: *      item->AddFieldL( ECLFFieldIdName, KTest2 );
williamr@2: *      aGroupedList.AppendL( item );
williamr@2: *      CleanupStack::Pop(); // item
williamr@2: *      }
williamr@2: *  @endcode
williamr@2: *
williamr@2: *  Custom grouper is activated and removed by calling method
williamr@2: *  MCLFItemListModel::SetCustomGrouper
williamr@2: *
williamr@2: *  @lib ContentListingFramework.lib
williamr@2: *  @since S60 3.1
williamr@2: */
williamr@2: class MCLFCustomGrouper
williamr@2:     {
williamr@2:     public: // New functions
williamr@2: 
williamr@2:         /**
williamr@2:         * Abstract method for grouping Content Listing Framework items of
williamr@2:         * list models. This method is called when the grouping process is
williamr@2:         * executed by refreshing the model.
williamr@2:         * @since S60 3.1
williamr@2:         * @param aSourceList Source list. Contains all items that are in
williamr@2:         *        the list model when the grouping process starts.
williamr@2:         * @param aGroupedList Grouped/destination list. While grouping, each
williamr@2:         *        group should be added to this list. The list model will
williamr@2:         *        contain only these items when the grouping process is
williamr@2:         *        finished.
williamr@2:         */
williamr@2:         virtual void GroupItemsL( const TArray<MCLFItem*>& aSourceList,
williamr@2:                                   RPointerArray<MCLFItem>& aGroupedList ) = 0;
williamr@2: 
williamr@2:     protected:
williamr@2: 
williamr@2:         /**
williamr@2:         * Destructor.
williamr@2:         */
williamr@2:         virtual ~MCLFCustomGrouper() {}
williamr@2: 
williamr@2:     private: // Extension interface
williamr@2: 
williamr@2:         /**
williamr@2:         * This member is internal and not intended for use.
williamr@2:         */
williamr@2:         virtual MCLFCustomGrouperExt* Extension() { return NULL; }
williamr@2: 
williamr@2:     };
williamr@2: 
williamr@2: #endif      // MCLFCUSTOMGROUPER_H
williamr@2: 
williamr@2: // End of File