sbIPropertyManager.idl
Go to the documentation of this file.
1 /*
2 //
3 // BEGIN SONGBIRD GPL
4 //
5 // This file is part of the Songbird web player.
6 //
7 // Copyright(c) 2005-2008 POTI, Inc.
8 // http://songbirdnest.com
9 //
10 // This file may be licensed under the terms of of the
11 // GNU General Public License Version 2 (the "GPL").
12 //
13 // Software distributed under the License is distributed
14 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
15 // express or implied. See the GPL for the specific language
16 // governing rights and limitations.
17 //
18 // You should have received a copy of the GPL along with this
19 // program. If not, go to http://www.gnu.org/licenses/gpl.html
20 // or write to the Free Software Foundation, Inc.,
21 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 //
23 // END SONGBIRD GPL
24 //
25 */
26 
33 #include "nsISupports.idl"
34 
35 interface nsISimpleEnumerator;
36 interface nsIStringEnumerator;
37 interface nsIStringBundle;
38 interface nsIURI;
39 interface sbIPropertyInfo;
40 interface sbIPropertyArray;
41 interface sbIPropertyUnitConverter;
42 
51 [scriptable, uuid(ed260380-8c1b-11dd-ad8b-0800200c9a66)]
53 {
58  readonly attribute nsIStringEnumerator propertyIDs;
59 
65  sbIPropertyInfo getPropertyInfo(in AString aID);
66 
72  void addPropertyInfo(in sbIPropertyInfo aPropertyInfo);
73 
80  boolean hasProperty(in AString aID);
81 
85  nsIStringBundle createBundle(in string aURLSpec);
86 
90  AString getStringFromName(in nsIStringBundle aBundle, in AString aName);
91 
98 };
99 
115 %{C++
116  #define SB_PROPERTY_MANAGER_READY_CATEGORY "songbird-property-manager-ready"
117 %}C++
118 
123 [scriptable, uuid(2C334049-EFCD-40ed-99F8-A96D541569E5)]
125 {
129  readonly attribute AString operator;
130 
135  readonly attribute AString operatorReadable;
136 
141  void Init(in AString aOperator, in aString aOperatorReadable);
142 };
var uuid
readonly attribute nsIStringEnumerator propertyIDs
An enumerator containing the ids of all registered properties.
function C(H)
An interface to represent an operator that may act upon a property.
readonly attribute AString operatorReadable
The operator readable string or language property name.
void addPropertyInfo(in sbIPropertyInfo aPropertyInfo)
Add a property into the system.
An interface used to describe a metadata property for use by the UI and other sbILibrary interfaces (...
AString getStringFromName(in nsIStringBundle aBundle, in AString aName)
Helper to get a display value, using a string name, from a bundle.
boolean hasProperty(in AString aID)
Check for a property in the system by ID.
_updateCookies aName
Property unit converter interface This is an interface songbird property converter, used to convert a property value between its various units representations.
sbIPropertyArray getDependentProperties(in AString aID)
Get all the properties that in any way depend on the given property. For example, the secondary sort ...
void Init(in AString aOperator, in aString aOperatorReadable)
Initialize the operator.
nsIStringBundle createBundle(in string aURLSpec)
Helper to get a string bundle.
An interface to carry around arrays of nsIProperty instances. Users of this interface should only QI ...
Manager for system wide metadata properties.
sbIPropertyInfo getPropertyInfo(in AString aID)
Get a property object from its id.