#include <sbLocalDatabaseDynamicMediaList.h>

Inheritance diagram for sbLocalDatabaseDynamicMediaList:

Collaboration diagram for sbLocalDatabaseDynamicMediaList:

Public Member Functions
NS_DECL_ISUPPORTS NS_DECL_NSICLASSINFO NS_DECL_SBIDYNAMICMEDIALIST NS_IMETHOD	GetName (nsAString &aName)

NS_IMETHOD	SetName (const nsAString &aName)

NS_IMETHOD	GetLength (PRUint32 *aLength)

NS_IMETHOD	GetItemByGuid (const nsAString &aGuid, sbIMediaItem **_retval)

NS_IMETHOD	GetItemByIndex (PRUint32 aIndex, sbIMediaItem **_retval)

NS_IMETHOD	GetListContentType (PRUint16 *_retval)

NS_IMETHOD	EnumerateAllItems (sbIMediaListEnumerationListener *aEnumerationListener, PRUint16 aEnumerationType)

NS_IMETHOD	EnumerateItemsByProperty (const nsAString &aPropertyID, const nsAString &aPropertyValue, sbIMediaListEnumerationListener *aEnumerationListener, PRUint16 aEnumerationType)

NS_IMETHOD	EnumerateItemsByProperties (sbIPropertyArray aProperties, sbIMediaListEnumerationListener aEnumerationListener, PRUint16 aEnumerationType)

NS_IMETHOD	GetItemsByProperty (const nsAString &aPropertyID, const nsAString &aPropertyValue, nsIArray **_retval)

NS_IMETHOD	GetItemCountByProperty (const nsAString &aPropertyID, const nsAString &aPropertyValue, PRUint32 *_retval)

NS_IMETHOD	GetItemsByProperties (sbIPropertyArray aProperties, nsIArray *_retval)

NS_IMETHOD	IndexOf (sbIMediaItem aMediaItem, PRUint32 aStartFrom, PRUint32 _retval)

NS_IMETHOD	LastIndexOf (sbIMediaItem aMediaItem, PRUint32 aStartFrom, PRUint32 _retval)

NS_IMETHOD	Contains (sbIMediaItem aMediaItem, PRBool _retval)

NS_IMETHOD	GetIsEmpty (PRBool *aIsEmpty)

NS_IMETHOD	GetUserEditableContent (PRBool *aUserEditableContent)

NS_IMETHOD	Add (sbIMediaItem *aMediaItem)

NS_IMETHOD	AddItem (sbIMediaItem aMediaItem, sbIMediaItem *aNewMediaItem)

NS_IMETHOD	AddAll (sbIMediaList *aMediaList)

NS_IMETHOD	AddSome (nsISimpleEnumerator *aMediaItems)

NS_IMETHOD	AddMediaItems (nsISimpleEnumerator aMediaItems, sbIAddMediaItemsListener aListener, PRBool aAsync)

NS_IMETHOD	Remove (sbIMediaItem *aMediaItem)

NS_IMETHOD	RemoveByIndex (PRUint32 aIndex)

NS_IMETHOD	RemoveSome (nsISimpleEnumerator *aMediaItems)

NS_IMETHOD	Clear (void)

NS_IMETHOD	AddListener (sbIMediaListListener aListener, PRBool aOwnsWeak, PRUint32 aFlags, sbIPropertyArray aPropertyFilter)

NS_IMETHOD	RemoveListener (sbIMediaListListener *aListener)

NS_IMETHOD	CreateView (sbIMediaListViewState aState, sbIMediaListView *_retval)

NS_IMETHOD	GetDistinctValuesForProperty (const nsAString &aPropertyID, nsIStringEnumerator **_retval)

NS_IMETHOD	RunInBatchMode (sbIMediaListBatchCallback aCallback, nsISupports aUserData)

NS_SCRIPTABLE NS_IMETHOD	GetMediaItemId (PRUint32 *aMediaItemId)

NS_SCRIPTABLE NS_IMETHOD	GetPropertyBag (sbILocalDatabaseResourcePropertyBag **aPropertyBag)

