sbIPlaylistCommandsHelper.idl
Go to the documentation of this file.
1 /*
2  *=BEGIN SONGBIRD GPL
3  *
4  * This file is part of the Songbird web player.
5  *
6  * Copyright(c) 2005-2010 POTI, Inc.
7  * http://www.songbirdnest.com
8  *
9  * This file may be licensed under the terms of of the
10  * GNU General Public License Version 2 (the ``GPL'').
11  *
12  * Software distributed under the License is distributed
13  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
14  * express or implied. See the GPL for the specific language
15  * governing rights and limitations.
16  *
17  * You should have received a copy of the GPL along with this
18  * program. If not, go to http://www.gnu.org/licenses/gpl.html
19  * or write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  *=END SONGBIRD GPL
23  */
24 
25 #include "nsISupports.idl"
26 
27 interface nsISimpleEnumerator;
28 interface sbIPlaylistCommands;
31 
40 [scriptable, uuid(8f94e630-1dd2-11b2-848d-eac62dd0dbd4)]
42 {
43 
47  const unsigned short TARGET_SERVICEPANE_MENU = 1 << 0;
48 
52  const unsigned short TARGET_MEDIAITEM_CONTEXT_MENU = 1 << 1;
53 
56  const unsigned short TARGET_TOOLBAR = 1 << 2;
57 
61  const unsigned short TARGET_ALL =
65 
83  (in AString aCommandId,
84  in AString aLabel,
85  in AString aTooltipText,
87 
129  void addCommandObjectForType(in unsigned short aTargetFlags,
130  in AString aMediaListType,
131  in sbIPlaylistCommands aCommandObject);
132 
171  void addCommandObjectForGUID(in unsigned short aTargetFlags,
172  in AString aMediaListGUID,
173  in sbIPlaylistCommands aCommandObject);
174 
201  void removeCommandObjectForType(in unsigned short aTargetFlags,
202  in AString aMediaListType,
203  in sbIPlaylistCommands aCommandObject);
204 
230  void removeCommandObjectForGUID(in unsigned short aTargetFlags,
231  in AString aMediaListGUID,
232  in sbIPlaylistCommands aCommandObject);
233 
257  (in unsigned short aTargetFlag,
258  in AString aMediaListType,
259  in AString aCommandId);
260 
283  (in unsigned short aTargetFlag,
284  in AString aMediaListGUID,
285  in AString aCommandId);
286 };
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 defaul...
A helper used to construct sbIPlaylistCommands interfaces.
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 th...
void removeCommandObjectForType(in unsigned short aTargetFlags, in AString aMediaListType, in sbIPlaylistCommands aCommandObject)
Remove a command object from medialists of the specified type.
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 r...
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.
var uuid
const unsigned short TARGET_TOOLBAR
A flag referring to the toolbar at the bottom of a medialist view.
const unsigned short TARGET_ALL
A convenience flag referring to all locations that a sbIPlaylistCommands object can appear...
const unsigned short TARGET_MEDIAITEM_CONTEXT_MENU
A flag referring to the context menu that appears from mediaitems displayed in the medialist...
An interface used to receive generic callbacks from an sbIPlaylistCommandsBuilder object...
void removeCommandObjectForGUID(in unsigned short aTargetFlags, in AString aMediaListGUID, in sbIPlaylistCommands aCommandObject)
Remove a command object from the medialist of the specified guid.
function d(s)
A helper service to add and remove playlistCommands.
An interface that represents the set of command buttons and context menu items available on a display...
const unsigned short TARGET_SERVICEPANE_MENU
A flag referring to the context menu that appears from the service pane node.
sbIPlaylistCommands getCommandObjectForType(in unsigned short aTargetFlag, in AString aMediaListType, in AString aCommandId)
Retrieve a specific command object registered for medialists of the param type.