The medialist page manager, used to register, unregister, enumerate, set and retrieve page/medialists associations. More...
import"sbIMediaPageManager.idl";
Public Member Functions | |
| sbIMediaPageInfo | registerPage (in AString aName, in AString aURL, in AString aIcon, in sbIMediaListMatch aMatch) |
| Register a medialist page. More... | |
| void | unregisterPage (in sbIMediaPageInfo aPageInfo) |
| Unregister a medialist page. More... | |
| nsISimpleEnumerator | getAvailablePages ([optional] in sbIMediaList aList, [optional] in sbILibraryConstraint aConstraint) |
| Get the list of available pages. The list parameter is optional, if not specified, the entire list of registered pages is returned. More... | |
| sbIMediaPageInfo | getPage (in sbIMediaList aList, [optional] in sbILibraryConstraint aConstraint, [optional] in AString aType) |
| Get the active page for a medialist. More... | |
| void | setPage (in sbIMediaList aList, in sbIMediaPageInfo aPageInfo, [optional] in AString aType) |
| Set the active page for a medialist. More... | |
The medialist page manager, used to register, unregister, enumerate, set and retrieve page/medialists associations.
Definition at line 39 of file sbIMediaPageManager.idl.
| nsISimpleEnumerator sbIMediaPageManager::getAvailablePages | ( | [optional] in sbIMediaList | aList, |
| [optional] in sbILibraryConstraint | aConstraint | ||
| ) |
Get the list of available pages. The list parameter is optional, if not specified, the entire list of registered pages is returned.
| aList | (optional) The medialist for which the list of available matching pages is being requested |
| aConstraint | (optional) A library constrain used as an additional matching criteria |
| sbIMediaPageInfo sbIMediaPageManager::getPage | ( | in sbIMediaList | aList, |
| [optional] in sbILibraryConstraint | aConstraint, | ||
| [optional] in AString | aType | ||
| ) |
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.
| aList | The medialist for which the active page is being requested |
| aConstraint | (optional) A library constraint used as an additional matching criteria |
| aType | (optional) The content type of the service pane node |
| sbIMediaPageInfo sbIMediaPageManager::registerPage | ( | in AString | aName, |
| in AString | aURL, | ||
| in AString | aIcon, | ||
| in sbIMediaListMatch | aMatch | ||
| ) |
Register a medialist page.
| 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 |
| void sbIMediaPageManager::setPage | ( | in sbIMediaList | aList, |
| in sbIMediaPageInfo | aPageInfo, | ||
| [optional] in AString | aType | ||
| ) |
Set the active page for a medialist.
| aList | The medialist for which the page is being set |
| aPageInfo | The page that is being set to the medialist |
| aType | (optional) The content type of the service pane node |
| void sbIMediaPageManager::unregisterPage | ( | in sbIMediaPageInfo | aPageInfo | ) |
Unregister a medialist page.
| aPageInfo | a sbIMediaPageInfo interface as previously returned by registerPage |