NS_SCRIPTABLE NS_IMETHOD	SetPropertyBag (sbILocalDatabaseResourcePropertyBag *aPropertyBag)

	NS_IMETHOD_ (void) SetSuppressNotifications(PRBool aSuppress)

NS_IMETHOD	GetType (nsAString &aType)
	The type of media list (eg "simple") More...

virtual	~sbLocalDatabaseDynamicMediaList ()

	sbLocalDatabaseDynamicMediaList ()

nsresult	Initialize (sbIMediaItem *aInner)

Public Member Functions inherited from sbSupportsWeakReference
	sbSupportsWeakReference ()

Public Member Functions inherited from sbIMediaList
sbIMediaItem	getItemByGuid (in AString aGuid)
	Get a media item in the list by guid. More...

sbIMediaItem	getItemByIndex (in unsigned long aIndex)
	Get a media item in the list by index. More...

unsigned short	getListContentType ()
	Get the content type of the media list. More...

void	enumerateAllItems (in sbIMediaListEnumerationListener aEnumerationListener, [optional] in unsigned short aEnumerationType)
	Enumerate all items in the list. More...

void	enumerateItemsByProperty (in AString aPropertyID, in AString aPropertyValue, in sbIMediaListEnumerationListener aEnumerationListener, [optional] in unsigned short aEnumerationType)
	Enumerate the media items in the list that match a given property ID and value. More...

void	enumerateItemsByProperties (in sbIPropertyArray aProperties, in sbIMediaListEnumerationListener aEnumerationListener, [optional] in unsigned short aEnumerationType)
	Enumerate the media items that match a list of property IDs and values. More...

nsIArray	getItemsByProperty (in AString aPropertyID, in AString aPropertyValue)

PRUint32	getItemCountByProperty (in AString aPropertyID, in AString aPropertyValue)

nsIArray	getItemsByProperties (in sbIPropertyArray aProperties)

unsigned long	indexOf (in sbIMediaItem aMediaItem, [optional] in unsigned long aStartFrom)
	Get the first index of a media item in the list. More...

unsigned long	lastIndexOf (in sbIMediaItem aMediaItem, in unsigned long aStartFrom)
	Get the last index of a media item int he list. More...

boolean	contains (in sbIMediaItem aMediaItem)
	Check if the list contains a media item. More...

void	add (in sbIMediaItem aMediaItem)
	Add a media item to this list. More...

sbIMediaItem	addItem (in sbIMediaItem aMediaItem)
	addItem a media item to this list More...

void	addAll (in sbIMediaList aMediaList)
	Add the contents of a media list to this list. More...

void	addSome (in nsISimpleEnumerator aMediaItems)
	Adds media items suppled by the provided enumerator NOTE: This method is now deprecated. More...

void	addMediaItems (in nsISimpleEnumerator aMediaItems, in sbIAddMediaItemsListener aListener, in boolean aAsync)
	Adds media items suppled by the provided enumerator. More...

void	remove (in sbIMediaItem aMediaItem)
	Remove the first occurrence of the given media item from the list. More...

void	removeByIndex (in unsigned long aIndex)
	Remove a media item from the list by index. More...

void	removeSome (in nsISimpleEnumerator aMediaItems)
	Removed media items suppled by the provided enumerator. More...

void	clear ()
	Clear the list. More...

void	addListener (in sbIMediaListListener aListener, [optional] in boolean aOwnsWeak, [optional] in unsigned long aFlags, [optional] in sbIPropertyArray aPropertyFilter)
	Add a listener to this media list. More...

void	removeListener (in sbIMediaListListener aListener)
	Remove a listener from this media list. More...

sbIMediaListView	createView ([optional] in sbIMediaListViewState aState)
	Create a new, raw view for this list. This is generally not the function that you want to use for making views as it will create a completely raw view, for example lacking any filterConstraint. Please consider using sbLibraryUtils.createStandardMediaListView and proceed carefully if you use this method instead. More...

