A generic interface for UI that renders a media list view. More...
import"sbIMediaPage.idl";
Public Member Functions | |
| PRBool | highlightItem (in unsigned long aViewIndex) |
| Tell the page to make the MediaItem at the given index visible and highlighted. More... | |
| PRBool | canDrop (in nsIDOMEvent aEvent, in nsIDragSession aSession) |
| Called when something is dragged over the tabbrowser tab for this page. More... | |
| PRBool | onDrop (in nsIDOMEvent aEvent, in nsIDragSession aSession) |
| Called when something is dropped on the tabbrowser tab for this page. More... | |
Public Attributes | |
| attribute sbIMediaListView | mediaListView |
| A filtered, sorted view of the media list that the page is supposed to render. More... | |
| readonly attribute PRBool | isOnlyView |
| Should be true if the media page is the only allowed view for the data. More... | |
A generic interface for UI that renders a media list view.
Pages that display libraries or other media lists must supply this interface in order for browser history, playback, find current track, and other external functionality to work as expected.
The primary purpose of the interface is to facilitate setting the sbIMediaListView that the page is to display.
For sample code and more information, see http://developer.songbirdnest.com/add-on-api/
Definition at line 49 of file sbIMediaPage.idl.
| PRBool sbIMediaPage::canDrop | ( | in nsIDOMEvent | aEvent, |
| in nsIDragSession | aSession | ||
| ) |
Called when something is dragged over the tabbrowser tab for this page.
| aEvent | The draggedover event |
| aSession | The items to be dropped |
| PRBool sbIMediaPage::highlightItem | ( | in unsigned long | aViewIndex | ) |
Tell the page to make the MediaItem at the given index visible and highlighted.
| aViewIndex | Index into the MediaListView (needed, since MediaItems may appear multiple times in a list) |
| PRBool sbIMediaPage::onDrop | ( | in nsIDOMEvent | aEvent, |
| in nsIDragSession | aSession | ||
| ) |
Called when something is dropped on the tabbrowser tab for this page.
| aEvent | The drop event |
| aSession | The items to be dropped |
| readonly attribute PRBool sbIMediaPage::isOnlyView |
Should be true if the media page is the only allowed view for the data.
Definition at line 68 of file sbIMediaPage.idl.
| attribute sbIMediaListView sbIMediaPage::mediaListView |
A filtered, sorted view of the media list that the page is supposed to render.
The mediaListView will be set by the browser during the capturing phase of the window load event, meaning that it should be available by standard onLoad time.
Note that the mediaListView should not be set again after load.
Definition at line 62 of file sbIMediaPage.idl.
