Songbird / Development / Songbird Add-Ons API Documentation

sbIPlaylistCommandsManager Interface Reference
[Playlist CommandsPlaylist Commands]

The service used to register, unregister, and list playlist commands for a particular playlist guid or type. More...

List of all members.

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.


Detailed Description

The service used to register, unregister, and list playlist commands for a particular playlist guid or type.

Definition at line 420 of file sbIPlaylistCommands.idl.


Member Function Documentation

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.

Parameters:
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
See also:
sbIPlaylistCommands, unregisterPlaylistCommands, playlist.xml

http://publicsvn.songbirdnest.com/browser/extensions/commandsexample/chrome/content/scripts/CommandsExample.js#L154

http://publicsvn.songbirdnest.com/browser/trunk/components/playlistcommands/src/sbPublicPlaylistCommands.js#L627

void sbIPlaylistCommandsManager::unregisterPlaylistCommandsMediaItem ( in AString  aContextGUID,
in AString  aPlaylistType,
in sbIPlaylistCommands  aCommandObj 
)

Unregister a sbIPlaylistCommands object that was previously registered to registerPlaylistCommandsMediaItem.

Parameters:
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
See also:
sbIPlaylistCommands, registerPlaylistCommands, playlist.xml

http://publicsvn.songbirdnest.com/browser/extensions/commandsexample/chrome/content/scripts/CommandsExample.js#L194

http://publicsvn.songbirdnest.com/browser/trunk/components/playlistcommands/src/sbPublicPlaylistCommands.js#L736

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

Parameters:
aContextGUID The guid string for the playlist
aPlaylistType The type of the playlist
Returns:
A simple enumerator of newly duplicated command object instances to be used for this playlist
See also:
sbIPlaylistCommands, playlist.xml

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.

Parameters:
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
See also:
sbIPlaylistCommands, unregisterPlaylistCommands, playlist.xml

http://publicsvn.songbirdnest.com/browser/trunk/components/playlistcommands/src/sbPublicPlaylistCommands.js#L681

void sbIPlaylistCommandsManager::unregisterPlaylistCommandsMediaList ( in AString  aContextGUID,
in AString  aPlaylistType,
in sbIPlaylistCommands  aCommandObj 
)

Unregister a sbIPlaylistCommands object that was previously registered to registerPlaylistCommandsMediaList.

Parameters:
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
See also:
sbIPlaylistCommands, registerPlaylistCommands, playlist.xml

http://publicsvn.songbirdnest.com/browser/trunk/components/playlistcommands/src/sbPublicPlaylistCommands.js#L741

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

Parameters:
aContextGUID The guid string for the playlist
aPlaylistType The type of the playlist
Returns:
A simple enumerator of newly duplicated command object instances to be used for this playlist
See also:
sbIPlaylistCommands, servicePane.xml

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.

Parameters:
aCommandGUID The GUID identifying this command interface
aCommandObj The interface to publish
See also:
request, withdraw, kPlaylistCommands.jsm, sbIPlaylistCommands

http://publicsvn.songbirdnest.com/browser/trunk/components/playlistcommands/src/sbPublicPlaylistCommands.js#L539

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.

Parameters:
aCommandGUID The GUID identifying this command interface
aCommandObj The interface to withdraw
See also:
publish, request, kPlaylistCommands.jsm, sbIPlaylistCommands

http://publicsvn.songbirdnest.com/browser/trunk/components/playlistcommands/src/sbPublicPlaylistCommands.js#L694

sbIPlaylistCommands sbIPlaylistCommandsManager::request ( in AString  aContextGUID  ) 

Request a copy of a published sbIPlaylistCommands interface.

Parameters:
aCommandGUID The GUID identifying this command interface
Returns:
A copy of the requested interface, or null if that interface is not in the manager's repository.
See also:
publish, withdraw, kPlaylistCommands.jsm, sbIPlaylistCommands

http://publicsvn.songbirdnest.com/browser/extensions/commandsexample/chrome/content/scripts/CommandsExample.js#L130


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