void	runInBatchMode (in sbIMediaListBatchCallback aCallback, [optional] in nsISupports aUserData)
	Runs the given callback with the given user data in batch mode. More...

nsIStringEnumerator	getDistinctValuesForProperty (in AString aPropertyID)

Public Member Functions inherited from sbIMediaItem
void	testIsURIAvailable (in nsIObserver aObserver)
	Test if this media item is available for playback. More...

nsIChannel	openInputStreamAsync (in nsIStreamListener aListener, in nsISupports aContext)
	Asynchronously get an input stream to the content of the media item. More...

nsIInputStream	openInputStream ()
	Synchronously get an input stream to the content of the media item. More...

nsIOutputStream	openOutputStream ()
	Get an output stream to the content of the media item. More...

AString	toString ()
	Get a string representation of the media item, useful for debugging. More...

Public Member Functions inherited from sbILibraryResource
AString	getProperty (in AString aID)
	Get the value of a property of this resource. More...

void	setProperty (in AString aID, in AString aValue)
	Set the value of a property on this resource. More...

sbIPropertyArray	getProperties ([optional] in sbIPropertyArray aPropertyIDs)
	Get properties from this resource in a property array. More...

void	setProperties (in sbIPropertyArray aProperties)
	Sets the properties and values in the supplied property array to this resource. This works as if you called setProperty on each property in the array. More...

boolean	equals (in sbILibraryResource aOtherLibraryResource)
	Tests the equality of two library resources. More...

Public Member Functions inherited from sbIDynamicMediaList
void	update ()

Public Member Functions inherited from sbILocalDatabaseMediaItem
void	SetSuppressNotifications (in boolean aSuppress)

Static Public Member Functions
static nsresult	New (sbIMediaItem aInner, sbIMediaList *aMediaList)

Public Attributes
nsCOMPtr< sbIMediaList >	mBaseMediaList

nsCOMPtr < sbILocalDatabaseMediaItem >	mBaseLocalDatabaseMediaList

Public Attributes inherited from sbIMediaList
const unsigned short	ENUMERATIONTYPE_SNAPSHOT = 0
	This flag means that the list being enumerated is a copy that may become out of date. More...

const unsigned short	ENUMERATIONTYPE_LOCKING = 1
	This flag means that the list is protected from changes by other threads during the enumeration. More...

const unsigned short	CONTENTTYPE_NONE = 0
	These flags specify the contentType of the media list. More...

const unsigned short	CONTENTTYPE_AUDIO = 1

const unsigned short	CONTENTTYPE_VIDEO = 2

const unsigned short	CONTENTTYPE_MIX = 3

attribute AString	name
	The name of the media list. More...

readonly attribute AString	type
	The type of media list (eg "simple") More...

readonly attribute unsigned long	length
	Returns the length of the list. More...

readonly attribute boolean	isEmpty
	Is the list empty? More...

readonly attribute boolean	userEditableContent
	True if the user should be allowed to edit the content of this media list. More...

const unsigned long	LISTENER_FLAGS_ITEMADDED = 1 << 0

const unsigned long	LISTENER_FLAGS_BEFOREITEMREMOVED = 1 << 1

const unsigned long	LISTENER_FLAGS_AFTERITEMREMOVED = 1 << 2

const unsigned long	LISTENER_FLAGS_ITEMUPDATED = 1 << 3

const unsigned long	LISTENER_FLAGS_BEFORELISTCLEARED = 1 << 4

const unsigned long	LISTENER_FLAGS_LISTCLEARED = 1 << 5

const unsigned long	LISTENER_FLAGS_BATCHBEGIN = 1 << 6

const unsigned long	LISTENER_FLAGS_BATCHEND = 1 << 7

const unsigned long	LISTENER_FLAGS_ITEMMOVED = 1 << 8

const unsigned long	LISTENER_FLAGS_ALL = 0xffffffff

Public Attributes inherited from sbIMediaItem
readonly attribute sbILibrary	library
	The library that this media item is contained in. More...

