Songbird / Development / Songbird Add-Ons API Documentation

sbIDeviceProperties Interface Reference

List of all members.

Public Member Functions

void initFriendlyName (in AString aFriendlyName)
 Initialize Friendly Name property from a device.
void initVendorName (in AString aVendorName)
 Initialize Vendor Name propery for a device.
void initModelNumber (in nsIVariant aModelNumber)
 Initialize Model Number propery for a device.
void initSerialNumber (in nsIVariant aSerialNumber)
 Initialize Serial Number propery for a device.
void initDeviceLocation (in nsIURI aDeviceLocationUri)
 Initialize Device Location for a device.
void initDeviceIcon (in nsIURI aDeviceIconUri)
 Initialize propery for a device.
void initDeviceProperties (in nsIPropertyBag2 aProperties)
 Initialize Device Properties for a device.
void initDone ()
 Indicates that the initialization is complete, the initilize functions above will no longer affect the data.

Public Attributes

attribute AString friendlyName
readonly attribute AString vendorName
readonly attribute nsIVariant modelNumber
readonly attribute nsIVariant serialNumber
readonly attribute nsIURI uri
readonly attribute nsIURI iconUri
readonly attribute nsIPropertyBag2 properties

Detailed Description

Definition at line 39 of file sbIDeviceProperties.idl.


Member Data Documentation

attribute AString sbIDeviceProperties::friendlyName

A human readable name. Not included in the hash code and therefore optional. This name can be written to by the user and should be reflected back to the device.

Definition at line 88 of file sbIDeviceProperties.idl.

readonly attribute AString sbIDeviceProperties::vendorName

A string identifying the vendor of a device. Included in the hash code.

Definition at line 93 of file sbIDeviceProperties.idl.

readonly attribute nsIVariant sbIDeviceProperties::modelNumber

Model number for the device. Can be set in any appropriate format, but will be converted to a string and included in the hash code.

Definition at line 99 of file sbIDeviceProperties.idl.

readonly attribute nsIVariant sbIDeviceProperties::serialNumber

Serial number for the device. Can be set in any appropriate format, but will be converted to a string and included in the hash code.

Definition at line 105 of file sbIDeviceProperties.idl.

readonly attribute nsIURI sbIDeviceProperties::uri

A URI representing the location of the device. Not included in the hash code and therefore optional.

Definition at line 111 of file sbIDeviceProperties.idl.

readonly attribute nsIURI sbIDeviceProperties::iconUri

The preferred icon to be displayed to the user. The user may be able to specify a custom icon for the device in the future.

Definition at line 117 of file sbIDeviceProperties.idl.

readonly attribute nsIPropertyBag2 sbIDeviceProperties::properties

All of the properties available for a device. Should only contain objects that implement nsIProperty!

Definition at line 123 of file sbIDeviceProperties.idl.


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