sbIPlaylistCommands.idl

Go to the documentation of this file.

/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.songbirdnest.com
 *
 * This file may be licensed under the terms of of the
 * GNU General Public License Version 2 (the ``GPL'').
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the GPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the GPL along with this
 * program. If not, go to http://www.gnu.org/licenses/gpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *=END SONGBIRD GPL
 */

#include "nsISupports.idl"

interface nsIDOMDocument;
interface nsIDOMNode;
interface nsIDOMWindow;
interface sbIPlaylistCommandsContext;
interface sbIPlaylistCommandsListener;
interface sbIPlaylistCommandsBuilderPCCallback;
interface sbIMediaItem;
interface sbIMediaList;
interface sbILibrary;
interface nsISimpleEnumerator;

[scriptable, uuid(1f068d94-1dd2-11b2-825d-8f815e64b75d)]
interface sbIPlaylistCommands : nsISupports
{
  readonly attribute AString id;

  attribute PRUint16 targetFlags;

  attribute sbIPlaylistCommands parentCommandObject;

  void addCommandObject( in sbIPlaylistCommands aCommandObjectAction );

  void removeCommandObject( in sbIPlaylistCommands aCommandObject );

  void addListener( in sbIPlaylistCommandsListener aListener );

  void removeListener( in sbIPlaylistCommandsListener aListener );

  void notifyListeners( in AString aTriggerFunction,
                        in sbIPlaylistCommands aCommandObject );

  PRBool getVisible( in AString aHost );

  readonly attribute sbIPlaylistCommandsBuilderPCCallback visibleCallback;

  void setContext( in sbIPlaylistCommandsContext aContext );

  PRInt32 getNumCommands( in AString aSubMenu, in AString aHost );

  AString getCommandType( in AString aSubMenu, in PRInt32 aIndex, in AString aHost );

  AString getCommandId( in AString aSubMenu, in PRInt32 aIndex, in AString aHost );

  AString getCommandText( in AString aSubMenu, in PRInt32 aIndex, in AString aHost );

  PRInt32 getCommandFlex( in AString aSubMenu, in PRInt32 aIndex, in AString aHost );

  AString getCommandToolTipText(in AString aSubMenu, in PRInt32 aIndex, in AString aHost );

  PRBool getCommandEnabled(in AString aSubMenu, in PRInt32 aIndex, in AString aHost );

  PRBool getCommandVisible(in AString aSubMenu, in PRInt32 aIndex, in AString aHost );

  PRBool getCommandFlag( in AString aSubMenu, in PRInt32 aIndex, in AString aHost );

  AString getCommandValue( in AString aSubMenu, in PRInt32 aIndex, in AString aHost );

  AString getCommandChoiceItem( in AString aChoiceMenu, in AString aHost );

  AString getCommandShortcutModifiers( in AString aSubMenu,
                                       in PRInt32 aIndex,
                                       in AString aHost );

  AString getCommandShortcutKey( in AString aSubMenu,
                                 in PRInt32 aIndex,
                                 in AString aHost );

  AString getCommandShortcutKeycode( in AString aSubMenu,
                                     in PRInt32 aIndex,
                                     in AString aHost );

  PRBool getCommandShortcutLocal( in AString aSubMenu,
                                  in PRInt32 aIndex,
                                  in AString aHost );

  sbIPlaylistCommands getCommandSubObject( in AString aSubMenu,
                                           in PRInt32 aIndex,
                                           in AString aHost );

  nsISimpleEnumerator getChildrenCommandObjects();

  nsIDOMNode instantiateCustomCommand( in AString aSubMenu,
                                       in PRInt32 aIndex,
                                       in AString aHost,
                                       in AString aID,
                                       in nsIDOMDocument aDocument );

  void refreshCustomCommand( in AString aSubMenu,
                             in PRInt32 aIndex,
                             in AString aHost,
                             in AString aID,
                             in nsIDOMNode aCustomCommandElement );

  void onCommand( in AString aSubMenu,
                  in PRInt32 aIndex,
                  in AString aHost,
                  in AString aId,
                  in AString aValue );

  sbIPlaylistCommands duplicate( );

  void initCommands( in AString aHost );

  void shutdownCommands( );
};

[scriptable, uuid(f08d76b6-cbe6-4cad-945e-1b1eea10a16c)]
interface sbIPlaylistCommandsContext : nsISupports
{
  readonly attribute nsIDOMNode playlist;

  readonly attribute sbIMediaItem medialist;

  readonly attribute nsIDOMWindow window;

  readonly attribute sbIPlaylistCommands commands;
};

[scriptable, uuid(5ff1f576-1dd2-11b2-ae11-9f40001e5dbb)]
interface sbIPlaylistCommandsListener : nsISupports
{
  void onCommandAdded(in sbIPlaylistCommands aCommandObject);

  void onCommandRemoved(in sbIPlaylistCommands aCommandObject);

  void onCommandChanged(in sbIPlaylistCommands aCommandObject);
};

[scriptable, uuid(385a86c4-1dd2-11b2-a945-f6f41c562fe9)]
interface sbIPlaylistCommandsManager : nsISupports
{
  void registerPlaylistCommandsForLibrary(in PRBool          aTargetServicePane,
                                          in sbiLibrary      aLibrary,
                                          in sbIPlaylistCommands aCommandObj);

  void unregisterPlaylistCommandsForLibrary(in PRBool        aTargetServicePane,
                                            in sbiLibrary      aLibrary,
                                            in sbIPlaylistCommands aCommandObj);
  void registerPlaylistCommandsMediaItem( in AString aContextGUID,
                                          in AString aPlaylistType,
                                          in sbIPlaylistCommands aCommandObj );

  void unregisterPlaylistCommandsMediaItem( in AString aContextGUID,
                                            in AString aPlaylistType,
                                            in sbIPlaylistCommands aCommandObj );

  sbIPlaylistCommands getPlaylistCommandsMediaItem( in AString aContextGUID,
                                                    in AString aPlaylistType );

  void registerPlaylistCommandsMediaList( in AString aContextGUID,
                                          in AString aPlaylistType,
                                          in sbIPlaylistCommands aCommandObj );

  void unregisterPlaylistCommandsMediaList( in AString aContextGUID,
                                            in AString aPlaylistType,
                                            in sbIPlaylistCommands aCommandObj );

  sbIPlaylistCommands getPlaylistCommandsMediaList( in AString aContextGUID,
                                                    in AString aPlaylistType );

  void addListenerForMediaList( in sbIMediaList aMediaList,
                                in sbIPlaylistCommandsListener aListener );

  void removeListenerForMediaList( in sbIMediaList aMediaList,
                                   in sbIPlaylistCommandsListener aListener  );

  void publish( in AString aCommandGUID, in sbIPlaylistCommands aCommandObj );

  void withdraw( in AString aCommandGUID, in sbIPlaylistCommands aCommandObj );

  sbIPlaylistCommands request( in AString aContextGUID );
};
 // end of playlistcommands group