import"sbIPlaylistWidget.idl";
Public Member Functions | |
| void | rescanCommands () |
| Cause the commands to be re-fetched. More... | |
| sbIMediaListView | getListView () |
| Get the view being displayed in the <WebPlaylist> More... | |
| void | bind (in sbIMediaListView mediaListView, in sbIPlaylistCommands commands, in boolean resize, in boolean collapse) |
| Attach the <WebPlaylist> to the view passed in. More... | |
| unsigned long | getColumnCount () |
| Get the total number of columns in the web playlist. More... | |
| void | clearColumns () |
| Clear all columns from the web playlist. More... | |
| void | appendColumn (in AString aPropertyID, [optional] in AString aWidth) |
| Add a column to the right side of visible columns. More... | |
| void | insertColumnBefore (in AString aPropertyID, [optional] in AString aBeforePropertyID, [optional] in AString aWidth) |
| Insert a column into the web playlist. More... | |
| void | removeColumn (in AString aPropertyID) |
| Remove a column from the playlist. More... | |
| AString | getColumnPropertyIDByIndex (in unsigned long aIndex) |
| Get the property ID bould to a particular column at a given index. More... | |
| void | setSortColumn (in AString aPropertyID, in boolean aIsAscending) |
| Set the sort of the web playlist. More... | |
Public Attributes | |
| readonly attribute sbIPlaylistClickEvent | lastClickEvent |
| The last click even that occured on this <WebPlaylist> More... | |
Definition at line 48 of file sbIPlaylistWidget.idl.
| void sbIPlaylistWidget::appendColumn | ( | in AString | aPropertyID, |
| [optional] in AString | aWidth | ||
| ) |
Add a column to the right side of visible columns.
| 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::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.
| 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 |
| void sbIPlaylistWidget::clearColumns | ( | ) |
Clear all columns from the web playlist.
| unsigned long sbIPlaylistWidget::getColumnCount | ( | ) |
Get the total number of columns in the web playlist.
| AString sbIPlaylistWidget::getColumnPropertyIDByIndex | ( | in unsigned long | aIndex | ) |
Get the property ID bould to a particular column at a given index.
| aIndex | - The index of the column from which you want to retrieve the bound property |
| sbIMediaListView sbIPlaylistWidget::getListView | ( | ) |
Get the view being displayed in the <WebPlaylist>
NOTE - Not callable from web pages.
| void sbIPlaylistWidget::insertColumnBefore | ( | in AString | aPropertyID, |
| [optional] in AString | aBeforePropertyID, | ||
| [optional] in AString | aWidth | ||
| ) |
Insert a column into the web playlist.
| 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.
| aPropertyID | - The ID of the property that is bound to the column you wish to remove. |
| 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.
| void sbIPlaylistWidget::setSortColumn | ( | in AString | aPropertyID, |
| in boolean | aIsAscending | ||
| ) |
Set the sort of the web playlist.
| 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. |
| 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.
