Songbird / Development / Songbird Add-Ons API Documentation

sbIPlaylistWidget Interface Reference

List of all members.

Public Member Functions

void rescanCommands ()
 Cause the commands to be re-fetched.
sbIMediaListView getListView ()
 Get the view being displayed in the <WebPlaylist>.
void bind (in sbIMediaListView mediaListView, in sbIPlaylistCommands commands, in boolean resize, in boolean collapse)
 Attach the <WebPlaylist> to the view passed in.
unsigned long getColumnCount ()
 Get the total number of columns in the web playlist.
void clearColumns ()
 Clear all columns from the web playlist.
void appendColumn (in AString aPropertyID,[optional] in AString aWidth)
 Add a column to the right side of visible columns.
void insertColumnBefore (in AString aPropertyID,[optional] in AString aBeforePropertyID,[optional] in AString aWidth)
 Insert a column into the web playlist.
void removeColumn (in AString aPropertyID)
 Remove a column from the playlist.
AString getColumnPropertyIDByIndex (in unsigned long aIndex)
 Get the property ID bould to a particular column at a given index.
void setSortColumn (in AString aPropertyID, in boolean aIsAscending)
 Set the sort of the web playlist.

Public Attributes

readonly attribute sbIPlaylistClickEvent lastClickEvent
 The last click even that occured on this <WebPlaylist>.

Detailed Description

Definition at line 48 of file sbIPlaylistWidget.idl.


Member Function Documentation

void sbIPlaylistWidget::rescanCommands (  ) 

Cause the commands to be re-fetched.

This will cause the playlist to fetch the list of commands again so that any newly added commands will appear in the UI for the playlist

NOTE - Not callable from web pages.

sbIMediaListView sbIPlaylistWidget::getListView (  ) 

Get the view being displayed in the <WebPlaylist>.

NOTE - Not callable from web pages.

Returns:
A medialist view for the currently displayed medialist

void sbIPlaylistWidget::bind ( in sbIMediaListView  mediaListView,
in sbIPlaylistCommands  commands,
in boolean  resize,
in boolean  collapse 
)

Attach the <WebPlaylist> to the view passed in.

NOTE - Not callable from web pages.

Parameters:
mediaListView - the ordered, sorted, selected grouping of tracks to display in the UI
commands - the commands to be used
resize - boolean, if true the playlist will look up the resize_height attribute for the size to resize to.
collapse - apparently no longer used

unsigned long sbIPlaylistWidget::getColumnCount (  ) 

Get the total number of columns in the web playlist.

Returns:
The number of columns in the web playlist

void sbIPlaylistWidget::appendColumn ( in AString  aPropertyID,
[optional] in AString  aWidth 
)

Add a column to the right side of visible columns.

Parameters:
aPropertyID - The ID of the property you want to add as a column
aWidth - The width in pixels of the column. If there has been a width set for this particular column then that width will be respected and this ignored.

void sbIPlaylistWidget::insertColumnBefore ( in AString  aPropertyID,
[optional] in AString  aBeforePropertyID,
[optional] in AString  aWidth 
)

Insert a column into the web playlist.

Parameters:
aPropertyID - The ID of the property you want to add as a column
aBeforePropertyID - If specified, the new column will appear before the column that is bound to the specified property. If not specified, the column will be added to the end of the list.
aWidth - The width in pixels of the column. If there has been a width set for this particular column then that width will be respected and this ignored.

void sbIPlaylistWidget::removeColumn ( in AString  aPropertyID  ) 

Remove a column from the playlist.

Parameters:
aPropertyID - The ID of the property that is bound to the column you wish to remove.

AString sbIPlaylistWidget::getColumnPropertyIDByIndex ( in unsigned long  aIndex  ) 

Get the property ID bould to a particular column at a given index.

Parameters:
aIndex - The index of the column from which you want to retrieve the bound property
Returns:
The ID of the property bound to the specified column

void sbIPlaylistWidget::setSortColumn ( in AString  aPropertyID,
in boolean  aIsAscending 
)

Set the sort of the web playlist.

Parameters:
aPropertyID - The ID of the property that is bound to the column you wish to sort.
aIsAscending - True if the sort should be ascending, false if the sort should be descending.


Member Data Documentation

readonly attribute sbIPlaylistClickEvent sbIPlaylistWidget::lastClickEvent

The last click even that occured on this <WebPlaylist>.

This is used only during the propogation of the PlaylistClickEvent event and will only be non-null for a very brief time during that flow.

Definition at line 231 of file sbIPlaylistWidget.idl.


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