sbIPlaylistCommandsBuilder.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"
#include "sbIPlaylistCommands.idl"

interface nsIDOMNode;
interface nsIDOMDocument;
interface sbIPlaylistCommandsBuilderSimpleCallback;
interface sbIPlaylistCommandsBuilderGetStringCallback;
interface sbIPlaylistCommandsBuilderGetBoolCallback;
interface sbIPlaylistCommandsBuilderSetValueCallback;
interface sbIPlaylistCommandsBuilderInstantiationCallback;
interface sbIPlaylistCommandsBuilderRefreshCallback;
interface sbIPlaylistCommandsBuilderPCCallback;

// ----------------------------------------------------------------------------

[scriptable, uuid(cc8b8082-1dd1-11b2-a707-e1fb775c0d9b)]
interface sbIPlaylistCommandsBuilder : sbIPlaylistCommands
{
  void init(in AString aId);

  void appendSubmenu(in AString aParentSubMenuId,
                     in AString aSubMenuId,
                     in AString aLabel,
                     in AString aTooltipText);

  void insertSubmenuBefore(in AString aParentSubMenuId,
                           in AString aBeforeId,
                           in AString aSubMenuId,
                           in AString aLabel,
                           in AString aTooltipText);

  void insertSubmenuAfter(in AString aParentSubMenuId,
                          in AString aAfterId,
                          in AString aSubMenuId,
                          in AString aLabel,
                          in AString aTooltipText);

  // --------------------------------------------------------------------------

  void appendAction(in AString aParentSubMenuId,
                    in AString aActionId,
                    in AString aLabel,
                    in AString aTooltipText,
                    in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback);

  void insertActionBefore(in AString aParentSubMenuId,
                          in AString aBeforeId,
                          in AString aActionId,
                          in AString aLabel,
                          in AString aTooltipText,
                          in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback);

  void insertActionAfter(in AString aParentSubMenuId,
                         in AString aAfterId,
                         in AString aActionId,
                         in AString aLabel,
                         in AString aTooltipText,
                         in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback);

  // --------------------------------------------------------------------------

  void appendSeparator(in AString aParentSubMenuId,
                       in AString aSeparatorId);

  void insertSeparatorBefore(in AString aParentSubMenuId,
                             in AString aBeforeId,
                             in AString aSeparatorId);

  void insertSeparatorAfter(in AString aParentSubMenuId,
                            in AString aAfterId,
                            in AString aSeparatorId);

  // --------------------------------------------------------------------------

  void appendFlag(in AString aParentSubMenuId,
                  in AString aFlagId,
                  in AString aLabel,
                  in AString aTooltipText,
                  in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback,
                  in sbIPlaylistCommandsBuilderGetBoolCallback aValueCallback);

  void insertFlagBefore(in AString aParentSubMenuId,
                        in AString aBeforeId,
                        in AString aCommandId,
                        in AString aLabel,
                        in AString aTooltipText,
                        in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback,
                        in sbIPlaylistCommandsBuilderGetBoolCallback aGetValueCallback);

  void insertFlagAfter(in AString aParentSubMenuId,
                       in AString aAfterId,
                       in AString aCommandId,
                       in AString aLabel,
                       in AString aTooltipText,
                       in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback,
                       in sbIPlaylistCommandsBuilderGetBoolCallback aGetValueCallback);

  // --------------------------------------------------------------------------

  void appendValue(in AString aParentSubMenuId,
                   in AString aValueId,
                   in AString aLabel,
                   in AString aTooltipText,
                   in sbIPlaylistCommandsBuilderSetValueCallback aSetValueCallback,
                   in sbIPlaylistCommandsBuilderGetStringCallback aGetValueCallback);

  void insertValueBefore(in AString aParentSubMenuId,
                         in AString aBeforeId,
                         in AString aValueId,
                         in AString aLabel,
                         in AString aTooltipText,
                         in sbIPlaylistCommandsBuilderSetValueCallback aSetValueCallback,
                         in sbIPlaylistCommandsBuilderGetStringCallback aGetValueCallback);

