sbIMediaItemsTransferContext Interface Reference

This interface represents a transfer of a collection of media items and/or media lists. More...

import"sbILibraryTransferContext.idl";

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

Public Member Functions

void reset ()
 Reset the items enumerator above to re-start at the first item. More...
 

Public Attributes

readonly attribute
nsISimpleEnumerator 
items
 Depending on the flavor of this transfer context, this enumerator may return a list of sbIMediaItem or a list of sbIMediaList. More...
 
readonly attribute
nsISimpleEnumerator 
indexedItems
 The indexed items, for use if you need indices. This may not actually exist, since it is possible to simply throw some items together for dropping somewhere. More...
 
- Public Attributes inherited from sbILibraryTransferContext
readonly attribute sbIMediaList source
 The list the item or items were dragged from. More...
 
readonly attribute unsigned long count
 The number of items in the transfer context. More...
 

Detailed Description

This interface represents a transfer of a collection of media items and/or media lists.

This interface will be sent with the following flavors: application/x-sb-transfer-media-item (enumerator returns sbIMediaItem) application/x-sb-transfer-media-items (enumerator returns sbIMediaItem) application/x-sb-transfer-media-lists (enumerator returns sbIMediaList)

Note that since a media item is a media list, a transfer context whose flavor is "application/x-sb-transfer-media-items" may indeed still contain media lists. Therefore consumers who want to treat lists differently will need to check the contents of the enumerator to determine if lists are present.

Definition at line 92 of file sbILibraryTransferContext.idl.

Member Function Documentation

void sbIMediaItemsTransferContext::reset ( )

Reset the items enumerator above to re-start at the first item.

See Also
nsIEnumerator.first()

Member Data Documentation

readonly attribute nsISimpleEnumerator sbIMediaItemsTransferContext::indexedItems

The indexed items, for use if you need indices. This may not actually exist, since it is possible to simply throw some items together for dropping somewhere.

Definition at line 106 of file sbILibraryTransferContext.idl.

readonly attribute nsISimpleEnumerator sbIMediaItemsTransferContext::items

Depending on the flavor of this transfer context, this enumerator may return a list of sbIMediaItem or a list of sbIMediaList.

Definition at line 98 of file sbILibraryTransferContext.idl.


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