Songbird / Development / Songbird Add-Ons API Documentation

sbIDisplayPaneManager Interface Reference

Songbird Display Panes Interface This is the main display panes management interface, used to register and list panes and instantiators. Display panes are blocks within the main user interface which can be used to load arbitary sub-documents for display to the user with full chrome privileges. More...

List of all members.

Public Member Functions

void registerInstantiator (in sbIDisplayPaneInstantiator aInstantiator)
void registerContent (in AString aContentUrl, in AString aContentTitle, in AString aContentIcon, in PRInt32 aDefaultWidth, in PRInt32 aDefaultHeight, in AString aSuggestedContentGroups, in PRBool aAutoShow)
void unregisterContent (in AString aContentUrl)
void updateContentInfo (in AString aContentUrl, in AString aNewContentTitle, in AString aNewContentIcon)
void showPane (in AString aContentUrl)
sbIDisplayPaneContentInfo getPaneInfo (in AString aContentUrl)
sbIDisplayPaneInstantiator getInstantiatorForWindow (in nsIDOMWindow aWindow)

Public Attributes

readonly attribute nsISimpleEnumerator contentList
readonly attribute nsISimpleEnumerator instantiatorsList
readonly attribute sbIDisplayPaneContentInfo defaultPaneInfo


Detailed Description

Songbird Display Panes Interface This is the main display panes management interface, used to register and list panes and instantiators. Display panes are blocks within the main user interface which can be used to load arbitary sub-documents for display to the user with full chrome privileges.

See also:
http://publicsvn.songbirdnest.com/browser/extensions/wikipedia

app/content/bindings/displayPane.xml

Definition at line 157 of file sbIDisplayPanes.idl.


Member Function Documentation

void sbIDisplayPaneManager::registerInstantiator ( in sbIDisplayPaneInstantiator  aInstantiator  ) 

Register a display pane instantiator; the instantiator may be called to actually show the display pane to the user.

void sbIDisplayPaneManager::registerContent ( in AString  aContentUrl,
in AString  aContentTitle,
in AString  aContentIcon,
in PRInt32  aDefaultWidth,
in PRInt32  aDefaultHeight,
in AString  aSuggestedContentGroups,
in PRBool  aAutoShow 
)

Register display pane content, so that it may be shown to the user.

See also:
sbIDisplayPaneContentInfo

void sbIDisplayPaneManager::unregisterContent ( in AString  aContentUrl  ) 

unregister content, so it is not presented to the user anymore. any panes currently displaying the url will be hidden.

void sbIDisplayPaneManager::updateContentInfo ( in AString  aContentUrl,
in AString  aNewContentTitle,
in AString  aNewContentIcon 
)

update the title and icon for a given url

void sbIDisplayPaneManager::showPane ( in AString  aContentUrl  ) 

show previously registered content with the given url using the first instantiator of a content group that is listed as suggested by the registered info. If no matching instantiator is found, the content may be shown at some future point when it becomes registered.

sbIDisplayPaneContentInfo sbIDisplayPaneManager::getPaneInfo ( in AString  aContentUrl  ) 

get the previously registed content information given its url

sbIDisplayPaneInstantiator sbIDisplayPaneManager::getInstantiatorForWindow ( in nsIDOMWindow  aWindow  ) 

get the instantiator the given window belongs to


Member Data Documentation

readonly attribute nsISimpleEnumerator sbIDisplayPaneManager::contentList

enumerate through the registered content; each element is a sbIDisplayPaneContentInfo

Definition at line 203 of file sbIDisplayPanes.idl.

readonly attribute nsISimpleEnumerator sbIDisplayPaneManager::instantiatorsList

enumerate through the registered instantiatorsl each element is a sbIDisplayPaneInstantiator

Definition at line 208 of file sbIDisplayPanes.idl.

readonly attribute sbIDisplayPaneContentInfo sbIDisplayPaneManager::defaultPaneInfo

Pane info for the default panes that appear when the display panes are shown before choosing a pane to view.

Definition at line 227 of file sbIDisplayPanes.idl.


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