  void insertValueAfter(in AString aParentSubMenuId,
                        in AString aAfterId,
                        in AString aValueId,
                        in AString aLabel,
                        in AString aTooltipText,
                        in sbIPlaylistCommandsBuilderSetValueCallback aSetValueCallback,
                        in sbIPlaylistCommandsBuilderGetStringCallback aGetValueCallback);

  // --------------------------------------------------------------------------

  void appendChoiceMenu(in AString aParentSubMenuId,
                        in AString aChoiceMenuId,
                        in AString aLabel,
                        in AString aTooltipText,
                        in sbIPlaylistCommandsBuilderGetStringCallback aItemCallback);

  void insertChoiceMenuBefore(in AString aParentSubMenuId,
                              in AString aBeforeId,
                              in AString aChoiceMenuId,
                              in AString aLabel,
                              in AString aTooltipText,
                              in sbIPlaylistCommandsBuilderGetStringCallback aItemCallback);

  void insertChoiceMenuAfter(in AString aParentSubMenuId,
                             in AString aAfterId,
                             in AString aChoiceMenuId,
                             in AString aLabel,
                             in AString aTooltipText,
                             in sbIPlaylistCommandsBuilderGetStringCallback aItemCallback);

  // --------------------------------------------------------------------------

  void appendChoiceMenuItem(in AString aParentSubMenuId,
                            in AString aChoiceMenuItemId,
                            in AString aLabel,
                            in AString aTooltipText,
                            in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback);

  void insertChoiceMenuItemBefore(in AString aParentSubMenuId,
                                  in AString aBeforeId,
                                  in AString aCommandId,
                                  in AString aLabel,
                                  in AString aTooltipText,
                                  in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback);

  void insertChoiceMenuItemAfter(in AString aParentSubMenuId,
                                 in AString aAfterId,
                                 in AString aCommandId,
                                 in AString aLabel,
                                 in AString aTooltipText,
                                 in sbIPlaylistCommandsBuilderSimpleCallback aTriggerCallback);

  // --------------------------------------------------------------------------

  void appendCustomItem(in AString aParentSubMenuId,
                        in AString aCustomItemId,
                        in sbIPlaylistCommandsBuilderInstantiationCallback aInstantiationCallback,
                        in sbIPlaylistCommandsBuilderRefreshCallback aRefreshCallback);

  void insertCustomItemBefore(in AString aParentSubMenuId,
                              in AString aBeforeId,
                              in AString aCustomItemId,
                              in sbIPlaylistCommandsBuilderInstantiationCallback aInstantiationCallback,
                              in sbIPlaylistCommandsBuilderRefreshCallback aRefreshCallback);

  void insertCustomItemAfter(in AString aParentSubMenuId,
                             in AString aAfterId,
                             in AString aCustomItemId,
                             in sbIPlaylistCommandsBuilderInstantiationCallback aInstantiationCallback,
                             in sbIPlaylistCommandsBuilderRefreshCallback aRefreshCallback);

  // --------------------------------------------------------------------------

  void appendPlaylistCommands(in AString aParentSubMenuId,
                              in AString aCommandsId,
                              in sbIPlaylistCommands aPlaylistCommands);

  void insertPlaylistCommandsBefore(in AString aParentSubMenuId,
                                    in AString aBeforeId,
                                    in AString aCommandsId,
                                    in sbIPlaylistCommands aPlaylistCommands);

  void insertPlaylistCommandsAfter(in AString aParentSubMenuId,
                                   in AString aAfterId,
                                   in AString aCommandsId,
                                   in sbIPlaylistCommands aPlaylistCommands);

  // --------------------------------------------------------------------------

  void setCommandShortcut(in AString aParentSubMenuId,
                          in AString aCommandId,
                          in AString aShortcutKey,
                          in AString aShortcutKeyCode,
                          in AString aShortcutModifiers,
                          in PRBool aShortcutIsLocal);

