diff options
Diffstat (limited to 'dom/xul/templates/nsIXULTemplateRuleFilter.idl')
-rw-r--r-- | dom/xul/templates/nsIXULTemplateRuleFilter.idl | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/dom/xul/templates/nsIXULTemplateRuleFilter.idl b/dom/xul/templates/nsIXULTemplateRuleFilter.idl new file mode 100644 index 000000000..59c88e072 --- /dev/null +++ b/dom/xul/templates/nsIXULTemplateRuleFilter.idl @@ -0,0 +1,36 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include "domstubs.idl" + +interface nsISupports; +interface nsIXULTemplateResult; + +/** + * 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. + */ +[scriptable, uuid(819cd1ed-8010-42e1-a8b9-778b726a1ff3)] +interface nsIXULTemplateRuleFilter : nsISupports +{ + /** + * 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. + * + * @param aRef the result to examine + * @param aRule the rule node + * + * @return true if the rule matches + */ + boolean match(in nsIXULTemplateResult aRef, in nsIDOMNode aRule); +}; |