sbIMediaListViewMap Interface Reference

A mapping from nsISupports objects to save sbIMediaListView states. More...

import"sbIMediaListViewMap.idl";

Inheritance diagram for sbIMediaListViewMap:

Collaboration diagram for sbIMediaListViewMap:

Public Member Functions
sbIMediaListView	getView (in nsISupports aParentKey, in nsISupports aPageKey)
	Given parent and pagekey objects, return the saved view or null if not saved. More...
void	setView (in nsISupports aParentKey, in nsISupports aPageKey, in sbIMediaListView aView)
	Given parent and pagekey objects, save the given view. More...
void	releaseViews (in nsISupports aParentKey)
	Release all views held by a parent grouping. More...

Detailed Description

A mapping from nsISupports objects to save sbIMediaListView states.

See Also

sbIMediaListView

Definition at line 44 of file sbIMediaListViewMap.idl.

Member Function Documentation

sbIMediaListView sbIMediaListViewMap::getView	(	in nsISupports	aParentKey,
		in nsISupports	aPageKey
	)

Given parent and pagekey objects, return the saved view or null if not saved.

Parameters

aParentKey	A grouping object for a set of saved views. See sbIMediaListViewMap::releaseViews().
aPageKey	A unique object to reference the saved view.

Returns

sbIMediaListView The saved view, or null if none was ever saved.

void sbIMediaListViewMap::releaseViews

(

in nsISupports

aParentKey

)

Release all views held by a parent grouping.

Usually, the parent object will be the browser for an open tab. When the tab is closed, the history is released, so the views may be released as well.

Parameters

aParentKey

The grouping object to release. Release everything if (aParentKey == nsnull).

void sbIMediaListViewMap::setView	(	in nsISupports	aParentKey,
		in nsISupports	aPageKey,
		in sbIMediaListView	aView
	)

Given parent and pagekey objects, save the given view.

Parameters

aParentKey	A grouping object for a set of saved views. See sbIMediaListViewMap::releaseViews().
aPageKey	A unique object to reference the saved view.
aView	The view to be saved.

---

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

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