sbISortableMediaListView Interface Reference

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

import"sbISortableMediaListView.idl";

Inheritance diagram for sbISortableMediaListView:

Collaboration diagram for sbISortableMediaListView:

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

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

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::clearSort

(

)

Clear the sort.

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.

Member Data Documentation

readonly attribute sbIPropertyArray sbISortableMediaListView::currentSort

The current sort.

Definition at line 57 of file sbISortableMediaListView.idl.

readonly attribute nsIStringEnumerator sbISortableMediaListView::sortableProperties

A list of properties that support sorting.

Definition at line 52 of file sbISortableMediaListView.idl.

---

The documentation for this interface was generated from the following file:

• /home/martin/dev/nightingale-hacking/components/library/base/public/sbISortableMediaListView.idl