sbIMediaPageManager.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 sbILibraryConstraint;
interface sbIMediaList; 
interface sbIMediaPageInfo;
interface sbIMediaListMatch;
interface nsISimpleEnumerator;

[scriptable, uuid(ec133090-2fde-11df-9aae-0800200c9a66)]
interface sbIMediaPageManager : nsISupports
{
  sbIMediaPageInfo registerPage(in AString aName, in AString aURL, in AString aIcon, in sbIMediaListMatch aMatch);

  void unregisterPage(in sbIMediaPageInfo aPageInfo);

  nsISimpleEnumerator getAvailablePages([optional] in sbIMediaList aList,
                                        [optional] in sbILibraryConstraint aConstraint);

  sbIMediaPageInfo getPage(in sbIMediaList aList,
                           [optional] in sbILibraryConstraint aConstraint,
                           [optional] in AString aType);

  void setPage(in sbIMediaList aList, in sbIMediaPageInfo aPageInfo,
               [optional] in AString aType);
};


[scriptable, uuid(4817835e-1dd2-11b2-ab1e-81bb1e02f99b)]
interface sbIMediaPageInfo: nsISupports
{
  readonly attribute AString contentTitle;

  readonly attribute AString contentUrl;

  readonly attribute AString contentIcon;

  readonly attribute sbIMediaListMatch matchInterface;
};


[scriptable, function, uuid(802efbaa-1dd2-11b2-96d5-b6792a2b14bf)]
interface sbIMediaListMatch: nsISupports
{
  PRBool match(in sbIMediaList aList,
               [optional] in sbILibraryConstraint aConstraint);
};