Songbird / Development / Songbird Add-Ons API Documentation

sbIMediaListEnumerationListener Interface Reference

Interface used to enumerate the items in a media list. More...

import "sbIMediaListListener.idl";

List of all members.

Public Member Functions

unsigned short onEnumerationBegin (in sbIMediaList aMediaList)
 Called when enumeration is about to begin.
unsigned short onEnumeratedItem (in sbIMediaList aMediaList, in sbIMediaItem aMediaItem)
 Called once for each item in the enumeration.
void onEnumerationEnd (in sbIMediaList aMediaList, in nsresult aStatusCode)
 Called when enumeration has completed.

Public Attributes

const unsigned short CONTINUE = 0
const unsigned short CANCEL = 1


Detailed Description

Interface used to enumerate the items in a media list.

See also:
sbIMediaList

Definition at line 155 of file sbIMediaListListener.idl.


Member Function Documentation

unsigned short sbIMediaListEnumerationListener::onEnumerationBegin ( in sbIMediaList  aMediaList  ) 

Called when enumeration is about to begin.

Parameters:
aMediaList - The media list that is being enumerated.
Returns:
CONTINUE to continue enumeration, CANCEL to cancel enumeration. JavaScript callers may omit the return statement entirely to continue the enumeration.

unsigned short sbIMediaListEnumerationListener::onEnumeratedItem ( in sbIMediaList  aMediaList,
in sbIMediaItem  aMediaItem 
)

Called once for each item in the enumeration.

Parameters:
aMediaList - The media list that is being enumerated.
aMediaItem - The media item.
Returns:
CONTINUE to continue enumeration, CANCEL to cancel enumeration. JavaScript callers may omit the return statement entirely to continue the enumeration.

void sbIMediaListEnumerationListener::onEnumerationEnd ( in sbIMediaList  aMediaList,
in nsresult  aStatusCode 
)

Called when enumeration has completed.

Parameters:
aMediaList - The media list that is being enumerated.
aStatusCode - A code to determine if the enumeration was successful.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:29:00 2009 for Songbird by  doxygen 1.5.2