import"sbILibraryConstraints.idl";
Public Member Functions | |
| sbILibraryConstraintBuilder | parseFromString (in AString aSerializedConstraint) |
| Attempt to parse a serialized constraint description. This expects a string as serialized by sbILibraryConstraint::toString(). More... | |
| sbILibraryConstraintBuilder | includeConstraint (in sbILibraryConstraint aConstraint) |
| Add an existing constraint to the builder. More... | |
| sbILibraryConstraintBuilder | include (in AString aProperty, in AString aValue) |
| Add a property / value pair to the current group. More... | |
| 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. More... | |
| sbILibraryConstraintBuilder | intersect () |
| Completes the current group and starts a new one. Each group will be intersected in the result. More... | |
| sbILibraryConstraint | get () |
| Returns the constructed constraint. More... | |
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.
| sbILibraryConstraint sbILibraryConstraintBuilder::get | ( | ) |
Returns the constructed constraint.
| sbILibraryConstraintBuilder sbILibraryConstraintBuilder::include | ( | in AString | aProperty, |
| in AString | aValue | ||
| ) |
Add a property / value pair to the current group.
| aProperty | The property to add |
| aValue | The value to add |
| sbILibraryConstraintBuilder sbILibraryConstraintBuilder::includeConstraint | ( | in sbILibraryConstraint | aConstraint | ) |
Add an existing constraint to the builder.
| aConstraint | The constraint 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.
| aProperty | The property to add |
| aValue | The values to add |
| sbILibraryConstraintBuilder sbILibraryConstraintBuilder::intersect | ( | ) |
Completes the current group and starts a new one. Each group will be intersected in the result.
| sbILibraryConstraintBuilder sbILibraryConstraintBuilder::parseFromString | ( | in AString | aSerializedConstraint | ) |
Attempt to parse a serialized constraint description. This expects a string as serialized by sbILibraryConstraint::toString().
| aSerializedConstraint | the serialized string of the constraints |
| NS_ERROR_ALREADY_INITIALIZED | if constraints already exist |
| NS_ERROR_ILLEGAL_VALUE | if the string could not be unserialized |
