#include <sbIPDStatus.h>

Public Member Functions
	sbIPDStatus (sbIPDDevice *aDevice)

virtual	~sbIPDStatus ()

nsresult	Initialize ()

void	Finalize ()

void	OperationStart (PRUint32 aOperationType, sbBaseDevice::TransferRequest *aRequest, PRUint32 aBatchCount)

void	OperationComplete (nsresult aResult)

void	ItemStart (PRInt32 aItemNum=-1, PRInt32 aItemCount=-1)

void	ItemStart (Itdb_Track *aTrack, PRInt32 aItemNum=-1, PRInt32 aItemCount=-1)

void	ItemStart (Itdb_Playlist aPlaylist, Itdb_Track aTrack, PRInt32 aItemNum=-1, PRInt32 aItemCount=-1)

void	ItemStart (sbIMediaList aMediaList, sbIMediaItem aMediaItem, PRInt32 aItemNum=-1, PRInt32 aItemCount=-1)

void	ItemProgress (double aProgress)

void	ItemComplete (nsresult aResult)

nsresult	GetCurrentStatus (sbIDeviceStatus **aCurrentStatus)

nsresult	ChangeStatus (PRUint32 newState)

nsresult	UpdateStatus (PRUint32 forState, const nsAString &currentOperation, const nsAString &currentStateMessage, PRInt32 currentIndex, PRInt32 totalCount, double currentProgress)

void	Idle ()

Static Public Attributes
static const PRUint32	OPERATION_TYPE_NONE = 0

static const PRUint32	OPERATION_TYPE_MOUNT = 1

static const PRUint32	OPERATION_TYPE_WRITE = 2

static const PRUint32	OPERATION_TYPE_DELETE = 3

Detailed Description

This class communicates device status to the system.

Definition at line 77 of file sbIPDStatus.h.

Constructor & Destructor Documentation

sbIPDStatus::sbIPDStatus ( sbIPDDevice * aDevice )

Construct an iPod device status object.

Parameters

aDevice Device for which to construct status.

Definition at line 83 of file sbIPDStatus.cpp.

sbIPDStatus::~sbIPDStatus ( )

virtual

Destroy an iPod device status object.

Definition at line 98 of file sbIPDStatus.cpp.

Member Function Documentation

nsresult sbIPDStatus::ChangeStatus ( PRUint32 newState )

Definition at line 466 of file sbIPDStatus.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void sbIPDStatus::Finalize ( )

Finalize the iPod device status object.

Definition at line 142 of file sbIPDStatus.cpp.

Here is the caller graph for this function:

nsresult sbIPDStatus::GetCurrentStatus ( sbIDeviceStatus ** aCurrentStatus )

Definition at line 458 of file sbIPDStatus.cpp.

void sbIPDStatus::Idle ( )

Definition at line 548 of file sbIPDStatus.cpp.

Here is the call graph for this function:

nsresult sbIPDStatus::Initialize ( )

Initialize the iPod device status object.

Definition at line 108 of file sbIPDStatus.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void sbIPDStatus::ItemComplete ( nsresult aResult )

Process the completion of the current item with the result specified by aResult.

Parameters

aResult Completion result of item.

Definition at line 440 of file sbIPDStatus.cpp.

Here is the call graph for this function:

void sbIPDStatus::ItemProgress ( double aProgress )

Process the progress of the current item with the progress specified by aProgress.

Parameters

aProgress Progress of current item.

Definition at line 421 of file sbIPDStatus.cpp.

Here is the call graph for this function:

void sbIPDStatus::ItemStart	(	PRInt32	aItemNum = `-1`,
		PRInt32	aItemCount = `-1`
	)

Process the start of item processing of the item with item number specified by aItemNum out of the total item count specified by aItemCount. Don't update the current item num or total item count if the corresponding arguments are negative.

Parameters

aItemNum	Current item number. Defaults to -1.
aItemCount	Current total item count. Defaults to -1.

