sbIDataRemote.idl
Go to the documentation of this file.
1 /*
2  *=BEGIN SONGBIRD GPL
3  *
4  * This file is part of the Songbird web player.
5  *
6  * Copyright(c) 2005-2009 POTI, Inc.
7  * http://www.songbirdnest.com
8  *
9  * This file may be licensed under the terms of of the
10  * GNU General Public License Version 2 (the ``GPL'').
11  *
12  * Software distributed under the License is distributed
13  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
14  * express or implied. See the GPL for the specific language
15  * governing rights and limitations.
16  *
17  * You should have received a copy of the GPL along with this
18  * program. If not, go to http://www.gnu.org/licenses/gpl.html
19  * or write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  *=END SONGBIRD GPL
23  */
24 
31 #include "nsISupports.idl"
32 #include "nsIObserver.idl"
33 
34 interface nsIDOMElement;
35 interface sbIRemoteObserver;
36 
56 [scriptable, uuid(0f318938-0ea5-46b6-9e02-fda0ff19cbb7)]
58 {
59 
70  void init(in AString aKey, [optional] in AString aRoot);
71 
79  void unbind();
80 
90  void bindObserver(in nsIObserver aObserver,
91  [optional] in boolean aSuppressFirst);
92 
105  void bindRemoteObserver(in sbIRemoteObserver aObserver,
106  [optional] in boolean aSuppressFirst);
107 
120  void bindProperty(in nsIDOMElement aElement,
121  in AString aProperty,
122  [optional] in boolean aIsBool,
123  [optional] in boolean aIsNot,
124  [optional] in AString aEvalString);
125 
138  void bindAttribute(in nsIDOMElement aElement,
139  in AString aProperty,
140  [optional] in boolean aIsBool,
141  [optional] in boolean aIsNot,
142  [optional] in AString aEvalString);
143 
147  void deleteBranch();
148 
160  attribute AString stringValue;
161 
173  attribute boolean boolValue;
174 
186  attribute long long intValue;
187 
188 };
189 
190 
191 
192 
void deleteBranch()
Called to remove the data remote and all its children.
void bindRemoteObserver(in sbIRemoteObserver aObserver, [optional] in boolean aSuppressFirst)
When the key associated with the sbDataRemote changes the observer will get a callback to observe() w...
var uuid
An interface for accessing, and binding to, stored data.
void bindProperty(in nsIDOMElement aElement, in AString aProperty, [optional] in boolean aIsBool, [optional] in boolean aIsNot, [optional] in AString aEvalString)
When the key associated with the sbDataRemote changes the property of the element will be modified ap...
void bindObserver(in nsIObserver aObserver, [optional] in boolean aSuppressFirst)
When the key associated with the sbDataRemote changes the observer will get a callback to observe() w...
void init(in AString aKey, [optional] in AString aRoot)
Initialize the DataRemote Sets internal state, MUST be called before any other methods. All other calls will throw exceptions if init has not been called.
attribute AString stringValue
Access to the data in string format In javascript you can access the data as you would properties of ...
attribute boolean boolValue
Access to the data in boolean format In javascript you can access the data as you would properties of...
void unbind()
Disconnect the DataRemote If this DataRemote has been bound via a call to bindObserver(), bindAttribute() or bindProperty() it must be disconnected to prevent calls back to objects that may no longer be around.
attribute long long intValue
Access to the data in integer format In javascript you can access the data as you would properties of...
void bindAttribute(in nsIDOMElement aElement, in AString aProperty, [optional] in boolean aIsBool, [optional] in boolean aIsNot, [optional] in AString aEvalString)
When the key associated with the sbDataRemote changes the attribute of the element will be modified a...
Lightweight Observer style interface for use with sbIRemotePlayer::addListener.