Songbird / Development / Songbird Add-Ons API Documentation

sbIMediaListViewMap Interface Reference

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

import "sbIMediaListViewMap.idl";

List of all members.

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.
void setView (in nsISupports aParentKey, in nsISupports aPageKey, in sbIMediaListView aView)
 Given parent and pagekey objects, save the given view.
void releaseViews (in nsISupports aParentKey)
 Release all views held by a parent grouping.


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::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.

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).


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