MAiContentItemIterator Class Reference

class MAiContentItemIterator

Abstract interface which provides services to iterate content items supported by the plug-in. Only used by the Active Idle Framework. Each plug-in must provide implementation of interface to access: content selectors, content references, and events. Instances of interface are accessed through method GetProperty in interface CAiContentPublisher.

Since
S60 3.2
Public Member Functions
TBool HasNext ()
const TAiContentItem & ItemL ( TInt )
const TAiContentItem & ItemL (const TDesC &)
const TAiContentItem & NextL ()
void Release ()
void Reset ()
Protected Member Functions
~MAiContentItemIterator ()
Private Member Functions
void Cleanup ( TAny *)

Constructor & Destructor Documentation

~MAiContentItemIterator()

~MAiContentItemIterator ( ) [protected, inline]

Protected destructor prevents deletion through this interface.

Member Functions Documentation

Cleanup(TAny *)

void Cleanup ( TAny * aSelf ) [private, static, inline]

Required to implement CleanupReleasePushL(MAiContentItemIterator*) .

Required to implement CleanupReleasePushL(MAiContentItemIterator*) . Inline to avoid problems with multiple definitions.

Parameters

TAny * aSelf

HasNext()

TBool HasNext ( ) const [pure virtual]

Tests if this enumeration contains more elements.

ItemL(TInt)

const TAiContentItem & ItemL ( TInt aId ) const [pure virtual]

Returns the first element of this iterator which matches aId.

leave
KErrNotFound if element matching aId is not found from the complete iterator range.

Parameters

TInt aId - unique identification of the content item, corresponds to TAiContentItem::id.

ItemL(const TDesC &)

const TAiContentItem & ItemL ( const TDesC & aCid ) const [pure virtual]

Returns the first element of this iterator which matches aCid.

leave
KErrNotFound if element matching aCid is not found from the complete iterator range.

Parameters

const TDesC & aCid - textual identification of the content item, corresponds to TAiContentItem::cid.

NextL()

const TAiContentItem & NextL ( ) [pure virtual]

Returns the next element of this iterator if this enumeration object has at least one more element to provide.

leave
KErrOverflow if iterator is at the end of range.

Release()

void Release ( ) [pure virtual]

Release the iterator.

Reset()

void Reset ( ) [pure virtual]

Resets iterator to the first item in the list.