sbIPlaylistWidget.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 sbIMediaListView;
interface sbIPlaylistCommands;
interface sbIPropertyInfo;
interface sbIPlaylistClickEvent;

/*
 Class PlaylistWidget
 */
[scriptable, uuid(7660f28b-6b55-40b8-8660-353aad8df5a3)]
interface sbIPlaylistWidget : nsISupports
{
  void rescanCommands();

  sbIMediaListView getListView();

  void bind( in sbIMediaListView mediaListView,
             in sbIPlaylistCommands commands,
             in boolean resize,
             in boolean collapse );

  /*
   Method: getColumnCount()

   Get the total number of columns in the web playlist

   See Also:
    <clearColumns()>
    <insertColumnBefore()>
    <removeColumn()>
  */
  unsigned long getColumnCount();

  /*
   Method: clearColumns()

   Clear all columns from the web playlist
  */
  void clearColumns( );

  /*
   Method: appendColumn()

   Arguments:
     aPropertyID - The ID of the property you want to add as a column
     aWidth - The width in pixels of the column. If there has been a
                  width set for this particular column then that width
                  will be respected and this ignored.

   Add a column to the right side of visible columns
  */
  void appendColumn( in AString aPropertyID,
                     [optional] in AString aWidth );

  /*
   Method: insertColumnBefore()

   Insert a column into the web playlist

   Arguments:
     aPropertyID - The ID of the property you want to add as a column
     aBeforePropertyID - If specified, the new column will appear before the
       column that is bound to the specified property.  If not specified, the
       column will be added to the end of the list.
     aWidth - The width in pixels of the column. If there has been a
                  width set for this particular column then that width
                  will be respected and this ignored.
  */
  void insertColumnBefore( in AString aPropertyID,
                           [optional] in AString aBeforePropertyID,
                           [optional] in AString aWidth );

  /*
   Method: removeColumn()

   Remove a column from the playlist

   Arguments:
     aPropertyID - The ID of the property that is bound to the column you wish
       to remove.
  */
  void removeColumn( in AString aPropertyID );

  /*
   Method: getColumnPropertyIDByIndex()

   Get the property ID bould to a particular column at a given index

   Arguments:
     aIndex - The index of the column from which you want to retrieve the bound
       property

   Returns:
     The ID of the property bound to the specified column
  */
  AString getColumnPropertyIDByIndex( in unsigned long aIndex );

  /*
   Method: setSortColumn()

   Set the sort of the web playlist

   Arguments:
     aPropertyID - The ID of the property that is bound to the column you wish
       to sort.
     aIsAscending - True if the sort should be ascending, false if the sort
       should be descending.
  */
  void setSortColumn( in AString aPropertyID,
                      in boolean aIsAscending );

  readonly attribute sbIPlaylistClickEvent lastClickEvent;
};