Definition at line 299 of file sbIPDStatus.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void sbIPDStatus::ItemStart	(	Itdb_Track *	aTrack,
		PRInt32	aItemNum = `-1`,
		PRInt32	aItemCount = `-1`
	)

Process the start of item processing of the iPod track item specified by aTrack with item number specified by aItemNum out of the total item count specified by aItemCount. Don't update the current item num or total item count if the corresponding arguments are negative.

Parameters

aTrack	iPod track item being started.
aItemNum	Current item number. Defaults to -1.
aItemCount	Current total item count. Defaults to -1.

Definition at line 342 of file sbIPDStatus.cpp.

Here is the call graph for this function:

void sbIPDStatus::ItemStart	(	Itdb_Playlist *	aPlaylist,
		Itdb_Track *	aTrack,
		PRInt32	aItemNum = `-1`,
		PRInt32	aItemCount = `-1`
	)

Process the start of item processing of the iPod track item specified by aTrack within the iPod playlist specified by aPlaylist and with item number specified by aItemNum out of the total item count specified by aItemCount. Don't update the current item num or total item count if the corresponding arguments are negative.

Parameters

aPlaylist	iPod playlist being started.
aTrack	iPod track item being started.
aItemNum	Current item number. Defaults to -1.
aItemCount	Current total item count. Defaults to -1.

Definition at line 368 of file sbIPDStatus.cpp.

Here is the call graph for this function:

void sbIPDStatus::ItemStart	(	sbIMediaList *	aMediaList,
		sbIMediaItem *	aMediaItem,
		PRInt32	aItemNum = `-1`,
		PRInt32	aItemCount = `-1`
	)

Process the start of item processing of the media item specified by aMediaItem within the media list specified by aMediaList with item number specified by aItemNum out of the total item count specified by aItemCount. Don't update the current item num or total item count if the corresponding arguments are negative.

Parameters

aMediaList	Media list.
aMediaItem	Media item being started.
aItemNum	Current item number. Defaults to -1.
aItemCount	Current total item count. Defaults to -1.

Definition at line 396 of file sbIPDStatus.cpp.

Here is the call graph for this function:

void sbIPDStatus::OperationComplete ( nsresult aResult )

Process the completion of the current operation with the result specified by aResult.

Parameters

aResult Completion result of operation.

Definition at line 230 of file sbIPDStatus.cpp.

Here is the call graph for this function:

void sbIPDStatus::OperationStart	(	PRUint32	aOperationType,
		sbBaseDevice::TransferRequest *	aRequest,
		PRUint32	aBatchCount
	)

Process the start of a new operation of the type specified by aOperationType with the media item specified by aMediaItem within the media list specified by aMediaList.

Parameters

aOperationType	Type of operation.
aRequest	Request being started

Definition at line 168 of file sbIPDStatus.cpp.

Here is the call graph for this function:

nsresult sbIPDStatus::UpdateStatus	(	PRUint32	forState,
		const nsAString &	currentOperation,
		const nsAString &	currentStateMessage,
		PRInt32	currentIndex,
		PRInt32	totalCount,
		double	currentProgress
	)

Definition at line 513 of file sbIPDStatus.cpp.

Here is the caller graph for this function:

Member Data Documentation

const PRUint32 sbIPDStatus::OPERATION_TYPE_DELETE = 3

static

Definition at line 99 of file sbIPDStatus.h.

const PRUint32 sbIPDStatus::OPERATION_TYPE_MOUNT = 1

static

Definition at line 97 of file sbIPDStatus.h.

const PRUint32 sbIPDStatus::OPERATION_TYPE_NONE = 0

static

Definition at line 96 of file sbIPDStatus.h.

const PRUint32 sbIPDStatus::OPERATION_TYPE_WRITE = 2

static

Definition at line 98 of file sbIPDStatus.h.

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

/home/martin/dev/nightingale-hacking/extensions/ipod/components/src/sbIPDStatus.h
/home/martin/dev/nightingale-hacking/extensions/ipod/components/src/sbIPDStatus.cpp

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation