content/xul/templates/src/nsXULTemplateResultXML.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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) 2006
  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 #ifndef nsXULTemplateResultXML_h__
  38 #define nsXULTemplateResultXML_h__
  39
  40 #include "nsCOMPtr.h"
  41 #include "nsIRDFResource.h"
  42 #include "nsXULTemplateQueryProcessorXML.h"
  43 #include "nsIXULTemplateResult.h"
  44
  45 /**
  46  * An single result of an query
  47  */
  48 class nsXULTemplateResultXML : public nsIXULTemplateResult
  49 {
  50 public:
  51     NS_DECL_ISUPPORTS
  52
  53     NS_DECL_NSIXULTEMPLATERESULT
  54
  55     nsXULTemplateResultXML(nsXMLQuery* aQuery,
  56                            nsIDOMNode* aNode,
  57                            nsXMLBindingSet* aBindings);
  58
  59     ~nsXULTemplateResultXML() {}
  60
  61     void GetNode(nsIDOMNode** aNode);
  62
  63 protected:
  64
  65     // result id
  66     PRUint32 mId;
  67
  68     // query that generated the result
  69     nsCOMPtr<nsXMLQuery> mQuery;
  70
  71     // context node in datasource
  72     nsCOMPtr<nsIDOMNode> mNode;
  73
  74     // assignments in query
  75     nsXMLBindingValues mRequiredValues;
  76
  77     // extra assignments made by rules (<binding> tags)
  78     nsXMLBindingValues mOptionalValues;
  79 };
  80
  81 #endif // nsXULTemplateResultXML_h__