Interface used to listen to changes to a media list. More...

import"sbIMediaListListener.idl";

Inheritance diagram for sbIMediaListListener:

Collaboration diagram for sbIMediaListListener:

Public Member Functions
boolean	onItemAdded (in sbIMediaList aMediaList, in sbIMediaItem aMediaItem, in unsigned long aIndex)
	Called when a media item is added to the list. More...

boolean	onBeforeItemRemoved (in sbIMediaList aMediaList, in sbIMediaItem aMediaItem, in unsigned long aIndex)
	Called before a media item is removed from the list. More...

boolean	onAfterItemRemoved (in sbIMediaList aMediaList, in sbIMediaItem aMediaItem, in unsigned long aIndex)
	Called after a media item is removed from the list. More...

boolean	onItemUpdated (in sbIMediaList aMediaList, in sbIMediaItem aMediaItem, in sbIPropertyArray aProperties)
	Called when a media item is changed. More...

boolean	onItemMoved (in sbIMediaList aMediaList, in unsigned long aFromIndex, in unsigned long aToIndex)
	Called when a media item is moved. More...

boolean	onBeforeListCleared (in sbIMediaList aMediaList, in boolean aExcludeLists)

boolean	onListCleared (in sbIMediaList aMediaList, in boolean aExcludeLists)

void	onBatchBegin (in sbIMediaList aMediaList)
	Called when the library is about to perform multiple operations at once. More...

void	onBatchEnd (in sbIMediaList aMediaList)
	Called when the library has finished performing multiple operations at once. More...

Detailed Description

Interface used to listen to changes to a media list.

Implementors of this interface can listen to changes in a media list.

See Also: sbIMediaList

Definition at line 48 of file sbIMediaListListener.idl.

Member Function Documentation

boolean sbIMediaListListener::onAfterItemRemoved	(	in sbIMediaList	aMediaList,
		in sbIMediaItem	aMediaItem,
		in unsigned long	aIndex
	)

Called after a media item is removed from the list.

Parameters

aMediaList	The list that has changed.
aMediaItem	The removed media item.
aIndex	Index from where the item was removed

Returns: True if you do not want any further onAfterItemRemoved for the current batch. If there is no current batch, the return value is ignored.

void sbIMediaListListener::onBatchBegin ( in sbIMediaList aMediaList )

Called when the library is about to perform multiple operations at once.

This notification can be used to optimize behavior. The consumer may choose to ignore further onItemAdded or onItemRemoved notifications until the onBatchEnd notification is received.

Parameters

aMediaList The list that has changed.

void sbIMediaListListener::onBatchEnd ( in sbIMediaList aMediaList )

Called when the library has finished performing multiple operations at once.

This notification can be used to optimize behavior. The consumer may choose to stop ignoring onItemAdded or onItemRemoved notifications after receiving this notification.

Parameters

aMediaList The list that has changed.

boolean sbIMediaListListener::onBeforeItemRemoved	(	in sbIMediaList	aMediaList,
		in sbIMediaItem	aMediaItem,
		in unsigned long	aIndex
	)

Called before a media item is removed from the list.

Parameters

aMediaList	The list that has changed.
aMediaItem	The media item to be removed
aIndex	The index of the item to be removed

Returns: True if you do not want any further onBeforeItemRemoved notifications for the current batch. If there is no current batch, the return value is ignored.

boolean sbIMediaListListener::onBeforeListCleared	(	in sbIMediaList	aMediaList,
		in boolean	aExcludeLists
	)

Called before a media list is cleared.

Parameters

sbIMediaList	aMediaList The list that is about to be cleared.
aExcludeLists	If true, only media items, not media lists, are being cleared.

Returns: True if you do not want any further onBeforeListCleared notifications for the current batch. If there is no current batch, the return value is ignored.

boolean sbIMediaListListener::onItemAdded	(	in sbIMediaList	aMediaList,
		in sbIMediaItem	aMediaItem,
		in unsigned long	aIndex
	)

Called when a media item is added to the list.

Parameters

aMediaList	The list that has changed.
aMediaItem	The new media item.
aIndex	The index in the list where the new item was added

Returns: True if you do not want any further onItemAdded notifications for the current batch. If there is no current batch, the return value is ignored.

boolean sbIMediaListListener::onItemMoved	(	in sbIMediaList	aMediaList,
		in unsigned long	aFromIndex,
		in unsigned long	aToIndex
	)

Called when a media item is moved.

Parameters

sbIMediaList	aMediaList The list that contains the item that moved.
aFromIndex	Index of the item that was moved
aToIndex	New index of the moved item

Returns: True if you do not want any further onItemMoved notifications for the current batch. If there is no current batch, the return value is ignored.

boolean sbIMediaListListener::onItemUpdated	(	in sbIMediaList	aMediaList,
		in sbIMediaItem	aMediaItem,
		in sbIPropertyArray	aProperties
	)

Called when a media item is changed.

Parameters

aMediaList	The list that has changed.
aMediaItem	The item that has changed.
aProperties	Array of properties that were updated. Each property's value is the previous value of the property

Returns: True if you do not want any further onItemUpdated notifications for the current batch. If there is no current batch, the return value is ignored.

boolean sbIMediaListListener::onListCleared	(	in sbIMediaList	aMediaList,
		in boolean	aExcludeLists
	)

Called when a media list is cleared.

Parameters

sbIMediaList	aMediaList The list that was cleared.
aExcludeLists	If true, only media items, not media lists, were cleared.

Returns: True if you do not want any further onListCleared notifications for the current batch. If there is no current batch, the return value is ignored.

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

/home/martin/dev/nightingale-hacking/components/library/base/public/sbIMediaListListener.idl

Public Member Functions

Detailed Description

Member Function Documentation