sbICascadeFilterSet.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 nsIStringEnumerator;
interface nsITreeView;
interface nsIArray;
interface sbIMediaList;

[scriptable, uuid(6b0f6a50-07c9-40e1-9392-2714b9bf2fa3)]
interface sbICascadeFilterSetListener : nsISupports
{
  void onChange();

  void onValuesChanged(in unsigned short aIndex);
};

[scriptable, uuid(3ef6dd65-aa7f-4e05-b6db-f355dfeff7f3)]
interface sbICascadeFilterSet : nsISupports
{
  readonly attribute unsigned short length;

  unsigned short appendFilter(in AString aProperty);

  unsigned short appendSearch([array, size_is(aPropertyArrayCount)] in wstring aPropertyArray,
                              in unsigned long aPropertyArrayCount);

  void remove(in unsigned short aIndex);

   void changeFilter(in unsigned short aIndex, in AString aProperty);

  void set(in unsigned short aIndex,
           [array, size_is(aValueArrayCount)] in wstring aValueArray,
           in unsigned long aValueArrayCount);

  nsIArray get(in unsigned short aIndex);

  void clearAll();

  nsIStringEnumerator getValues(in unsigned short aIndex);

  AString getValueAt(in unsigned short aIndex, in unsigned long aValueIndex);

  nsITreeView getTreeView(in unsigned short aIndex);

  unsigned long getValueCount(in unsigned short aIndex,
                              [optional] in boolean aUseCache);
  
  AString getProperty(in unsigned short aIndex);

  boolean isSearch(in unsigned short aIndex);

  void addListener(in sbICascadeFilterSetListener aListener);

  void removeListener(in sbICascadeFilterSetListener aListener);
};