readonly attribute boolean	isMutable
	Can the media item be changed? More...

readonly attribute sbIMediaItemController	itemController
	An interface to the media item controller (if any) that determines this item's availability for playback. More...

attribute long long	mediaCreated
	Creation time of the media item as a unix timestamp. More...

attribute long long	mediaUpdated
	Last modification time of the media item as a unix timestamp. More...

attribute nsIURI	contentSrc
	A nsIURI that resolves to the content of the media item. More...

attribute long long	contentLength
	Size (in bytes) of the content of the media item. More...

attribute AString	contentType
	Content type of the content of the media item, typically a mime type (should this be renamed?) More...

Public Attributes inherited from sbILibraryResource
readonly attribute AString	guid
	The guid of this resource. More...

readonly attribute long long	created
	The creation time of this resource as a unix timestamp. More...

readonly attribute long long	updated
	The last update time of this resource as a unix timestamp. More...

readonly attribute nsIStringEnumerator	propertyIDs
	Returns a string enumerator of the IDs of all the properties set on this resource. More...

readonly attribute boolean	userEditable
	True if users should be allowed to modify the resource. More...

Public Attributes inherited from sbILocalDatabaseMediaItem
readonly attribute unsigned long	mediaItemId

attribute sbILocalDatabaseResourcePropertyBag	propertyBag

Additional Inherited Members
Protected Member Functions inherited from sbSupportsWeakReference
	~sbSupportsWeakReference ()

void	ClearWeakReferences ()

PRBool	HasWeakReferences () const

Detailed Description

This class implements a dynamic media list.

Definition at line 119 of file sbLocalDatabaseDynamicMediaList.h.

Constructor & Destructor Documentation

sbLocalDatabaseDynamicMediaList::~sbLocalDatabaseDynamicMediaList ( )

virtual

Destroy a dynamic media list object.

Definition at line 202 of file sbLocalDatabaseDynamicMediaList.cpp.

sbLocalDatabaseDynamicMediaList::sbLocalDatabaseDynamicMediaList ( )

Create a dynamic media list object.

Definition at line 217 of file sbLocalDatabaseDynamicMediaList.cpp.

Here is the caller graph for this function:

Member Function Documentation

