Songbird / Development / Songbird Add-Ons API Documentation

sbISortableMediaListView Interface Reference

Control the sort settings on a media list. More...

import "sbISortableMediaListView.idl";

List of all members.

Public Member Functions

void setSort (in sbIPropertyArray aSort)
 Set a new sort for the media list.
void clearSort ()
 Clear the sort.

Public Attributes

readonly attribute nsIStringEnumerator sortableProperties
 A list of properties that support sorting.
readonly attribute sbIPropertyArray currentSort
 The current sort.


Detailed Description

Control the sort settings on a media list.

Media lists that implement this interface declare themselves as sortable.

See also:
sbIMediaList

Definition at line 47 of file sbISortableMediaListView.idl.


Member Function Documentation

void sbISortableMediaListView::setSort ( in sbIPropertyArray  aSort  ) 

Set a new sort for the media list.

Parameters:
aSort A property bag containing the sort parameters. The keys map to sortable properties and the value for each key is either "a" for ascending or "d" for decending.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:29:02 2009 for Songbird by  doxygen 1.5.2