Songbird / Development / Songbird Add-Ons API Documentation

sbIPropertyArray Interface Reference

An interface to carry around arrays of nsIProperty instances. Users of this interface should only QI it to a sbIMutablePropertyArray if they are the owners of the instance. More...

import "sbIPropertyArray.idl";

Inheritance diagram for sbIPropertyArray:

sbIMutablePropertyArray List of all members.

Public Member Functions

sbIProperty getPropertyAt (in unsigned long aIndex)
AString getPropertyValue (in AString aID)
AString toString ()

Public Attributes

readonly attribute boolean validated

Detailed Description

An interface to carry around arrays of nsIProperty instances. Users of this interface should only QI it to a sbIMutablePropertyArray if they are the owners of the instance.

Definition at line 56 of file sbIPropertyArray.idl.


Member Function Documentation

sbIProperty sbIPropertyArray::getPropertyAt ( in unsigned long  aIndex  ) 

Gets the property at the specified index

Parameters:
aIndex The index of the property to retrieve

AString sbIPropertyArray::getPropertyValue ( in AString  aID  ) 

Gets the value for a property in the array

Parameters:
aID ID of the property to get the value for
Returns:
Value of the property
Exceptions:
NS_ERROR_NOT_AVAILABLE if the property is not in the array

AString sbIPropertyArray::toString (  ) 

Return the contents of the property array as a string


Member Data Documentation

readonly attribute boolean sbIPropertyArray::validated

Determines whether or not the items in the array have been validated prior to insertion.

Definition at line 83 of file sbIPropertyArray.idl.


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