sbIPlaylistCommandsHelper Interface Reference

A helper service to add and remove playlistCommands. More...

import"sbIPlaylistCommandsHelper.idl";

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

Public Member Functions

sbIPlaylistCommandsBuilder createCommandObjectForAction (in AString aCommandId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aCallback)
 A method to create a command object for a specified action. The command object and action added to that command object will share the param id. More...
 
void addCommandObjectForType (in unsigned short aTargetFlags, in AString aMediaListType, in sbIPlaylistCommands aCommandObject)
 Add a command object to medialists of the specified type. Generally commands added to type are defaults that appear for all medialists of the specified type unless commands are specified to a medialist by its guid. In that case those registered to its guid are displayed and those registered to its type are not. More...
 
void addCommandObjectForGUID (in unsigned short aTargetFlags, in AString aMediaListGUID, in sbIPlaylistCommands aCommandObject)
 Add a command object to the medialist of the specified guid. Generally, if a medialist has commands registered to it by guid, those will be displayed and those registered to the medialist by type are not. More...
 
void removeCommandObjectForType (in unsigned short aTargetFlags, in AString aMediaListType, in sbIPlaylistCommands aCommandObject)
 Remove a command object from medialists of the specified type. More...
 
void removeCommandObjectForGUID (in unsigned short aTargetFlags, in AString aMediaListGUID, in sbIPlaylistCommands aCommandObject)
 Remove a command object from the medialist of the specified guid. More...
 
sbIPlaylistCommands getCommandObjectForType (in unsigned short aTargetFlag, in AString aMediaListType, in AString aCommandId)
 Retrieve a specific command object registered for medialists of the param type. More...
 
sbIPlaylistCommands getCommandObjectForGUID (in unsigned short aTargetFlag, in AString aMediaListGUID, in AString aCommandId)
 Retrieve a specific command object registered for the medialist with the param guid. More...
 

Public Attributes

const unsigned short TARGET_SERVICEPANE_MENU = 1 << 0
 A flag referring to the context menu that appears from the service pane node. More...
 
const unsigned short TARGET_MEDIAITEM_CONTEXT_MENU = 1 << 1
 A flag referring to the context menu that appears from mediaitems displayed in the medialist. More...
 
const unsigned short TARGET_TOOLBAR = 1 << 2
 A flag referring to the toolbar at the bottom of a medialist view. More...
 
const unsigned short TARGET_ALL
 A convenience flag referring to all locations that a sbIPlaylistCommands object can appear. More...
 

Detailed Description

A helper service to add and remove playlistCommands.

Definition at line 41 of file sbIPlaylistCommandsHelper.idl.


The documentation for this interface was generated from the following file: