Public Member Functions | Public Attributes | List of all members
sbIMediaListEnumerationListener Interface Reference

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

import"sbIMediaListListener.idl";

Inheritance diagram for sbIMediaListEnumerationListener:
[legend]
Collaboration diagram for sbIMediaListEnumerationListener:
[legend]

Public Member Functions

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

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 171 of file sbIMediaListListener.idl.

Member Function Documentation

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.
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.
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.

Member Data Documentation

const unsigned short sbIMediaListEnumerationListener::CANCEL = 1

Definition at line 174 of file sbIMediaListListener.idl.

const unsigned short sbIMediaListEnumerationListener::CONTINUE = 0

Definition at line 173 of file sbIMediaListListener.idl.

The documentation for this interface was generated from the following file: