/gecko_api/include/nsIDOMNodeList.h

  1/*
  2 * DO NOT EDIT.  THIS FILE IS GENERATED FROM /builds/tinderbox/XR-Trunk/Darwin_8.8.4_Depend/mozilla/dom/public/idl/core/nsIDOMNodeList.idl
  3 */
  4
  5#ifndef __gen_nsIDOMNodeList_h__
  6#define __gen_nsIDOMNodeList_h__
  7
  8
  9#ifndef __gen_domstubs_h__
 10#include "domstubs.h"
 11#endif
 12
 13/* For IDL files that don't want to include root IDL files. */
 14#ifndef NS_NO_VTABLE
 15#define NS_NO_VTABLE
 16#endif
 17
 18/* starting interface:    nsIDOMNodeList */
 19#define NS_IDOMNODELIST_IID_STR "a6cf907d-15b3-11d2-932e-00805f8add32"
 20
 21#define NS_IDOMNODELIST_IID \
 22  {0xa6cf907d, 0x15b3, 0x11d2, \
 23    { 0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32 }}
 24
 25class NS_NO_VTABLE NS_SCRIPTABLE nsIDOMNodeList : public nsISupports {
 26 public: 
 27
 28  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IDOMNODELIST_IID)
 29
 30  /**
 31 * The nsIDOMNodeList interface provides the abstraction of an ordered 
 32 * collection of nodes, without defining or constraining how this collection 
 33 * is implemented.
 34 * The items in the list are accessible via an integral index, starting from 0.
 35 *
 36 * For more information on this interface please see 
 37 * http://www.w3.org/TR/DOM-Level-2-Core/
 38 *
 39 * @status FROZEN
 40 */
 41  /* nsIDOMNode item (in unsigned long index); */
 42  NS_SCRIPTABLE NS_IMETHOD Item(PRUint32 index, nsIDOMNode **_retval) = 0;
 43
 44  /* readonly attribute unsigned long length; */
 45  NS_SCRIPTABLE NS_IMETHOD GetLength(PRUint32 *aLength) = 0;
 46
 47};
 48
 49  NS_DEFINE_STATIC_IID_ACCESSOR(nsIDOMNodeList, NS_IDOMNODELIST_IID)
 50
 51/* Use this macro when declaring classes that implement this interface. */
 52#define NS_DECL_NSIDOMNODELIST \
 53  NS_SCRIPTABLE NS_IMETHOD Item(PRUint32 index, nsIDOMNode **_retval); \
 54  NS_SCRIPTABLE NS_IMETHOD GetLength(PRUint32 *aLength); 
 55
 56/* Use this macro to declare functions that forward the behavior of this interface to another object. */
 57#define NS_FORWARD_NSIDOMNODELIST(_to) \
 58  NS_SCRIPTABLE NS_IMETHOD Item(PRUint32 index, nsIDOMNode **_retval) { return _to Item(index, _retval); } \
 59  NS_SCRIPTABLE NS_IMETHOD GetLength(PRUint32 *aLength) { return _to GetLength(aLength); } 
 60
 61/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
 62#define NS_FORWARD_SAFE_NSIDOMNODELIST(_to) \
 63  NS_SCRIPTABLE NS_IMETHOD Item(PRUint32 index, nsIDOMNode **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->Item(index, _retval); } \
 64  NS_SCRIPTABLE NS_IMETHOD GetLength(PRUint32 *aLength) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetLength(aLength); } 
 65
 66#if 0
 67/* Use the code below as a template for the implementation class for this interface. */
 68
 69/* Header file */
 70class nsDOMNodeList : public nsIDOMNodeList
 71{
 72public:
 73  NS_DECL_ISUPPORTS
 74  NS_DECL_NSIDOMNODELIST
 75
 76  nsDOMNodeList();
 77
 78private:
 79  ~nsDOMNodeList();
 80
 81protected:
 82  /* additional members */
 83};
 84
 85/* Implementation file */
 86NS_IMPL_ISUPPORTS1(nsDOMNodeList, nsIDOMNodeList)
 87
 88nsDOMNodeList::nsDOMNodeList()
 89{
 90  /* member initializers and constructor code */
 91}
 92
 93nsDOMNodeList::~nsDOMNodeList()
 94{
 95  /* destructor code */
 96}
 97
 98/* nsIDOMNode item (in unsigned long index); */
 99NS_IMETHODIMP nsDOMNodeList::Item(PRUint32 index, nsIDOMNode **_retval)
100{
101    return NS_ERROR_NOT_IMPLEMENTED;
102}
103
104/* readonly attribute unsigned long length; */
105NS_IMETHODIMP nsDOMNodeList::GetLength(PRUint32 *aLength)
106{
107    return NS_ERROR_NOT_IMPLEMENTED;
108}
109
110/* End of implementation class template. */
111#endif
112
113
114#endif /* __gen_nsIDOMNodeList_h__ */