Songbird / Development / Songbird Add-Ons API Documentation

sbIFaceplatePane Interface Reference

Interface used to communicate with faceplate pane binding instances. More...

import "sbIFaceplatePane.idl";

List of all members.

Public Member Functions

void setData (in AString aKey, in nsIVariant aValue)
 Stores the given data under the given key name, and notifies all observers.
nsIVariant getData (in AString aKey)
 Retrieve the data with the given key name.
nsIStringEnumerator getKeys ()
 Gets a string enumerator for all data keys.
void addObserver (in nsIObserver aObserver)
 Adds an observer to receive notification when setData is called.
void removeObserver (in nsIObserver aObserver)
 Remove an observer.

Public Attributes

readonly attribute AString name
 Human readable name for this pane.
readonly attribute AString id
 Unique identifier for this pane.
readonly attribute AString bindingURL
 The location and id of the XBL binding for this faceplate.


Detailed Description

Interface used to communicate with faceplate pane binding instances.

This interface provides a single point of access to the potentially many instances of a single faceplate pane (if more than one window is open, then there is more than one faceplate, and each faceplate must have an instance of the pane)

Calling setData can be used to cause all observing faceplate panes to update their UI.

Since setData takes an nsIVariant it is possible to send interfaces to pane bindings. For example, you could provide an RDFDataSource and have your panes generate their UI from a template.

See also:
sbIFaceplateManager faceplate.xml

Definition at line 59 of file sbIFaceplatePane.idl.


Member Function Documentation

void sbIFaceplatePane::setData ( in AString  aKey,
in nsIVariant  aValue 
)

Stores the given data under the given key name, and notifies all observers.

Parameters:
aKey A name to store the data under.
aValue Something to store.

nsIVariant sbIFaceplatePane::getData ( in AString  aKey  ) 

Retrieve the data with the given key name.

Parameters:
aKey The name under which the data is stored.
Returns:
Some data, or null

nsIStringEnumerator sbIFaceplatePane::getKeys (  ) 

Gets a string enumerator for all data keys.

Returns:
String enumerator.

void sbIFaceplatePane::addObserver ( in nsIObserver  aObserver  ) 

Adds an observer to receive notification when setData is called.

Adds an observer that will be called with observe(this, key, null) when setData is called on this interface. The third parameter is not used, as the data is an nsIVariant, and not necessarily a string.

Parameters:
aObserver A callback object with an observe method.

void sbIFaceplatePane::removeObserver ( in nsIObserver  aObserver  ) 

Remove an observer.

Parameters:
aObserver an callback object previously passed to addObserver.


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