NS_IMETHOD sbLocalDatabaseDynamicMediaList::Add ( sbIMediaItem * aMediaItem )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::AddAll ( sbIMediaList * aMediaList )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::AddItem	(	sbIMediaItem *	aMediaItem,
		sbIMediaItem **	aNewMediaItem
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::AddListener	(	sbIMediaListListener *	aListener,
		PRBool	aOwnsWeak,
		PRUint32	aFlags,
		sbIPropertyArray *	aPropertyFilter
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::AddMediaItems	(	nsISimpleEnumerator *	aMediaItems,
		sbIAddMediaItemsListener *	aListener,
		PRBool	aAsync
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::AddSome ( nsISimpleEnumerator * aMediaItems )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::Clear ( void )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::Contains	(	sbIMediaItem *	aMediaItem,
		PRBool *	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::CreateView	(	sbIMediaListViewState *	aState,
		sbIMediaListView **	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::EnumerateAllItems	(	sbIMediaListEnumerationListener *	aEnumerationListener,
		PRUint16	aEnumerationType
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::EnumerateItemsByProperties	(	sbIPropertyArray *	aProperties,
		sbIMediaListEnumerationListener *	aEnumerationListener,
		PRUint16	aEnumerationType
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::EnumerateItemsByProperty	(	const nsAString &	aPropertyID,
		const nsAString &	aPropertyValue,
		sbIMediaListEnumerationListener *	aEnumerationListener,
		PRUint16	aEnumerationType
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetDistinctValuesForProperty	(	const nsAString &	aPropertyID,
		nsIStringEnumerator **	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetIsEmpty ( PRBool * aIsEmpty )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetItemByGuid	(	const nsAString &	aGuid,
		sbIMediaItem **	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetItemByIndex	(	PRUint32	aIndex,
		sbIMediaItem **	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetItemCountByProperty	(	const nsAString &	aPropertyID,
		const nsAString &	aPropertyValue,
		PRUint32 *	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetItemsByProperties	(	sbIPropertyArray *	aProperties,
		nsIArray **	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetItemsByProperty	(	const nsAString &	aPropertyID,
		const nsAString &	aPropertyValue,
		nsIArray **	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetLength ( PRUint32 * aLength )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetListContentType ( PRUint16 * _retval )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_SCRIPTABLE NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetMediaItemId ( PRUint32 * aMediaItemId )

inline

Definition at line 143 of file sbLocalDatabaseDynamicMediaList.h.

NS_DECL_ISUPPORTS NS_DECL_NSICLASSINFO NS_DECL_SBIDYNAMICMEDIALIST NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetName ( nsAString & aName )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_SCRIPTABLE NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetPropertyBag ( sbILocalDatabaseResourcePropertyBag ** aPropertyBag )

inline

Definition at line 143 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHODIMP sbLocalDatabaseDynamicMediaList::GetType ( nsAString & aType )

The type of media list (eg "simple")

Definition at line 151 of file sbLocalDatabaseDynamicMediaList.cpp.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::GetUserEditableContent ( PRBool * aUserEditableContent )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::IndexOf	(	sbIMediaItem *	aMediaItem,
		PRUint32	aStartFrom,
		PRUint32 *	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

nsresult sbLocalDatabaseDynamicMediaList::Initialize ( sbIMediaItem * aInner )

Initialize the dynamic media list using the inner media item specified by aInner.

Parameters

aInner Media list inner media item.

Definition at line 237 of file sbLocalDatabaseDynamicMediaList.cpp.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::LastIndexOf	(	sbIMediaItem *	aMediaItem,
		PRUint32	aStartFrom,
		PRUint32 *	_retval
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

nsresult sbLocalDatabaseDynamicMediaList::New	(	sbIMediaItem *	aInner,
		sbIMediaList **	aMediaList
	)

static

Create and initialize a dynamic media list for the inner media item specified by aInner. Return the created dynamic media list in aMediaList.

Parameters

aInner	Media list inner media item.
aMediaList	Returned created dynamic media list.

Definition at line 173 of file sbLocalDatabaseDynamicMediaList.cpp.

Here is the call graph for this function:

sbLocalDatabaseDynamicMediaList::NS_IMETHOD_ ( void )

inline

Definition at line 143 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::Remove ( sbIMediaItem * aMediaItem )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::RemoveByIndex ( PRUint32 aIndex )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::RemoveListener ( sbIMediaListListener * aListener )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::RemoveSome ( nsISimpleEnumerator * aMediaItems )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::RunInBatchMode	(	sbIMediaListBatchCallback *	aCallback,
		nsISupports *	aUserData
	)

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_IMETHOD sbLocalDatabaseDynamicMediaList::SetName ( const nsAString & aName )

inline

Definition at line 142 of file sbLocalDatabaseDynamicMediaList.h.

NS_SCRIPTABLE NS_IMETHOD sbLocalDatabaseDynamicMediaList::SetPropertyBag ( sbILocalDatabaseResourcePropertyBag * aPropertyBag )

inline

Definition at line 143 of file sbLocalDatabaseDynamicMediaList.h.

Member Data Documentation

nsCOMPtr<sbILocalDatabaseMediaItem> sbLocalDatabaseDynamicMediaList::mBaseLocalDatabaseMediaList

Definition at line 185 of file sbLocalDatabaseDynamicMediaList.h.

nsCOMPtr<sbIMediaList> sbLocalDatabaseDynamicMediaList::mBaseMediaList

Definition at line 184 of file sbLocalDatabaseDynamicMediaList.h.

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

/home/martin/dev/nightingale-hacking/components/library/localdatabase/src/sbLocalDatabaseDynamicMediaList.h
/home/martin/dev/nightingale-hacking/components/library/localdatabase/src/sbLocalDatabaseDynamicMediaList.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation