sbIOrderableMediaList Interface Reference

Media lists that implement this interface support custom ordering. More...

import"sbIOrderableMediaList.idl";

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

Public Member Functions

void insertBefore (in unsigned long aIndex, in sbIMediaItem aMediaItem)
 Insert a media item before the specified media item. More...
 
void insertAllBefore (in unsigned long aIndex, in sbIMediaList aMediaList)
 Insert a media list before the specified media item. More...
 
void moveBefore (in unsigned long aFromIndex, in unsigned long aToIndex)
 Move a media item from one position to another in the list. More...
 
void moveLast (in unsigned long aIndex)
 Move a media item to the end of the list. More...
 
void insertSomeBefore (in unsigned long aIndex, in nsISimpleEnumerator aMediaItems)
 Insert many media items before the specified media item. More...
 
void insertSomeBeforeAsync (in unsigned long aIndex, in nsISimpleEnumerator aMediaItems, in sbIMediaListAsyncListener aListener)
 Insert many media items before the specified media item asynchronously. More...
 
void moveSomeBefore ([array, size_is(aFromIndexArrayCount)] in unsigned long aFromIndexArray, in unsigned long aFromIndexArrayCount, in unsigned long aToIndex)
 Move a list of media items from one position to another in the list. More...
 
void moveSomeLast ([array, size_is(aIndexArrayCount)] in unsigned long aIndexArray, in unsigned long aIndexArrayCount)
 Move a list of media items to the end of the list. More...
 

Detailed Description

Media lists that implement this interface support custom ordering.

See Also
sbIMediaList

Definition at line 46 of file sbIOrderableMediaList.idl.

Member Function Documentation

void sbIOrderableMediaList::insertAllBefore ( in unsigned long  aIndex,
in sbIMediaList  aMediaList 
)

Insert a media list before the specified media item.

Parameters
aIndexPosition of item to insert before
aMediaItemMedia list to insert
void sbIOrderableMediaList::insertBefore ( in unsigned long  aIndex,
in sbIMediaItem  aMediaItem 
)

Insert a media item before the specified media item.

Parameters
aIndexPosition of item to insert before
aMediaItemMedia item to insert
void sbIOrderableMediaList::insertSomeBefore ( in unsigned long  aIndex,
in nsISimpleEnumerator  aMediaItems 
)

Insert many media items before the specified media item.

Parameters
aIndexPosition of item to insert before
aMediaItemsSimple enumerator of sbIMediaItem objects to insert
void sbIOrderableMediaList::insertSomeBeforeAsync ( in unsigned long  aIndex,
in nsISimpleEnumerator  aMediaItems,
in sbIMediaListAsyncListener  aListener 
)

Insert many media items before the specified media item asynchronously.

Parameters
aIndexPosition of item to insert before
aMediaItemsSimple enumerator of sbIMediaItem objects to insert
aListenerA listener that will get called with progress information
void sbIOrderableMediaList::moveBefore ( in unsigned long  aFromIndex,
in unsigned long  aToIndex 
)

Move a media item from one position to another in the list.

Parameters
aFromIndexIndex of media item to move
aToIndexIndex of media item to insert the moved item before
void sbIOrderableMediaList::moveLast ( in unsigned long  aIndex)

Move a media item to the end of the list.

Parameters
aIndexIndex of media item to move
void sbIOrderableMediaList::moveSomeBefore ( [array, size_is(aFromIndexArrayCount)] in unsigned long  aFromIndexArray,
in unsigned long  aFromIndexArrayCount,
in unsigned long  aToIndex 
)

Move a list of media items from one position to another in the list.

Parameters
aFromIndexArrayArray of indexes of media items to move
aToIndexIndex of media item to insert the moved items before
void sbIOrderableMediaList::moveSomeLast ( [array, size_is(aIndexArrayCount)] in unsigned long  aIndexArray,
in unsigned long  aIndexArrayCount 
)

Move a list of media items to the end of the list.

Parameters
aIndexArrayArray of the indexes of media items to move

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