Inheritance diagram for sbIPlaylistCommandsBuilder:
Public Member Functions | |
void | appendSubmenu (in AString aParentSubMenuId, in AString aSubMenuId, in AString aLabel, in AString aTooltipText) |
Append a submenu to the set of commands. | |
void | insertSubmenuBefore (in AString aParentSubMenuId, in AString aBeforeId, in AString aSubMenuId, in AString aLabel, in AString aTooltipText) |
Insert a submenu into the set of commands. | |
void | insertSubmenuAfter (in AString aParentSubMenuId, in AString aAfterId, in AString aSubMenuId, in AString aLabel, in AString aTooltipText) |
Insert a submenu into the set of commands. | |
void | appendAction (in AString aParentSubMenuId, in AString aActionId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback) |
Append an action to the set of commands. | |
void | insertActionBefore (in AString aParentSubMenuId, in AString aBeforeId, in AString aActionId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback) |
Insert an action into the set of commands. | |
void | insertActionAfter (in AString aParentSubMenuId, in AString aAfterId, in AString aActionId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback) |
Insert an action into the set of commands. | |
void | appendSeparator (in AString aParentSubMenuId, in AString aSeparatorId) |
Append a separator to the set of commands. | |
void | insertSeparatorBefore (in AString aParentSubMenuId, in AString aBeforeId, in AString aSeparatorId) |
Insert a separator into the set of commands. | |
void | insertSeparatorAfter (in AString aParentSubMenuId, in AString aAfterId, in AString aSeparatorId) |
Insert a separator into the set of commands. | |
void | appendFlag (in AString aParentSubMenuId, in AString aFlagId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback, in sbIPlaylistCommandsBuilderGetBoolCallback aValueCallback) |
Append a flag to the set of commands. | |
void | insertFlagBefore (in AString aParentSubMenuId, in AString aBeforeId, in AString aCommandId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback, in sbIPlaylistCommandsBuilderGetBoolCallback aGetValueCallback) |
Insert a flag into the set of commands. | |
void | insertFlagAfter (in AString aParentSubMenuId, in AString aAfterId, in AString aCommandId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback, in sbIPlaylistCommandsBuilderGetBoolCallback aGetValueCallback) |
Insert a flag into the set of commands. | |
void | appendValue (in AString aParentSubMenuId, in AString aValueId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSetValueCallback aSetValueCallback, in sbIPlaylistCommandsBuilderGetStringCallback aGetValueCallback) |
Append a value to the set of commands. | |
void | insertValueBefore (in AString aParentSubMenuId, in AString aBeforeId, in AString aValueId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSetValueCallback aSetValueCallback, in sbIPlaylistCommandsBuilderGetStringCallback aGetValueCallback) |
Insert a value into the set of commands. | |
void | insertValueAfter (in AString aParentSubMenuId, in AString aAfterId, in AString aValueId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSetValueCallback aSetValueCallback, in sbIPlaylistCommandsBuilderGetStringCallback aGetValueCallback) |
Insert a value into the set of commands. | |
void | appendChoiceMenu (in AString aParentSubMenuId, in AString aChoiceMenuId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderGetStringCallback aItemCallback) |
Append a choicemenu to the set of commands. | |
void | insertChoiceMenuBefore (in AString aParentSubMenuId, in AString aBeforeId, in AString aChoiceMenuId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderGetStringCallback aItemCallback) |
Insert a choicemenu into the set of commands. | |
void | insertChoiceMenuAfter (in AString aParentSubMenuId, in AString aAfterId, in AString aChoiceMenuId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderGetStringCallback aItemCallback) |
Insert a choicemenu into the set of commands. | |
void | appendChoiceMenuItem (in AString aParentSubMenuId, in AString aChoiceMenuItemId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback) |
Append a choicemenuitem to the set of commands. | |
void | insertChoiceMenuItemBefore (in AString aParentSubMenuId, in AString aBeforeId, in AString aCommandId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback) |
Insert a choicemenuitem into the set of commands. | |
void | insertChoiceMenuItemAfter (in AString aParentSubMenuId, in AString aAfterId, in AString aCommandId, in AString aLabel, in AString aTooltipText, in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback) |
Insert a choicemenuitem into the set of commands. | |
void | appendCustomItem (in AString aParentSubMenuId, in AString aCustomItemId, in sbIPlaylistCommandsBuilderInstantiationCallback aInstantiationCallback, in sbIPlaylistCommandsBuilderRefreshCallback aRefreshCallback) |
Append a customitem to the set of commands. | |
void | insertCustomItemBefore (in AString aParentSubMenuId, in AString aBeforeId, in AString aCustomItemId, in sbIPlaylistCommandsBuilderInstantiationCallback aInstantiationCallback, in sbIPlaylistCommandsBuilderRefreshCallback aRefreshCallback) |
Insert a customitem into the set of commands. | |
void | insertCustomItemAfter (in AString aParentSubMenuId, in AString aAfterId, in AString aCustomItemId, in sbIPlaylistCommandsBuilderInstantiationCallback aInstantiationCallback, in sbIPlaylistCommandsBuilderRefreshCallback aRefreshCallback) |
Insert a customitem into the set of commands. | |
void | appendPlaylistCommands (in AString aParentSubMenuId, in AString aCommandsId, in sbIPlaylistCommands aPlaylistCommands) |
Append an existing set of commands to this set of commands. | |
void | insertPlaylistCommandsBefore (in AString aParentSubMenuId, in AString aBeforeId, in AString aCommandsId, in sbIPlaylistCommands aPlaylistCommands) |
Insert an existing set of commands into this set of commands. | |
void | insertPlaylistCommandsAfter (in AString aParentSubMenuId, in AString aAfterId, in AString aCommandsId, in sbIPlaylistCommands aPlaylistCommands) |
Insert an existing set of commands into this set of commands. | |
void | setCommandShortcut (in AString aParentSubMenuId, in AString aCommandId, in AString aShortcutKey, in AString aShortcutKeyCode, in AString aShortcutModifiers, in PRBool aShortcutIsLocal) |
Assign a keyboard shortcut to a command item. | |
void | setCommandEnabledCallback (in AString aParentSubMenuId, in AString aCommandId, in sbIPlaylistCommandsBuilderGetBoolCallback aEnabledCallback) |
Assign a callback to a command item to dynamically determine its enabled status. | |
void | setCommandVisibleCallback (in AString aParentSubMenuId, in AString aCommandId, in sbIPlaylistCommandsBuilderGetBoolCallback aVisibleCallback) |
Assign a callback to a command item to dynamically determine its visible status. | |
void | setInitCallback (in sbIPlaylistCommandsBuilderPCCallback aInitCallback) |
Assign a callback to the entire command set to perform initialization. | |
void | setShutdownCallback (in sbIPlaylistCommandsBuilderPCCallback aInitCallback) |
Assign a callback to the entire command set to perform shutdown. | |
void | setVisibleCallback (in sbIPlaylistCommandsBuilderPCCallback aVisibleCallback) |
Assign a callback to the entire command set to dynamically determine its visible status (affects all commands). | |
void | removeCommand (in AString aParentSubMenuId, in AString aCommandId) |
Remove a command from the set. | |
void | removeAllCommands ([optional] in AString aParentSubMenuId) |
Remove all commands from the set. | |
void | shutdown () |
Shutdown the builder object, ensure that no external reference remains in its internal arrays. |
This interface is meant to be instantiated by user code, ie:
const PlaylistCommandsBuilder = new Components. Constructor("@songbirdnest.com/Songbird/PlaylistCommandsBuilder;1", "sbIPlaylistCommandsBuilder"); var builder = new PlaylistCommandsBuilder();
The instance may then be used to create a set of commands, which it exposes to playlist objects, and to service pane nodes. Each of its command may be of several different kinds :
Commands registered to the PlaylistCommandsManager using the registerPlaylistCommandsMedia[List|Item]() functions should be unregistered using the corresponding unregisterPlaylistCommandsMedia[List|Item]() function before application shutdown. Commands published using the publish() function should be withdrawn using the withdraw() function before application shutdown.
All instantiated sbIPlaylistCommandsBuilder should have their shutdown() method called before application shutdown to ensure that no external reference remains in their internal arrays.
Note that text parameters (labels, tooltiptexts) as well as keyboard shortcut strings (key, keycode, modifiers) may take values such as "&value", which will cause the appropriate localized string to be fetched from the active locale.
Definition at line 115 of file sbIPlaylistCommandsBuilder.idl.
void sbIPlaylistCommandsBuilder::appendSubmenu | ( | in AString | aParentSubMenuId, | |
in AString | aSubMenuId, | |||
in AString | aLabel, | |||
in AString | aTooltipText | |||
) |
Append a submenu to the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aSubMenuId | The Id of the submenu to add | |
aLabel | The label for the submenu to add | |
aTooltipText | The tooltip text for the submenu to add |
void sbIPlaylistCommandsBuilder::insertSubmenuBefore | ( | in AString | aParentSubMenuId, | |
in AString | aBeforeId, | |||
in AString | aSubMenuId, | |||
in AString | aLabel, | |||
in AString | aTooltipText | |||
) |
Insert a submenu into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aBeforeId | The Id of the command before which this submenu is to be added | |
aSubMenuId | The Id of the submenu to add | |
aLabel | The label for the submenu to add | |
aTooltipText | The tooltip text for the submenu to add |
void sbIPlaylistCommandsBuilder::insertSubmenuAfter | ( | in AString | aParentSubMenuId, | |
in AString | aAfterId, | |||
in AString | aSubMenuId, | |||
in AString | aLabel, | |||
in AString | aTooltipText | |||
) |
Insert a submenu into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aAfterId | The Id of the command after which this submenu is to be added | |
aSubMenuId | The Id of the submenu to add | |
aLabel | The label for the submenu to add | |
aTooltipText | The tooltip text for the submenu to add |
void sbIPlaylistCommandsBuilder::appendAction | ( | in AString | aParentSubMenuId, | |
in AString | aActionId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSimpleCallback | aTriggerCallback | |||
) |
Append an action to the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aActionId | The Id of the action to add | |
aLabel | The label for the action to add | |
aTooltipText | The tooltip text for the action to add | |
aTriggerCallback | The interface or function to call when this action is triggered |
void sbIPlaylistCommandsBuilder::insertActionBefore | ( | in AString | aParentSubMenuId, | |
in AString | aBeforeId, | |||
in AString | aActionId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSimpleCallback | aTriggerCallback | |||
) |
Insert an action into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aBeforeId | The Id of the command before which this action is to be added | |
aActionId | The Id of the action to add | |
aLabel | The label for the action to add | |
aTooltipText | The tooltip text for the action to add | |
aTriggerCallback | The interface or function to call when this action is triggered |
void sbIPlaylistCommandsBuilder::insertActionAfter | ( | in AString | aParentSubMenuId, | |
in AString | aAfterId, | |||
in AString | aActionId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSimpleCallback | aTriggerCallback | |||
) |
Insert an action into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aAfterId | The Id of the command after which this action is to be added | |
aActionId | The Id of the action to add | |
aLabel | The label for the action to add | |
aTooltipText | The tooltip text for the action to add | |
aTriggerCallback | The interface or function to call when this action is triggered |
void sbIPlaylistCommandsBuilder::appendSeparator | ( | in AString | aParentSubMenuId, | |
in AString | aSeparatorId | |||
) |
Append a separator to the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aSeparatorId | The Id of the separator to add |
void sbIPlaylistCommandsBuilder::insertSeparatorBefore | ( | in AString | aParentSubMenuId, | |
in AString | aBeforeId, | |||
in AString | aSeparatorId | |||
) |
Insert a separator into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aBeforeId | The Id of the command before which this separator is to be added | |
aSeparatorId | The Id of the separator to add |
void sbIPlaylistCommandsBuilder::insertSeparatorAfter | ( | in AString | aParentSubMenuId, | |
in AString | aAfterId, | |||
in AString | aSeparatorId | |||
) |
Insert a separator into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aAfterId | The Id of the command after which this separator is to be added | |
aSeparatorId | The Id of the separator to add |
void sbIPlaylistCommandsBuilder::appendFlag | ( | in AString | aParentSubMenuId, | |
in AString | aFlagId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSimpleCallback | aTriggerCallback, | |||
in sbIPlaylistCommandsBuilderGetBoolCallback | aValueCallback | |||
) |
Append a flag to the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aFlagId | The Id of the flag to add | |
aLabel | The label for the flag to add | |
aTooltipText | The tooltip text for the flag to add | |
aTriggerCallback | The interface or function to call when this flag is flipped | |
aValueCallback | The interface or function to call to retrieve the flag's value |
void sbIPlaylistCommandsBuilder::insertFlagBefore | ( | in AString | aParentSubMenuId, | |
in AString | aBeforeId, | |||
in AString | aCommandId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSimpleCallback | aTriggerCallback, | |||
in sbIPlaylistCommandsBuilderGetBoolCallback | aGetValueCallback | |||
) |
Insert a flag into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aBeforeId | The Id of the command before which this flag is to be added | |
aFlagId | The Id of the flag to add | |
aLabel | The label for the flag to add | |
aTooltipText | The tooltip text for the flag to add | |
aTriggerCallback | The interface or function to call when this flag is flipped | |
aValueCallback | The interface or function to call to retrieve the flag's value |
void sbIPlaylistCommandsBuilder::insertFlagAfter | ( | in AString | aParentSubMenuId, | |
in AString | aAfterId, | |||
in AString | aCommandId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSimpleCallback | aTriggerCallback, | |||
in sbIPlaylistCommandsBuilderGetBoolCallback | aGetValueCallback | |||
) |
Insert a flag into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aAfterId | The Id of the command after which this flag is to be added | |
aFlagId | The Id of the flag to add | |
aLabel | The label for the flag to add | |
aTooltipText | The tooltip text for the flag to add | |
aTriggerCallback | The interface or function to call when this flag is flipped | |
aValueCallback | The interface or function to call to retrieve the flag's value |
void sbIPlaylistCommandsBuilder::appendValue | ( | in AString | aParentSubMenuId, | |
in AString | aValueId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSetValueCallback | aSetValueCallback, | |||
in sbIPlaylistCommandsBuilderGetStringCallback | aGetValueCallback | |||
) |
Append a value to the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aValueId | The Id of the value to add | |
aLabel | The label for the value to add | |
aTooltipText | The tooltip text for the value to add | |
aSetValueCallback | The interface or function to call when this value is changed | |
aValueCallback | The interface or function to call to retrieve the value |
void sbIPlaylistCommandsBuilder::insertValueBefore | ( | in AString | aParentSubMenuId, | |
in AString | aBeforeId, | |||
in AString | aValueId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSetValueCallback | aSetValueCallback, | |||
in sbIPlaylistCommandsBuilderGetStringCallback | aGetValueCallback | |||
) |
Insert a value into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aBeforeId | The Id of the command before which this value is to be added | |
aValueId | The Id of the value to add | |
aLabel | The label for the value to add | |
aTooltipText | The tooltip text for the value to add | |
aSetValueCallback | The interface or function to call when this value is changed | |
aValueCallback | The interface or function to call to retrieve the value |
void sbIPlaylistCommandsBuilder::insertValueAfter | ( | in AString | aParentSubMenuId, | |
in AString | aAfterId, | |||
in AString | aValueId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSetValueCallback | aSetValueCallback, | |||
in sbIPlaylistCommandsBuilderGetStringCallback | aGetValueCallback | |||
) |
Insert a value into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aAfterId | The Id of the command after which this value is to be added | |
aValueId | The Id of the value to add | |
aLabel | The label for the value to add | |
aTooltipText | The tooltip text for the value to add | |
aSetValueCallback | The interface or function to call when this value is changed | |
aValueCallback | The interface or function to call to retrieve the value |
void sbIPlaylistCommandsBuilder::appendChoiceMenu | ( | in AString | aParentSubMenuId, | |
in AString | aChoiceMenuId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderGetStringCallback | aItemCallback | |||
) |
Append a choicemenu to the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aChoiceMenuId | The Id of the choicemenu to add | |
aLabel | The label for the choicemenu to add | |
aTooltipText | The tooltip text for the choicemenu to add | |
aItemCallback | The interface or function to call to retrieve the id of the currently selected choice item |
void sbIPlaylistCommandsBuilder::insertChoiceMenuBefore | ( | in AString | aParentSubMenuId, | |
in AString | aBeforeId, | |||
in AString | aChoiceMenuId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderGetStringCallback | aItemCallback | |||
) |
Insert a choicemenu into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aBeforeId | The Id of the command before which this choicemenu is to be added | |
aChoiceMenuId | The Id of the choicemenu to add | |
aLabel | The label for the choicemenu to add | |
aTooltipText | The tooltip text for the choicemenu to add | |
aItemCallback | The interface or function to call to retrieve the id of the currently selected choice item |
void sbIPlaylistCommandsBuilder::insertChoiceMenuAfter | ( | in AString | aParentSubMenuId, | |
in AString | aAfterId, | |||
in AString | aChoiceMenuId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderGetStringCallback | aItemCallback | |||
) |
Insert a choicemenu into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aAfterId | The Id of the command after which this choicemenu is to be added | |
aChoiceMenuId | The Id of the choicemenu to add | |
aLabel | The label for the choicemenu to add | |
aTooltipText | The tooltip text for the choicemenu to add | |
aItemCallback | The interface or function to call to retrieve the id of the currently selected choice item |
void sbIPlaylistCommandsBuilder::appendChoiceMenuItem | ( | in AString | aParentSubMenuId, | |
in AString | aChoiceMenuItemId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSimpleCallback | aTriggerCallback | |||
) |
Append a choicemenuitem to the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aChoiceMenuItemId | The Id of the choicemenuitem to add | |
aLabel | The label for the choicemenuitem to add | |
aTooltipText | The tooltip text for the choicemenuitem to add | |
aTriggerCallback | The interface or function to call when this choicemenuitem is selected |
void sbIPlaylistCommandsBuilder::insertChoiceMenuItemBefore | ( | in AString | aParentSubMenuId, | |
in AString | aBeforeId, | |||
in AString | aCommandId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSimpleCallback | aTriggerCallback | |||
) |
Insert a choicemenuitem into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aBeforeId | The Id of the command before which this choicemenuitem is to be added | |
aChoiceMenuItemId | The Id of the choicemenuitem to add | |
aLabel | The label for the choicemenuitem to add | |
aTooltipText | The tooltip text for the choicemenuitem to add | |
aTriggerCallback | The interface or function to call when this choicemenuitem is selected |
void sbIPlaylistCommandsBuilder::insertChoiceMenuItemAfter | ( | in AString | aParentSubMenuId, | |
in AString | aAfterId, | |||
in AString | aCommandId, | |||
in AString | aLabel, | |||
in AString | aTooltipText, | |||
in sbIPlaylistCommandsBuilderSimpleCallback | aTriggerCallback | |||
) |
Insert a choicemenuitem into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aAfterId | The Id of the command after which this choicemenuitem is to be added | |
aChoiceMenuItemId | The Id of the choicemenuitem to add | |
aLabel | The label for the choicemenuitem to add | |
aTooltipText | The tooltip text for the choicemenuitem to add | |
aTriggerCallback | The interface or function to call when this choicemenuitem is selected |
void sbIPlaylistCommandsBuilder::appendCustomItem | ( | in AString | aParentSubMenuId, | |
in AString | aCustomItemId, | |||
in sbIPlaylistCommandsBuilderInstantiationCallback | aInstantiationCallback, | |||
in sbIPlaylistCommandsBuilderRefreshCallback | aRefreshCallback | |||
) |
Append a customitem to the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aCustomItemId | The Id of the customitem to add | |
aInstantiationCallback | The interface or function to call in order to instantiate this customitem | |
aRefreshCallback | The interface or function to call when this customitem should be refreshed |
void sbIPlaylistCommandsBuilder::insertCustomItemBefore | ( | in AString | aParentSubMenuId, | |
in AString | aBeforeId, | |||
in AString | aCustomItemId, | |||
in sbIPlaylistCommandsBuilderInstantiationCallback | aInstantiationCallback, | |||
in sbIPlaylistCommandsBuilderRefreshCallback | aRefreshCallback | |||
) |
Insert a customitem into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aBeforeId | The Id of the command before which this customitem is to be added | |
aCustomItemId | The Id of the customitem to add | |
aInstantiationCallback | The interface or function to call in order to instantiate this customitem | |
aRefreshCallback | The interface or function to call when this customitem should be refreshed |
void sbIPlaylistCommandsBuilder::insertCustomItemAfter | ( | in AString | aParentSubMenuId, | |
in AString | aAfterId, | |||
in AString | aCustomItemId, | |||
in sbIPlaylistCommandsBuilderInstantiationCallback | aInstantiationCallback, | |||
in sbIPlaylistCommandsBuilderRefreshCallback | aRefreshCallback | |||
) |
Insert a customitem into the set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aAfterId | The Id of the command after which this customitem is to be added | |
aCustomItemId | The Id of the customitem to add | |
aInstantiationCallback | The interface or function to call in order to instantiate this customitem | |
aRefreshCallback | The interface or function to call when this customitem should be refreshed |
void sbIPlaylistCommandsBuilder::appendPlaylistCommands | ( | in AString | aParentSubMenuId, | |
in AString | aCommandsId, | |||
in sbIPlaylistCommands | aPlaylistCommands | |||
) |
Append an existing set of commands to this set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aCommandsId | The Id of the playlistcommands item to add | |
aPlaylistCommands | The sbIPlaylistCommands interface to add |
void sbIPlaylistCommandsBuilder::insertPlaylistCommandsBefore | ( | in AString | aParentSubMenuId, | |
in AString | aBeforeId, | |||
in AString | aCommandsId, | |||
in sbIPlaylistCommands | aPlaylistCommands | |||
) |
Insert an existing set of commands into this set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aBeforeId | The Id of the command before which this playlistcommands item is to be added | |
aCommandsId | The Id of the playlistcommands item to add | |
aPlaylistCommands | The sbIPlaylistCommands interface to add |
void sbIPlaylistCommandsBuilder::insertPlaylistCommandsAfter | ( | in AString | aParentSubMenuId, | |
in AString | aAfterId, | |||
in AString | aCommandsId, | |||
in sbIPlaylistCommands | aPlaylistCommands | |||
) |
Insert an existing set of commands into this set of commands.
aParentSubMenuId | The Id of the parent submenu | |
aAfterId | The Id of the command after which this playlistcommands item is to be added | |
aCommandsId | The Id of the playlistcommands item to add | |
aPlaylistCommands | The sbIPlaylistCommands interface to add |
void sbIPlaylistCommandsBuilder::setCommandShortcut | ( | in AString | aParentSubMenuId, | |
in AString | aCommandId, | |||
in AString | aShortcutKey, | |||
in AString | aShortcutKeyCode, | |||
in AString | aShortcutModifiers, | |||
in PRBool | aShortcutIsLocal | |||
) |
Assign a keyboard shortcut to a command item.
aParentSubMenuId | The Id of the parent submenu | |
aCommandId | The Id of the command item for which to set a keyboard shortcut | |
aShortcutKey | The keyboard shortcut key | |
aShortcutKeyCode | The keyboard shortcut keycode | |
aShortcutModifiers | The keyboard shortcut modifiers | |
aShortcutIsLocal | Whether this keyboard shortcut acts at the level of the command object only, rather than at the level of the entire window |
void sbIPlaylistCommandsBuilder::setCommandEnabledCallback | ( | in AString | aParentSubMenuId, | |
in AString | aCommandId, | |||
in sbIPlaylistCommandsBuilderGetBoolCallback | aEnabledCallback | |||
) |
Assign a callback to a command item to dynamically determine its enabled status.
aParentSubMenuId | The Id of the parent submenu | |
aCommandId | The Id of the command item for which to set the callback | |
aEnabledCallback | An interface or function to call to determine the command item's enabled status |
void sbIPlaylistCommandsBuilder::setCommandVisibleCallback | ( | in AString | aParentSubMenuId, | |
in AString | aCommandId, | |||
in sbIPlaylistCommandsBuilderGetBoolCallback | aVisibleCallback | |||
) |
Assign a callback to a command item to dynamically determine its visible status.
aParentSubMenuId | The Id of the parent submenu | |
aCommandId | The Id of the command item for which to set the callback | |
aVisibleCallback | An interface or function to call to determine the command item's visible status |
void sbIPlaylistCommandsBuilder::setInitCallback | ( | in sbIPlaylistCommandsBuilderPCCallback | aInitCallback | ) |
Assign a callback to the entire command set to perform initialization.
aInitCallback | An interface or function to call to perform initialization |
void sbIPlaylistCommandsBuilder::setShutdownCallback | ( | in sbIPlaylistCommandsBuilderPCCallback | aInitCallback | ) |
Assign a callback to the entire command set to perform shutdown.
aInitCallback | An interface or function to call to perform shutdown |
void sbIPlaylistCommandsBuilder::setVisibleCallback | ( | in sbIPlaylistCommandsBuilderPCCallback | aVisibleCallback | ) |
Assign a callback to the entire command set to dynamically determine its visible status (affects all commands).
aVisibleCallback | An interface or function to call to determine the command set's visible status |
void sbIPlaylistCommandsBuilder::removeCommand | ( | in AString | aParentSubMenuId, | |
in AString | aCommandId | |||
) |
Remove a command from the set.
aParentSubMenuId | The Id of the parent submenu | |
aCommandId | The Id of the command item to remove |
void sbIPlaylistCommandsBuilder::removeAllCommands | ( | [optional] in AString | aParentSubMenuId | ) |
Remove all commands from the set.
aParentSubMenuId | An optional menu id whose commands (and submenus) should be removed. Without this parameter, all commands and submenus are removed. |
void sbIPlaylistCommandsBuilder::shutdown | ( | ) |
Shutdown the builder object, ensure that no external reference remains in its internal arrays.