Songbird / Development / Songbird Add-Ons API Documentation

sbIMediaPageManager Interface Reference

The medialist page manager, used to register, unregister, enumerate, set and retrieve page/medialists associations. More...

List of all members.

Public Member Functions

sbIMediaPageInfo registerPage (in AString aName, in AString aURL, in sbIMediaListMatch aMatch)
 Register a medialist page.
void unregisterPage (in sbIMediaPageInfo aPageInfo)
 Unregister a medialist page.
nsISimpleEnumerator getAvailablePages ([optional] in sbIMediaList aList)
 Get the list of available pages. The list parameter is optional, if not specified, the entire list of registered pages is returned.
sbIMediaPageInfo getPage (in sbIMediaList aList)
 Get the active page for a medialist.
void setPage (in sbIMediaList aList, in sbIMediaPageInfo aPageInfo)
 Set the active page for a medialist.


Detailed Description

The medialist page manager, used to register, unregister, enumerate, set and retrieve page/medialists associations.

Definition at line 40 of file sbIMediaPageManager.idl.


Member Function Documentation

sbIMediaPageInfo sbIMediaPageManager::registerPage ( in AString  aName,
in AString  aURL,
in sbIMediaListMatch  aMatch 
)

Register a medialist page.

Parameters:
aName The localized name of the page
aURL The chrome URL to the page
aMatch The interface or js function used to determine whether this page matches a particular medialist
Returns:
An sbMediaListIPageInfo interface describing the page

void sbIMediaPageManager::unregisterPage ( in sbIMediaPageInfo  aPageInfo  ) 

Unregister a medialist page.

Parameters:
aPageInfo a sbIMediaPageInfo interface as previously returned by registerPage

nsISimpleEnumerator sbIMediaPageManager::getAvailablePages ( [optional] in sbIMediaList  aList  ) 

Get the list of available pages. The list parameter is optional, if not specified, the entire list of registered pages is returned.

Parameters:
aList (optional) The medialist for which the list of available matching pages is being requested
Returns:
An nsISimpleEnumerator containing a list of sbIMediaPageInfo interfaces

sbIMediaPageInfo sbIMediaPageManager::getPage ( in sbIMediaList  aList  ) 

Get the active page for a medialist.

Pages are matched in the order of registration, that is, if several pages match a particular medialist, the first one to have been registered is returned.

If a page has been set to a medialist via the setPage method, the search for a matching list is bypassed, and that page is returned again, unless it no longer exists or no longer matches the medialist.

If a medialist has a defaultMediaPageURL property set to a particular page, and has not been set to a different one via the setPage method, the search is also bypassed, and that page is returned, unless it no longer exists or no longer matches the medialist.

Parameters:
aList The medialist for which the active page is being requested

void sbIMediaPageManager::setPage ( in sbIMediaList  aList,
in sbIMediaPageInfo  aPageInfo 
)

Set the active page for a medialist.

Parameters:
aList The medialist for which the page is being set
aPageInfo The page that is being set to the medialist


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