Interface used to communicate with faceplate pane binding instances. More...
import"sbIFaceplatePane.idl";
Public Member Functions | |
| void | setData (in AString aKey, in nsIVariant aValue) |
| Stores the given data under the given key name, and notifies all observers. More... | |
| nsIVariant | getData (in AString aKey) |
| Retrieve the data with the given key name. More... | |
| nsIStringEnumerator | getKeys () |
| Gets a string enumerator for all data keys. More... | |
| void | addObserver (in nsIObserver aObserver) |
| Adds an observer to receive notification when setData is called. More... | |
| void | removeObserver (in nsIObserver aObserver) |
| Remove an observer. More... | |
Public Attributes | |
| readonly attribute AString | name |
| Human readable name for this pane. More... | |
| readonly attribute AString | id |
| Unique identifier for this pane. More... | |
| readonly attribute AString | bindingURL |
| The location and id of the XBL binding for this faceplate. More... | |
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.
Definition at line 59 of file sbIFaceplatePane.idl.
| 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.
| aObserver | A callback object with an observe method. |
| nsIVariant sbIFaceplatePane::getData | ( | in AString | aKey | ) |
Retrieve the data with the given key name.
| aKey | The name under which the data is stored. |
| nsIStringEnumerator sbIFaceplatePane::getKeys | ( | ) |
Gets a string enumerator for all data keys.
| void sbIFaceplatePane::removeObserver | ( | in nsIObserver | aObserver | ) |
Remove an observer.
| aObserver | an callback object previously passed to addObserver. |
| void sbIFaceplatePane::setData | ( | in AString | aKey, |
| in nsIVariant | aValue | ||
| ) |
Stores the given data under the given key name, and notifies all observers.
| aKey | A name to store the data under. |
| aValue | Something to store. |
| readonly attribute AString sbIFaceplatePane::bindingURL |
The location and id of the XBL binding for this faceplate.
Definition at line 74 of file sbIFaceplatePane.idl.
| readonly attribute AString sbIFaceplatePane::id |
Unique identifier for this pane.
Definition at line 69 of file sbIFaceplatePane.idl.
| readonly attribute AString sbIFaceplatePane::name |
Human readable name for this pane.
Definition at line 64 of file sbIFaceplatePane.idl.