  void setCommandEnabledCallback(in AString aParentSubMenuId,
                                 in AString aCommandId,
                                 in sbIPlaylistCommandsBuilderGetBoolCallback aEnabledCallback);

  void setCommandVisibleCallback(in AString aParentSubMenuId,
                                 in AString aCommandId,
                                 in sbIPlaylistCommandsBuilderGetBoolCallback aVisibleCallback);

  void setInitCallback(in sbIPlaylistCommandsBuilderPCCallback aInitCallback);

  void setShutdownCallback(in sbIPlaylistCommandsBuilderPCCallback aInitCallback);

  void setVisibleCallback(in sbIPlaylistCommandsBuilderPCCallback aVisibleCallback);

  void removeCommand(in AString aParentSubMenuId,
                     in AString aCommandId);

  void removeAllCommands([optional] in AString aParentSubMenuId);

  void shutdown();
};

// ----------------------------------------------------------------------------

[scriptable, uuid(c68a8813-7df9-41f4-888c-30f8a63cef60)]
interface sbIPlaylistCommandsBuilderContext : sbIPlaylistCommandsContext
{
  attribute nsISupports implementorContext;
};

[scriptable, function, uuid(d93a113b-348a-4050-8c03-3806228f9293)]
interface sbIPlaylistCommandsBuilderSimpleCallback : nsISupports
{
  void handleCallback(in sbIPlaylistCommandsBuilderContext aContext,
                      in AString aSubMenuId,
                      in AString aCommandId,
                      in AString aHost);
};

[scriptable, function, uuid(2474bfcf-bf50-4f27-b76e-b2472a126c08)]
interface sbIPlaylistCommandsBuilderGetStringCallback : nsISupports
{
  AString handleCallback(in sbIPlaylistCommandsBuilderContext aContext,
                         in AString aSubMenuId,
                         in AString aCommandId,
                         in AString aHost,
                         in AString aData);
};

[scriptable, function, uuid(68dde54c-5157-4650-addd-79ad331cf9ee)]
interface sbIPlaylistCommandsBuilderGetBoolCallback : nsISupports
{
  PRBool handleCallback(in sbIPlaylistCommandsBuilderContext aContext,
                        in AString aSubMenuId,
                        in AString aCommandId,
                        in AString aHost,
                        in AString aData);
};

[scriptable, function, uuid(24b5f0d8-424f-43ee-8f97-4efbfad6500f)]
interface sbIPlaylistCommandsBuilderSetValueCallback : nsISupports
{
  void handleCallback(in sbIPlaylistCommandsBuilderContext aContext,
                      in AString aSubMenuId,
                      in AString aCommandId,
                      in AString aHost,
                      in AString aValue);
};

[scriptable, function, uuid(fb4694de-ba89-4097-843b-a00091cc430b)]
interface sbIPlaylistCommandsBuilderInstantiationCallback : nsISupports
{
  nsIDOMNode handleCallback(in sbIPlaylistCommandsBuilderContext aContext,
                               in AString aSubMenuId,
                               in AString aCommandId,
                               in AString aHost,
                               in nsIDOMDocument aParentDocument);
};

[scriptable, function, uuid(d5f091e8-9b14-47f5-bf48-0f64c9d23a0a)]
interface sbIPlaylistCommandsBuilderRefreshCallback : nsISupports
{
  void handleCallback(in sbIPlaylistCommandsBuilderContext aContext,
                               in AString aSubMenuId,
                               in AString aCommandId,
                               in AString aHost,
                               in nsIDOMNode aElement);
};

[scriptable, function, uuid(9f578767-7f92-486d-b0a9-f760ff6e22d0)]
interface sbIPlaylistCommandsBuilderPCCallback : nsISupports
{
  PRBool handleCallback(in sbIPlaylistCommandsBuilderContext aContext,
                        in AString aHost,
                        in AString aData);
};

 // end of playlistcommands group