sbMediaListEnumArrayHelper Class Reference

#include <sbMediaListEnumArrayHelper.h>

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

Public Member Functions

 sbMediaListEnumArrayHelper ()
 
virtual ~sbMediaListEnumArrayHelper ()
 
nsresult Init (nsIArray *aArray=nsnull)
 Resets and clears the media items array. Be sure to call this method before using this class as a enum listener. More...
 
NS_IMETHOD GetMediaItemsArray (nsIArray **aOutArray)
 
- Public Member Functions inherited from sbIMediaListEnumerationListener
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...
 

Static Public Member Functions

NS_DECL_ISUPPORTS static
NS_DECL_SBIMEDIALISTENUMERATIONLISTENER
sbMediaListEnumArrayHelper
New (nsIArray *aArray=nsnull)
 Creates a enum array helper and initializes it. More...
 

Protected Attributes

nsCOMPtr< nsIMutableArray > mItemsArray
 

Additional Inherited Members

- Public Attributes inherited from sbIMediaListEnumerationListener
const unsigned short CONTINUE = 0
 
const unsigned short CANCEL = 1
 

Detailed Description

Definition at line 39 of file sbMediaListEnumArrayHelper.h.

Constructor & Destructor Documentation

sbMediaListEnumArrayHelper::sbMediaListEnumArrayHelper ( )

Definition at line 42 of file sbMediaListEnumArrayHelper.cpp.

sbMediaListEnumArrayHelper::~sbMediaListEnumArrayHelper ( )
virtual

Definition at line 46 of file sbMediaListEnumArrayHelper.cpp.

Member Function Documentation

NS_IMETHODIMP sbMediaListEnumArrayHelper::GetMediaItemsArray ( nsIArray **  aOutArray)

Definition at line 67 of file sbMediaListEnumArrayHelper.cpp.

nsresult sbMediaListEnumArrayHelper::Init ( nsIArray *  aArray = nsnull)

Resets and clears the media items array. Be sure to call this method before using this class as a enum listener.

Parameters
aOutArrayThe array to receive the enumerated items, optional

Definition at line 51 of file sbMediaListEnumArrayHelper.cpp.

Here is the caller graph for this function:

sbMediaListEnumArrayHelper * sbMediaListEnumArrayHelper::New ( nsIArray *  aArray = nsnull)
static

Creates a enum array helper and initializes it.

Parameters
aArrayto be populated, optional
Returns
The enumerator helper instance

Definition at line 34 of file sbMediaListEnumArrayHelper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

nsCOMPtr<nsIMutableArray> sbMediaListEnumArrayHelper::mItemsArray
protected

Definition at line 65 of file sbMediaListEnumArrayHelper.h.


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