sbIDeviceProperties Interface Reference

import"sbIDeviceProperties.idl";

Inheritance diagram for sbIDeviceProperties:
[legend]
Collaboration diagram for sbIDeviceProperties:
[legend]

Public Member Functions

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

Public Attributes

attribute AString friendlyName
 
readonly attribute AString defaultName
 
readonly attribute AString vendorName
 
readonly attribute nsIVariant modelNumber
 
readonly attribute nsIVariant serialNumber
 
readonly attribute AString firmwareVersion
 
readonly attribute nsIURI uri
 
readonly attribute nsIURI iconUri
 
readonly attribute nsIPropertyBag2 properties
 
attribute boolean hidden
 

Detailed Description

Definition at line 39 of file sbIDeviceProperties.idl.

Member Function Documentation

void sbIDeviceProperties::initDefaultName ( in AString  aDefaultName)

Initialize Default Name property from a device.

void sbIDeviceProperties::initDeviceIcon ( in nsIURI  aDeviceIconUri)

Initialize propery for a device.

void sbIDeviceProperties::initDeviceLocation ( in nsIURI  aDeviceLocationUri)

Initialize Device Location for a device.

void sbIDeviceProperties::initDeviceProperties ( in nsIPropertyBag2  aProperties)

Initialize Device Properties for a device.

void sbIDeviceProperties::initDone ( )

Indicates that the initialization is complete, the initilize functions above will no longer affect the data.

void sbIDeviceProperties::initFirmwareVersion ( in AString  aFirmwareVersion)

Initialize Firmware Version property for a device.

void sbIDeviceProperties::initFriendlyName ( in AString  aFriendlyName)

Initialize Friendly Name property from a device.

void sbIDeviceProperties::initModelNumber ( in nsIVariant  aModelNumber)

Initialize Model Number propery for a device.

void sbIDeviceProperties::initSerialNumber ( in nsIVariant  aSerialNumber)

Initialize Serial Number propery for a device.

void sbIDeviceProperties::initVendorName ( in AString  aVendorName)

Initialize Vendor Name propery for a device.

Member Data Documentation

readonly attribute AString sbIDeviceProperties::defaultName

Default name for the device. Not included in the hash code and therefore optional.

Definition at line 104 of file sbIDeviceProperties.idl.

readonly attribute AString sbIDeviceProperties::firmwareVersion

Firmware version for the device. In human readable format.

Note
Optional, may be empty.

Definition at line 127 of file sbIDeviceProperties.idl.

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 98 of file sbIDeviceProperties.idl.

attribute boolean sbIDeviceProperties::hidden

Returns true if the device is supposed to be hidden to the user.

Definition at line 150 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 139 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 115 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 145 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 121 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 133 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 109 of file sbIDeviceProperties.idl.


The documentation for this interface was generated from the following file: