sbMediaItemControllerCleanup::sbEnumerationHelper Class Reference

#include <sbMediaItemControllerCleanup.h>

Inheritance diagram for sbMediaItemControllerCleanup::sbEnumerationHelper:
Collaboration diagram for sbMediaItemControllerCleanup::sbEnumerationHelper:

Public Member Functions

 sbEnumerationHelper (sbIMediaList *aMediaList, sbIPropertyArray *aPropertiesToFilter, sbIPropertyArray *aPropertiesToSet)
void Stop ()
void Resume ()
bool Completed ()
already_AddRefed< sbIMediaListGetMediaList ()
- 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...
- Public Member Functions inherited from sbIMediaListBatchCallback
void runBatched ([optional] in nsISupports aUserData)

Protected Attributes

nsCOMPtr< sbIMediaListmList
nsCOMPtr< sbIPropertyArraymPropsToFilter
nsCOMPtr< sbIPropertyArraymPropsToSet
bool mStop
bool mCompleted
PRUint32 mCount

Additional Inherited Members

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

Detailed Description

Definition at line 75 of file sbMediaItemControllerCleanup.h.

Constructor & Destructor Documentation

sbMediaItemControllerCleanup::sbEnumerationHelper::sbEnumerationHelper ( sbIMediaList aMediaList,
sbIPropertyArray aPropertiesToFilter,
sbIPropertyArray aPropertiesToSet 

Create a new enumeration helper used to set properties on items which match a given set of properties

aMediaListthe media list to operate on
aPropertiesToFilterthe set of properties describing which items to set
aPropertiesToSetthe set of properties to set on the found items

Member Function Documentation

bool sbMediaItemControllerCleanup::sbEnumerationHelper::Completed ( )

Check if the run was successfully completed. This may be false if the operation was aborted via Stop().

Definition at line 903 of file sbMediaItemControllerCleanup.cpp.

already_AddRefed< sbIMediaList > sbMediaItemControllerCleanup::sbEnumerationHelper::GetMediaList ( )

Definition at line 910 of file sbMediaItemControllerCleanup.cpp.

void sbMediaItemControllerCleanup::sbEnumerationHelper::Resume ( )

Ask the listener to abort the stop attempt. This may not actually abort the attempt if it has already stopped.

Definition at line 896 of file sbMediaItemControllerCleanup.cpp.

void sbMediaItemControllerCleanup::sbEnumerationHelper::Stop ( )

Inform the listener that it should try to stop the enumeration as soon as possible. Note that this is asynchronous and will not actually stop until some time later.

Definition at line 889 of file sbMediaItemControllerCleanup.cpp.

Member Data Documentation

bool sbMediaItemControllerCleanup::sbEnumerationHelper::mCompleted

Definition at line 119 of file sbMediaItemControllerCleanup.h.

PRUint32 sbMediaItemControllerCleanup::sbEnumerationHelper::mCount

Definition at line 120 of file sbMediaItemControllerCleanup.h.

nsCOMPtr<sbIMediaList> sbMediaItemControllerCleanup::sbEnumerationHelper::mList

Definition at line 115 of file sbMediaItemControllerCleanup.h.

nsCOMPtr<sbIPropertyArray> sbMediaItemControllerCleanup::sbEnumerationHelper::mPropsToFilter

Definition at line 116 of file sbMediaItemControllerCleanup.h.

nsCOMPtr<sbIPropertyArray> sbMediaItemControllerCleanup::sbEnumerationHelper::mPropsToSet

Definition at line 117 of file sbMediaItemControllerCleanup.h.

bool sbMediaItemControllerCleanup::sbEnumerationHelper::mStop

Definition at line 118 of file sbMediaItemControllerCleanup.h.

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