Nokia N97 SDK
Example Applications Guide

CCEPostFilter Class Reference

#include <CCEPostFilter.h>

Inheritance diagram for CCEPostFilter:

List of all members.

Detailed Description

CLF Post Filter. Example of Post Filter that can be used to filter items from the list model. With post filter your can select, which kind of items are excluded from the list model. For example, you can include only music files of some specific artist and remove all other items.

Definition at line 38 of file CCEPostFilter.h.


Public Member Functions

virtual  ~CCEPostFilter ()

Static Public Member Functions

static CCEPostFilter *  NewL (const TCLFDefaultFieldId aFilterCriteria, const TDesC &aFilterParameter)
static CCEPostFilter *  NewLC (const TCLFDefaultFieldId aFilterCriteria, const TDesC &aFilterParameter)

Protected Member Functions

void  FilterItemsL (const TArray< MCLFItem * > &aItemList, RPointerArray< MCLFItem > &aFilteredItemList)

Private Member Functions

  CCEPostFilter (const TCLFDefaultFieldId aFilterCriteria)
void  ConstructL (const TDesC &aFilterParameter)

Private Attributes

HBufC *  iFilterParameter
TCLFDefaultFieldId  iFilterCriteria


Constructor & Destructor Documentation

CCEPostFilter::~CCEPostFilter (   )  [virtual]
 

Destructor.

Definition at line 82 of file CCEPostFilter.cpp.

References iFilterParameter.

00083     {
00084     delete iFilterParameter;
00085     }

CCEPostFilter::CCEPostFilter (  const TCLFDefaultFieldId  aFilterCriteria  )  [private]
 

C++ default constructor.

Parameters:
aFilterCriteria  Filtering criteria

Definition at line 36 of file CCEPostFilter.cpp.

Referenced by NewLC().

00037     : iFilterCriteria( aFilterCriteria )
00038     {
00039     }


Member Function Documentation

CCEPostFilter * CCEPostFilter::NewL (  const TCLFDefaultFieldId  aFilterCriteria,
const TDesC &  aFilterParameter
)  [static]
 

Creates and returns a new instance of this class.

Parameters:
aFilterCriteria  Filtering criteria (for example ECLFFielIdAlbum or ECLFFieldIdArtist)
aFilterParameter  Filtering parameter (for example name of album or artist)
Returns:
Pointer to the CCEPostFilter object

Definition at line 56 of file CCEPostFilter.cpp.

References NewLC().

00059     {
00060     CCEPostFilter* self =
00061         CCEPostFilter::NewLC( aFilterCriteria, aFilterParameter );
00062     CleanupStack::Pop( self );
00063     return self;
00064     }

CCEPostFilter * CCEPostFilter::NewLC (  const TCLFDefaultFieldId  aFilterCriteria,
const TDesC &  aFilterParameter
)  [static]
 

Creates and returns a new instance of this class. Pointer is left to the CleanupStack.

Parameters:
aFilterCriteria  Filtering criteria (for example ECLFFielIdAlbum or ECLFFieldIdArtist)
aFilterParameter  Filtering parameter (for example name of album or artist)
Returns:
Pointer to the CCEPostFilter object

Definition at line 71 of file CCEPostFilter.cpp.

References CCEPostFilter().

Referenced by NewL().

00074     {
00075     CCEPostFilter* self = new (ELeave) CCEPostFilter( aFilterCriteria );
00076     CleanupStack::PushL( self );
00077     self->ConstructL( aFilterParameter );
00078     return self;
00079     }

void CCEPostFilter::ConstructL (  const TDesC &  aFilterParameter  )  [private]
 

Symbian 2nd phase constructor.

Definition at line 46 of file CCEPostFilter.cpp.

References iFilterParameter.

00047     {
00048     iFilterParameter = aFilterParameter.AllocL();
00049     }

void CCEPostFilter::FilterItemsL (  const TArray< MCLFItem * > &  aItemList,
RPointerArray< MCLFItem > &  aFilteredItemList
)  [protected]
 

From MCLFPostFilter. Method for filtering the source list. Will get called when post filtering operation is executed by calling refresh for the list model.

Since:
Series 60 3.0
Parameters:
aItemList  Source item list
aFilteredItemList  Filtered/destination item list

Definition at line 92 of file CCEPostFilter.cpp.

References iFilterCriteria, and iFilterParameter.

00094     {
00095     // Process all items in the item list
00096     TInt count( aItemList.Count() );
00097     for( TInt i = 0; i < count; ++i )
00098         {
00099         // Get value of the field defined in iFilterCriteria.
00100         // For example, if iFilterCriteria contains ECLFFieldIdAlbum,
00101         // name of the album is stored to fieldValue variable.
00102         TPtrC fieldValue;
00103         MCLFItem* currentItem = aItemList[i];
00104         TInt error( currentItem->GetField(
00105             iFilterCriteria, fieldValue ) );
00106 
00107         // Add the music file to the filtered list,
00108         // if value of of the field is same as iFilterParameter.
00109         // For example, if it is from the desired album.
00110         if( error == KErrNone )
00111             {
00112             if( fieldValue == iFilterParameter->Des() )
00113                 {
00114                 aFilteredItemList.AppendL( currentItem );
00115                 }
00116             }
00117         }
00118     }


The documentation for this class was generated from the following files:

© Nokia 2009

Back to top