content/xul/templates/public/nsIXULTemplateRuleFilter.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is Neil Deakin.
  18  * Portions created by the Initial Developer are Copyright (C) 2005
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either of the GNU General Public License Version 2 or later (the "GPL"),
  25  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "domstubs.idl"
  38
  39 interface nsISupports;
  40 interface nsIXULTemplateResult;
  41
  42 /**
  43  * A rule filter may be used to add additional filtering of results to a rule.
  44  * The filter is used to further reject results from matching the template's
  45  * rules, beyond what the template syntax can do itself, thus allowing for
  46  * more complex result filtering. The rule filter is applied after the rule
  47  * syntax within the template.
  48  *
  49  * Only one filter may apply to each rule within the template and may be
  50  * assigned using the template builder's addRuleFilter method.
  51  */
  52 [scriptable, uuid(819cd1ed-8010-42e1-a8b9-778b726a1ff3)]
  53 interface nsIXULTemplateRuleFilter : nsISupports
  54 {
  55   /**
  56    * Evaluate a result and return true if the result is accepted by this
  57    * filter, or false if it is rejected. Accepted results will have output
  58    * generated for them for the rule. Rejected results will not, but they
  59    * may still match another rule.
  60    *
  61    * @param aRef the result to examine
  62    * @param aRule the rule node
  63    *
  64    * @return true if the rule matches
  65    */
  66   boolean match(in nsIXULTemplateResult aRef, in nsIDOMNode aRule);
  67 };