CPlaylistCommandsManager Class Reference

#include <PlaylistCommandsManager.h>

Inheritance diagram for CPlaylistCommandsManager:
[legend]
Collaboration diagram for CPlaylistCommandsManager:
[legend]

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_SBIPLAYLISTCOMMANDSMANAGER 
CPlaylistCommandsManager ()
 
virtual ~CPlaylistCommandsManager ()
 
- Public Member Functions inherited from sbIPlaylistCommandsManager
void registerPlaylistCommandsForLibrary (in PRBool aTargetServicePane, in sbiLibrary aLibrary, in sbIPlaylistCommands aCommandObj)
 Register sbIPlaylistCommands objects to be shown for aLibrary and all mediaLists in that library. A listener will be created to detect if a medialist is added or removed from the specified library and aCommandObj will be automatically registered or unregistered from that list. More...
 
void unregisterPlaylistCommandsForLibrary (in PRBool aTargetServicePane, in sbiLibrary aLibrary, in sbIPlaylistCommands aCommandObj)
 Unregister an sbIPlaylistCommands object from aLibrary. This will only successfully unregister commands that were registered by registerPlaylistCommandsForLibrary. The command will be removed from the list that represents the library and from all medialists in that library. More...
 
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. More...
 
void unregisterPlaylistCommandsMediaItem (in AString aContextGUID, in AString aPlaylistType, in sbIPlaylistCommands aCommandObj)
 Unregister a sbIPlaylistCommands object that was previously registered to registerPlaylistCommandsMediaItem. More...
 
sbIPlaylistCommands getPlaylistCommandsMediaItem (in AString aContextGUID, in AString aPlaylistType)
 Retrieve the root sbIPlaylistCommands object registered to a specific medialist guid or type. More...
 
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. More...
 
void unregisterPlaylistCommandsMediaList (in AString aContextGUID, in AString aPlaylistType, in sbIPlaylistCommands aCommandObj)
 Unregister a sbIPlaylistCommands object that was previously registered to registerPlaylistCommandsMediaList. More...
 
sbIPlaylistCommands getPlaylistCommandsMediaList (in AString aContextGUID, in AString aPlaylistType)
 Retrieve the root sbIPlaylistCommands object for a specific playlist. More...
 
void addListenerForMediaList (in sbIMediaList aMediaList, in sbIPlaylistCommandsListener aListener)
 Adds the param listener to the root sbIPlaylistCommands for the param medialist. Every medialist can have two root commands, one for the medialist guid and one for its type, but these root commands are not instantiated until a playlist command is specifically added for that guid or type. This method adds the param listener for both root commands and, if a root command does not exist when this method is called, it guarantees that the param listener will be added immediately when the root command is created and the listener will receive all notifications sent by the root command. More...
 
void removeListenerForMediaList (in sbIMediaList aMediaList, in sbIPlaylistCommandsListener aListener)
 Removes listeners for the param medialist. More...
 
void publish (in AString aCommandGUID, in sbIPlaylistCommands aCommandObj)
 Publish an sbIPlaylistCommands interface for public consumption. More...
 
void withdraw (in AString aCommandGUID, in sbIPlaylistCommands aCommandObj)
 Withdraw a previously published sbIPlaylistCommands interface. More...
 
sbIPlaylistCommands request (in AString aContextGUID)
 Request a copy of a published sbIPlaylistCommands interface. More...
 

Protected Types

typedef std::map< nsString,
nsCOMPtr
< sbIPlaylistCommandsBuilder > > 
commandobjmap_t
 
typedef std::map< nsString,
nsCOMArray
< sbIPlaylistCommands > > 
libraryGuidToCommandsMap_t
 
typedef std::map< nsString,
nsCOMPtr
< LibraryPlaylistCommandsListener > > 
libraryGuidToLibraryListenerMap_t
 

Protected Member Functions

