Public Member Functions | |
void | registerPlaylistCommandsMediaItem (in AString aContextGUID, in AString aPlaylistType, in sbIPlaylistCommands aCommandObj) |
Register sbIPlaylistCommands objects to be shown for specific playlists in order to let the user perform actions on a playlist's items. | |
void | unregisterPlaylistCommandsMediaItem (in AString aContextGUID, in AString aPlaylistType, in sbIPlaylistCommands aCommandObj) |
Unregister a sbIPlaylistCommands object that was previously registered to registerPlaylistCommandsMediaItem. | |
nsISimpleEnumerator | getPlaylistCommandsMediaItem (in AString aContextGUID, in AString aPlaylistType) |
Retrieve the list of sbIPlaylistCommands objects registered to a specific playlist. | |
void | registerPlaylistCommandsMediaList (in AString aContextGUID, in AString aPlaylistType, in sbIPlaylistCommands aCommandObj) |
Register sbIPlaylistCommands objects to be shown for specific playlists in order to let the user perform actions on the playlist itself. | |
void | unregisterPlaylistCommandsMediaList (in AString aContextGUID, in AString aPlaylistType, in sbIPlaylistCommands aCommandObj) |
Unregister a sbIPlaylistCommands object that was previously registered to registerPlaylistCommandsMediaList. | |
nsISimpleEnumerator | getPlaylistCommandsMediaList (in AString aContextGUID, in AString aPlaylistType) |
Retrieve the list of sbIPlaylistCommands objects to be used for a specific playlist. | |
void | publish (in AString aCommandGUID, in sbIPlaylistCommands aCommandObj) |
Publish an sbIPlaylistCommands interface for public consumption. | |
void | withdraw (in AString aCommandGUID, in sbIPlaylistCommands aCommandObj) |
Withdraw a previously published sbIPlaylistCommands interface. | |
sbIPlaylistCommands | request (in AString aContextGUID) |
Request a copy of a published sbIPlaylistCommands interface. |
Definition at line 420 of file sbIPlaylistCommands.idl.
void sbIPlaylistCommandsManager::registerPlaylistCommandsMediaItem | ( | in AString | aContextGUID, | |
in AString | aPlaylistType, | |||
in sbIPlaylistCommands | aCommandObj | |||
) |
Register sbIPlaylistCommands objects to be shown for specific playlists in order to let the user perform actions on a playlist's items.
The sbIPlaylistCommands interface is used to algorithmically define a set of commands to be rendered arbitrarily by a playlist ui object (currently, playlist.xml).
Commands can be registered for a specific playlist, or for any "type" characteristic.
aContextGUID | The guid string for the database to register against | |
aPlaylistType | The arbitrary type string to register against | |
aCommandObj | The command object instance to be used for these playlists |
void sbIPlaylistCommandsManager::unregisterPlaylistCommandsMediaItem | ( | in AString | aContextGUID, | |
in AString | aPlaylistType, | |||
in sbIPlaylistCommands | aCommandObj | |||
) |
Unregister a sbIPlaylistCommands object that was previously registered to registerPlaylistCommandsMediaItem.
aContextGUID | The guid that was used to register the sbIPlaylistCommand | |
aPlaylistType | The type string that was used to register the sbIPlaylistCommand | |
aCommandObj | The command object that was registered |
nsISimpleEnumerator sbIPlaylistCommandsManager::getPlaylistCommandsMediaItem | ( | in AString | aContextGUID, | |
in AString | aPlaylistType | |||
) |
Retrieve the list of sbIPlaylistCommands objects registered to a specific playlist.
Given the guid, and type strings, returns a list of duplicate instances of the corresponding sbIPlaylistCommands objects.
The "guid" has precedence over the "type" string.
This method is only called by the playlist UI object, in playlist.xml
aContextGUID | The guid string for the playlist | |
aPlaylistType | The type of the playlist |
void sbIPlaylistCommandsManager::registerPlaylistCommandsMediaList | ( | in AString | aContextGUID, | |
in AString | aPlaylistType, | |||
in sbIPlaylistCommands | aCommandObj | |||
) |
Register sbIPlaylistCommands objects to be shown for specific playlists in order to let the user perform actions on the playlist itself.
The sbIPlaylistCommands interface is used to algorithmically define a set of commands to be rendered arbitrarily by a service tree ui object (currently, servicePane.xml).
Commands can be registered for a specific playlist, or for any "type" characteristic.
aContextGUID | The guid string for the database to register against | |
aPlaylistType | The arbitrary type string to register against | |
aCommandObj | The command object instance to be used for these playlists |
void sbIPlaylistCommandsManager::unregisterPlaylistCommandsMediaList | ( | in AString | aContextGUID, | |
in AString | aPlaylistType, | |||
in sbIPlaylistCommands | aCommandObj | |||
) |
Unregister a sbIPlaylistCommands object that was previously registered to registerPlaylistCommandsMediaList.
aContextGUID | The guid that was used to register the sbIPlaylistCommand | |
aPlaylistType | The type string that was used to register the sbIPlaylistCommand | |
aCommandObj | The command object that was registered |
nsISimpleEnumerator sbIPlaylistCommandsManager::getPlaylistCommandsMediaList | ( | in AString | aContextGUID, | |
in AString | aPlaylistType | |||
) |
Retrieve the list of sbIPlaylistCommands objects to be used for a specific playlist.
Given the guid, and type strings, returns a list of duplicate instances of the corresponding sbIPlaylistCommands objects.
The "guid" has precedence over the "type" string.
This method is only called by the servicepane UI object, in servicePane.xml
aContextGUID | The guid string for the playlist | |
aPlaylistType | The type of the playlist |
void sbIPlaylistCommandsManager::publish | ( | in AString | aCommandGUID, | |
in sbIPlaylistCommands | aCommandObj | |||
) |
Publish an sbIPlaylistCommands interface for public consumption.
An sbIPlaylistCommands interface may be published so that third party code may reuse them in their own command sets.
aCommandGUID | The GUID identifying this command interface | |
aCommandObj | The interface to publish |
void sbIPlaylistCommandsManager::withdraw | ( | in AString | aCommandGUID, | |
in sbIPlaylistCommands | aCommandObj | |||
) |
Withdraw a previously published sbIPlaylistCommands interface.
Note that the original interface must be passed to this function for the call to succeed. Since calling request() returns a copy of the interface rather than the original interface itself, it means that you cannot withdraw someone else's interface unless you have access to it directly.
aCommandGUID | The GUID identifying this command interface | |
aCommandObj | The interface to withdraw |
sbIPlaylistCommands sbIPlaylistCommandsManager::request | ( | in AString | aContextGUID | ) |
Request a copy of a published sbIPlaylistCommands interface.
aCommandGUID | The GUID identifying this command interface |