Songbird / Development / Songbird Add-Ons API Documentation

sbIOrderableMediaList Interface Reference

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

import "sbIOrderableMediaList.idl";

List of all members.

Public Member Functions

void insertBefore (in unsigned long aIndex, in sbIMediaItem aMediaItem)
 Insert a media item before the specified media item.
void insertAllBefore (in unsigned long aIndex, in sbIMediaList aMediaList)
 Insert a media list before the specified media item.
void moveBefore (in unsigned long aFromIndex, in unsigned long aToIndex)
 Move a media item from one position to another in the list.
void moveLast (in unsigned long aIndex)
 Move a media item to the end of the list.
void insertSomeBefore (in unsigned long aIndex, in nsISimpleEnumerator aMediaItems)
 Insert many media items before the specified media item.
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.
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.


Detailed Description

Media lists that implement this interface support custom ordering.

See also:
sbIMediaList

Definition at line 45 of file sbIOrderableMediaList.idl.


Member Function Documentation

void sbIOrderableMediaList::insertBefore ( in unsigned long  aIndex,
in sbIMediaItem  aMediaItem 
)

Insert a media item before the specified media item.

Parameters:
aIndex Position of item to insert before
aMediaItem Media item to insert

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

Insert a media list before the specified media item.

Parameters:
aIndex Position of item to insert before
aMediaItem Media list to insert

void sbIOrderableMediaList::moveBefore ( in unsigned long  aFromIndex,
in unsigned long  aToIndex 
)

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

Parameters:
aFromIndex Index of media item to move
aToIndex Index 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:
aIndex Index of media item to move

void sbIOrderableMediaList::insertSomeBefore ( in unsigned long  aIndex,
in nsISimpleEnumerator  aMediaItems 
)

Insert many media items before the specified media item.

Parameters:
aIndex Position of item to insert before
aMediaItems Simple enumerator of sbIMediaItem objects to insert

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:
aFromIndexArray Array of indexes of media items to move
aToIndex Index 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:
aIndexArray Array of the indexes of media items to move


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:29:01 2009 for Songbird by  doxygen 1.5.2