Songbird / Development / Songbird Add-Ons API Documentation

sbILibraryConstraintBuilder Interface Reference

import "sbILibraryConstraints.idl";

List of all members.

Public Member Functions

sbILibraryConstraintBuilder includeConstraint (in sbILibraryConstraint aConstraint)
 Add an existing constraint to the builder.
sbILibraryConstraintBuilder include (in AString aProperty, in AString aValue)
 Add a property / value pair to the current group.
sbILibraryConstraintBuilder includeList (in AString aProperty, in nsIStringEnumerator aValues)
 Adds a property / value pair to the current group for each of the values supplied in the value list. This is a shortcut to calling include for every value with the same property.
sbILibraryConstraintBuilder intersect ()
 Completes the current group and starts a new one. Each group will be intersected in the result.
sbILibraryConstraint get ()
 Returns the constructed constraint.


Detailed Description

A library constraint is used to apply a filter or a search to a view. A constraint consits of:

Definition at line 53 of file sbILibraryConstraints.idl.


Member Function Documentation

sbILibraryConstraintBuilder sbILibraryConstraintBuilder::includeConstraint ( in sbILibraryConstraint  aConstraint  ) 

Add an existing constraint to the builder.

Parameters:
aConstraint The constraint to add

sbILibraryConstraintBuilder sbILibraryConstraintBuilder::include ( in AString  aProperty,
in AString  aValue 
)

Add a property / value pair to the current group.

Parameters:
aProperty The property to add
aValue The value to add

sbILibraryConstraintBuilder sbILibraryConstraintBuilder::includeList ( in AString  aProperty,
in nsIStringEnumerator  aValues 
)

Adds a property / value pair to the current group for each of the values supplied in the value list. This is a shortcut to calling include for every value with the same property.

Parameters:
aProperty The property to add
aValue The values to add


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