NS_IMETHODIMP RegisterPlaylistCommands (commandobjmap_t *map, const nsAString &aContextGUID, const nsAString &aPlaylistType, sbIPlaylistCommands *aCommandObj)
 
NS_IMETHODIMP UnregisterPlaylistCommands (commandobjmap_t *map, const nsAString &aContextGUID, const nsAString &aPlaylistType, sbIPlaylistCommands *aCommandObj)
 

Protected Attributes

commandobjmap_t m_ServicePaneCommandObjMap
 
commandobjmap_t m_PlaylistCommandObjMap
 
std::map< nsString, nsCOMPtr
< sbIPlaylistCommands > > 
m_publishedCommands
 
libraryGuidToCommandsMap_t m_LibraryGuidToServicePaneCommandsMap
 
libraryGuidToCommandsMap_t m_LibraryGuidToMenuOrToolbarCommandsMap
 
libraryGuidToLibraryListenerMap_t m_LibraryGuidToLibraryListenerMap
 

Friends

class LibraryPlaylistCommandsListener
 

Detailed Description

Definition at line 63 of file PlaylistCommandsManager.h.

Member Typedef Documentation

typedef std::map<nsString, nsCOMPtr<sbIPlaylistCommandsBuilder> > CPlaylistCommandsManager::commandobjmap_t
protected

Definition at line 77 of file PlaylistCommandsManager.h.

typedef std::map<nsString, nsCOMArray<sbIPlaylistCommands> > CPlaylistCommandsManager::libraryGuidToCommandsMap_t
protected

Definition at line 83 of file PlaylistCommandsManager.h.

Definition at line 88 of file PlaylistCommandsManager.h.

Constructor & Destructor Documentation

CPlaylistCommandsManager::CPlaylistCommandsManager ( )

Definition at line 74 of file PlaylistCommandsManager.cpp.

CPlaylistCommandsManager::~CPlaylistCommandsManager ( )
virtual

Definition at line 79 of file PlaylistCommandsManager.cpp.

Member Function Documentation

NS_IMETHODIMP CPlaylistCommandsManager::RegisterPlaylistCommands ( commandobjmap_t map,
const nsAString &  aContextGUID,
const nsAString &  aPlaylistType,
sbIPlaylistCommands aCommandObj 
)
protected

Definition at line 133 of file PlaylistCommandsManager.cpp.

NS_IMETHODIMP CPlaylistCommandsManager::UnregisterPlaylistCommands ( commandobjmap_t map,
const nsAString &  aContextGUID,
const nsAString &  aPlaylistType,
sbIPlaylistCommands aCommandObj 
)
protected

Definition at line 179 of file PlaylistCommandsManager.cpp.

Friends And Related Function Documentation

friend class LibraryPlaylistCommandsListener
friend

Definition at line 65 of file PlaylistCommandsManager.h.

Member Data Documentation

libraryGuidToLibraryListenerMap_t CPlaylistCommandsManager::m_LibraryGuidToLibraryListenerMap
protected

Definition at line 89 of file PlaylistCommandsManager.h.

libraryGuidToCommandsMap_t CPlaylistCommandsManager::m_LibraryGuidToMenuOrToolbarCommandsMap
protected

Definition at line 85 of file PlaylistCommandsManager.h.

libraryGuidToCommandsMap_t CPlaylistCommandsManager::m_LibraryGuidToServicePaneCommandsMap
protected

Definition at line 84 of file PlaylistCommandsManager.h.

commandobjmap_t CPlaylistCommandsManager::m_PlaylistCommandObjMap
protected

Definition at line 79 of file PlaylistCommandsManager.h.

std::map<nsString, nsCOMPtr<sbIPlaylistCommands> > CPlaylistCommandsManager::m_publishedCommands
protected

Definition at line 80 of file PlaylistCommandsManager.h.

commandobjmap_t CPlaylistCommandsManager::m_ServicePaneCommandObjMap
protected

Definition at line 78 of file PlaylistCommandsManager.h.


The documentation for this class was generated from the following files: