sbIFeathersManager.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 nsISimpleEnumerator;
interface sbILayoutDescription;
interface sbISkinDescription;

interface sbIFeathersManagerListener;


[scriptable, uuid(61c28aec-66a6-49f2-85df-9629c7e3d84f)]
interface sbIFeathersManager : nsISupports
{
  readonly attribute AString currentLayoutURL;
  
  readonly attribute AString currentSkinName;

  readonly attribute AString previousLayoutURL;
  
  readonly attribute AString previousSkinName;

  nsISimpleEnumerator getSkinDescriptions();


  readonly attribute unsigned long skinCount;


  nsISimpleEnumerator getLayoutDescriptions();


  readonly attribute unsigned long layoutCount;



  void registerSkin(in sbISkinDescription aSkin);
  
  void unregisterSkin(in sbISkinDescription aSkin);

  sbISkinDescription getSkinDescription(in AString aInternalName);



  void registerLayout(in sbILayoutDescription aLayout);

  void unregisterLayout(in sbILayoutDescription aLayout);

  sbILayoutDescription getLayoutDescription(in AString aLayoutURL);



  void assertCompatibility(in AString aLayoutURL,
                           in AString aInternalName,
                           in boolean aShowChrome,
                           in boolean onTop);
 

  
  void unassertCompatibility(in AString aLayoutURL,
                             in AString aInternalName);
 
  
  
  void setDefaultLayout(in AString aLayoutURL, in AString aInternalName);
  
  
  
  AString getDefaultLayout(in AString aInternalName);
  

  
  boolean isChromeEnabled(in AString aLayoutURL,
                          in AString aInternalName);



  boolean isOnTop(in AString aLayoutURL,
                  in AString aInternalName);


  void setOnTop(in AString aLayoutURL,
                in AString aInternalName,
                in boolean aOnTop);


  boolean canOnTop(in AString aLayoutURL,
                   in AString aInternalName);



  nsISimpleEnumerator getSkinsForLayout(in AString aLayoutURL);


  nsISimpleEnumerator getLayoutsForSkin(in AString aInternalName);


  void switchFeathers(in AString aLayoutURL, 
                      in AString aInternalName);
                      

  void switchToNextLayout();

  void openPlayerWindow();


  void addListener(in sbIFeathersManagerListener aListener);

  void removeListener(in sbIFeathersManagerListener aListener);
};