WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIXULTemplateRuleFilter

IID:819cd1ed-8010-42e1-a8b9-778b726a1ff3
Inherits From:nsISupports

A rule filter may be used to add additional filtering of results to a rule. The filter is used to further reject results from matching the template's rules, beyond what the template syntax can do itself, thus allowing for more complex result filtering. The rule filter is applied after the rule syntax within the template.

Only one filter may apply to each rule within the template and may be assigned using the template builder's addRuleFilter method.


Methods

PRBool match ( nsIXULTemplateResult ref , nsIDOMNode rule )

PRBool match ( nsIXULTemplateResult ref , nsIDOMNode rule )

Evaluate a result and return true if the result is accepted by this filter, or false if it is rejected. Accepted results will have output generated for them for the rule. Rejected results will not, but they may still match another rule.

Arguments:
ref: the result to examine
rule: the rule node
Returns:
true if the rule matches

References

This interface is passed as an argument to the following methods:

nsIXULTemplateBuilder.addRuleFilter

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com