Songbird / Development / Songbird Add-Ons API Documentation

sbIMediaListViewTreeView Interface Reference

A tree view that views a media list view. More...

import "sbIMediaListViewTreeView.idl";

List of all members.

Public Member Functions

long getNextRowIndexForKeyNavigation (in AString aKeyString, in unsigned long aStartFrom)
 Calculates the first row index based on a series of keystrokes.

Public Attributes

attribute sbIMediaListViewTreeViewObserver observer
 Get and set an observer for this media list tree view. This observer must support nsIWeakReference.


Detailed Description

A tree view that views a media list view.

Definition at line 71 of file sbIMediaListViewTreeView.idl.


Member Function Documentation

long sbIMediaListViewTreeView::getNextRowIndexForKeyNavigation ( in AString  aKeyString,
in unsigned long  aStartFrom 
)

Calculates the first row index based on a series of keystrokes.

This method helps optimize the behavior of the tree view. When keyboard input occurs we want to select the next row that matches the keys that were pressed.

Parameters:
aKeyString - The accumulated keystrokes to be matched.
aStartFrom - The index from which to start searching
Returns:
The index of the next row that matches the keystrokes. -1 if the keystrokes do not match any row. The returned row index may be equal to the value passed in to aStartFrom.


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