sbIDisplayPanes.idl

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://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 nsIDOMWindow;
interface nsIDOMXULElement;
interface nsISimpleEnumerator;

[scriptable, uuid(4032b416-9bca-48b0-b95a-cd8a14c48ea0)]
interface sbIDisplayPaneContentInfo : nsISupports
{
  readonly attribute AString contentUrl;
  readonly attribute AString contentTitle;
  readonly attribute AString contentIcon;
  readonly attribute PRInt32 defaultWidth;
  readonly attribute PRInt32 defaultHeight;
  readonly attribute AString suggestedContentGroups; 
};

[scriptable, uuid(316ba9ab-5fda-4bc3-b4de-dbb8211a4785)]
interface sbIDisplayPaneInstantiator : nsISupports
{
  readonly attribute AString contentGroup;
  readonly attribute AString contentUrl;
  readonly attribute AString contentTitle;
  readonly attribute AString contentIcon; 
  readonly attribute nsIDOMWindow contentWindow;

  readonly attribute nsIDOMXULElement displayPane;
  
  void loadContent(in sbIDisplayPaneContentInfo aPane);
  void hide();
  attribute PRBool collapsed;
};

[scriptable, uuid(1028919e-de26-45ed-ac12-5343972498a6)]
interface sbIDisplayPaneListener : nsISupports
{
  void onRegisterContent(in sbIDisplayPaneContentInfo aPane);
  void onUnregisterContent(in sbIDisplayPaneContentInfo aPane);
  void onRegisterInstantiator(in sbIDisplayPaneInstantiator aInstantiator);
  void onUnregisterInstantiator(in sbIDisplayPaneInstantiator aInstantiator);
  void onPaneInfoChanged(in sbIDisplayPaneContentInfo aPane);
};

[scriptable, uuid(2b7dbb26-f429-4dff-b537-29c0e8a1d0a8)]
interface sbIDisplayPaneManager : nsISupports
{
  void registerInstantiator(in sbIDisplayPaneInstantiator aInstantiator);
  void unregisterInstantiator(in sbIDisplayPaneInstantiator aInstantiator);

  void registerContent(in AString aContentUrl,
                       in AString aContentTitle,
                       in AString aContentIcon,
                       in PRInt32 aDefaultWidth,
                       in PRInt32 aDefaultHeight,
                       in AString aSuggestedContentGroups,
                       in PRBool aAutoShow);
  
  void unregisterContent(in AString aContentUrl);

  void updateContentInfo(in AString aContentUrl,
                         in AString aNewContentTitle,
                         in AString aNewContentIcon);

  void showPane(in AString aContentUrl);

  readonly attribute nsISimpleEnumerator contentList;
  readonly attribute nsISimpleEnumerator instantiatorsList;
  
  sbIDisplayPaneContentInfo getPaneInfo(in AString aContentUrl);
  
  sbIDisplayPaneInstantiator getInstantiatorForWindow(in nsIDOMWindow aWindow);
  
  void addListener(in sbIDisplayPaneListener aListener);
  void removeListener(in sbIDisplayPaneListener aListener);

  readonly attribute sbIDisplayPaneContentInfo defaultPaneInfo;
};