content/base/public/nsINodeList.h

   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 Mozilla.com.
  18  * Portions created by the Initial Developer are Copyright (C) 2008
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *         Boris Zbarsky <bzbarsky@mit.edu> (Original Author)
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsINodeList_h___
  39 #define nsINodeList_h___
  40
  41 class nsINode;
  42 class nsIDOMNodeList;
  43
  44 // IID for the nsINodeList interface
  45 #define NS_INODELIST_IID \
  46 { 0x943420c4, 0x8774, 0x43ea, \
  47  { 0xb3, 0x53, 0x62, 0xa1, 0x26, 0x1c, 0x9b, 0x55 } }
  48
  49 /**
  50  * An internal interface that allows QI-less getting of nodes from node lists
  51  */
  52 class nsINodeList : public nsIDOMNodeList
  53 {
  54 public:
  55   NS_DECLARE_STATIC_IID_ACCESSOR(NS_INODELIST_IID)
  56
  57   /**
  58    * Get the node at the index.  Returns null if the index is out of bounds
  59    */
  60   virtual nsINode* GetNodeAt(PRUint32 aIndex) = 0;
  61 };
  62
  63 #define NS_NODELIST_OFFSET_AND_INTERFACE_TABLE_BEGIN(_class)                  \
  64   NS_OFFSET_AND_INTERFACE_TABLE_BEGIN_AMBIGUOUS(_class, nsINodeList)
  65
  66 NS_DEFINE_STATIC_IID_ACCESSOR(nsINodeList, NS_INODELIST_IID)
  67
  68 #endif /* nsINodeList_h___ */