sbIMediaListView.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 nsIMutableArray;
interface nsIStringEnumerator;
interface nsITreeView;
interface sbICascadeFilterSet;
interface sbIMediaItem;
interface sbIMediaList;
interface sbIMediaListView;
interface sbIMutablePropertyArray;
interface sbIMediaListViewSelection;

[scriptable, uuid(bb26d18e-8387-4512-9d99-8ce9b18f929b)]
interface sbIMediaListViewState : nsISupports
{
  AString toString();
};

[scriptable, uuid(378fc540-9592-43df-908c-ed84ac0e1221)]
interface sbIMediaListViewListener : nsISupports
{
  void onFilterChanged(in sbIMediaListView aChangedView);

  void onSearchChanged(in sbIMediaListView aChangedView);

  void onSortChanged(in sbIMediaListView aChangedView);
};

[scriptable, uuid(53cefc7c-0967-4cab-84bd-11b52b1bf081)]
interface sbIMediaListView : nsISupports
{
  readonly attribute sbIMediaList mediaList;

  readonly attribute unsigned long length;

  readonly attribute nsITreeView treeView;

  readonly attribute sbICascadeFilterSet cascadeFilterSet;

  sbIMediaItem getItemByIndex(in unsigned long aIndex);

  unsigned long getIndexForItem(in sbIMediaItem aMediaItem);

  unsigned long getUnfilteredIndex(in unsigned long aIndex);

  AString getViewItemUIDForIndex(in unsigned long aIndex);

  unsigned long getIndexForViewItemUID(in AString aViewItemUID);

  /*
   * \brief Return the distinct values in the view for a given property
   * \param aPropertyID Propery ID to get distinct values for
   * \return String enumerator of distinct values for the given property
   */
  nsIStringEnumerator getDistinctValuesForProperty(in AString aPropertyID);

  sbIMediaListView clone();

  sbIMediaListViewState getState();

  void addListener(in sbIMediaListViewListener aListener,
                   [optional] in boolean aOwnsWeak);

  void removeListener(in sbIMediaListViewListener aListener);

  readonly attribute sbIMediaListViewSelection selection;

  void removeSelectedMediaItems();
};