Songbird / Development / Songbird Add-Ons API Documentation

sbIPropertyManager Interface Reference

Manager for system wide metadata properties. More...

import "sbIPropertyManager.idl";

List of all members.

Public Member Functions

sbIPropertyInfo getPropertyInfo (in AString aID)
 Get a property object from its id.
void addPropertyInfo (in sbIPropertyInfo aPropertyInfo)
 Add a property into the system.
boolean hasProperty (in AString aID)
 Check for a property in the system by ID.
nsIStringBundle createBundle (in string aURLSpec)
 Helper to get a string bundle.
AString getStringFromName (in nsIStringBundle aBundle, in AString aName)
 Helper to get a display value, using a string name, from a bundle.
sbIPropertyArray getDependentProperties (in AString aID)
 Get all the properties that in any way depend on the given property. For example, the secondary sort of property A may include property B.

Public Attributes

readonly attribute nsIStringEnumerator propertyIDs
 An enumerator containing the ids of all registered properties.


Detailed Description

Manager for system wide metadata properties.

Components should register properties with this service at startup.

See also:
sbIPropertyInfo

Definition at line 52 of file sbIPropertyManager.idl.


Member Function Documentation

sbIPropertyInfo sbIPropertyManager::getPropertyInfo ( in AString  aID  ) 

Get a property object from its id.

Parameters:
aID ID of the property
Returns:
Property object for the given property, null if not found

void sbIPropertyManager::addPropertyInfo ( in sbIPropertyInfo  aPropertyInfo  ) 

Add a property into the system.

Parameters:
aPropertyInfo Property to add into the system. An exception is thrown if the property's ID is not unique

boolean sbIPropertyManager::hasProperty ( in AString  aID  ) 

Check for a property in the system by ID.

Parameters:
aID ID of the property
Returns:
true if property is in system

false if property is not in system


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