Songbird / Development / Songbird Add-Ons API Documentation

sbIMutablePropertyArray Interface Reference

An interface to carry around arrays of nsIProperty instances Note that implementations of the interface should also provide nsIMutableArray. QI to nsIMutableArray to access add/remove/clear methods. More...

import "sbIPropertyArray.idl";

Inheritance diagram for sbIMutablePropertyArray:

sbIPropertyArray List of all members.

Public Member Functions

void appendProperty (in AString aID, in AString aValue)

Public Attributes

attribute boolean strict

Detailed Description

An interface to carry around arrays of nsIProperty instances Note that implementations of the interface should also provide nsIMutableArray. QI to nsIMutableArray to access add/remove/clear methods.

Definition at line 93 of file sbIPropertyArray.idl.


Member Function Documentation

void sbIMutablePropertyArray::appendProperty ( in AString  aID,
in AString  aValue 
)

Adds a new property to the array

Parameters:
aID The id of the property
aValue The value of the property
Exceptions:
NS_ERROR_ILLEGAL_VALUE if the 'strict' attribute is true and aValue fails the 'validate' method of the sbIPropertyInfo represented by aName fails.


Member Data Documentation

attribute boolean sbIMutablePropertyArray::strict

Determines whether or not the appendProperty method will throw on invalid input (i.e. setting a value on a property whose sbIPropertyInfo 'validate' method fails on that input). Defaults to true.

An example of improper usage is setting non-numeric text in a property whose parent sbIPropertyInfo is actually sbINumberPropertyInfo.

Note that this property can only be set if the implementing array is empty. Any attempt to set this property after 'appendProperty' has been called will throw NS_ERROR_FAILURE.

Definition at line 120 of file sbIPropertyArray.idl.


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