Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIXULSortService Interface Reference

A service used to sort the contents of a XUL widget. More...

import "nsIXULSortService.idl";

Inheritance diagram for nsIXULSortService:
Inheritance graph
[legend]
Collaboration diagram for nsIXULSortService:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void sort (in nsIDOMNode aNode, in AString aSortResource, in AString aSortDirection)
 Sort the contents of the widget containing aNode using aSortResource as the comparison key, and aSortDirection as the direction.
void insertContainerNode (in nsIRDFCompositeDataSource db, in nsRDFSortState sortStatePtr, in nsIContent root, in nsIContent trueParent, in nsIContent container, in nsIContent node, in boolean aNotify)
 Used internally for insertion sorting.

Detailed Description

A service used to sort the contents of a XUL widget.

Definition at line 55 of file nsIXULSortService.idl.


Member Function Documentation

void nsIXULSortService::insertContainerNode ( in nsIRDFCompositeDataSource  db,
in nsRDFSortState  sortStatePtr,
in nsIContent  root,
in nsIContent  trueParent,
in nsIContent  container,
in nsIContent  node,
in boolean  aNotify 
)

Used internally for insertion sorting.

void nsIXULSortService::sort ( in nsIDOMNode  aNode,
in AString  aSortResource,
in AString  aSortDirection 
)

Sort the contents of the widget containing aNode using aSortResource as the comparison key, and aSortDirection as the direction.

Parameters:
aNodeA node in the XUL widget whose children are to be sorted. sort will traverse upwards to find the root node at which to begin the actualy sorting. For optimal results, pass in the root of the widget.
aSortResourceThe RDF resource to be used as the comparison key.
aSortDirectionMay be either natural to return the contents to their natural (unsorted) order, ascending to sort the contents in ascending order, or descending to sort the contents in descending order.

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