/gecko_api/include/nsIDOMWindowCollection.h

  1/*
  2 * DO NOT EDIT.  THIS FILE IS GENERATED FROM /builds/tinderbox/XR-Trunk/Darwin_8.8.4_Depend/mozilla/dom/public/idl/base/nsIDOMWindowCollection.idl
  3 */
  4
  5#ifndef __gen_nsIDOMWindowCollection_h__
  6#define __gen_nsIDOMWindowCollection_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:    nsIDOMWindowCollection */
 19#define NS_IDOMWINDOWCOLLECTION_IID_STR "a6cf906f-15b3-11d2-932e-00805f8add32"
 20
 21#define NS_IDOMWINDOWCOLLECTION_IID \
 22  {0xa6cf906f, 0x15b3, 0x11d2, \
 23    { 0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32 }}
 24
 25class NS_NO_VTABLE NS_SCRIPTABLE nsIDOMWindowCollection : public nsISupports {
 26 public: 
 27
 28  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IDOMWINDOWCOLLECTION_IID)
 29
 30  /**
 31 * The nsIDOMWindowCollection interface is an interface for a
 32 * collection of DOM window objects.
 33 *
 34 * @status FROZEN
 35 */
 36/**
 37   * Accessor for the number of windows in this collection.
 38   */
 39  /* readonly attribute unsigned long length; */
 40  NS_SCRIPTABLE NS_IMETHOD GetLength(PRUint32 *aLength) = 0;
 41
 42  /**
 43   * Method for accessing an item in this collection by index.
 44   */
 45  /* nsIDOMWindow item (in unsigned long index); */
 46  NS_SCRIPTABLE NS_IMETHOD Item(PRUint32 index, nsIDOMWindow **_retval) = 0;
 47
 48  /**
 49   * Method for accessing an item in this collection by window name.
 50   */
 51  /* nsIDOMWindow namedItem (in DOMString name); */
 52  NS_SCRIPTABLE NS_IMETHOD NamedItem(const nsAString & name, nsIDOMWindow **_retval) = 0;
 53
 54};
 55
 56  NS_DEFINE_STATIC_IID_ACCESSOR(nsIDOMWindowCollection, NS_IDOMWINDOWCOLLECTION_IID)
 57
 58/* Use this macro when declaring classes that implement this interface. */
 59#define NS_DECL_NSIDOMWINDOWCOLLECTION \
 60  NS_SCRIPTABLE NS_IMETHOD GetLength(PRUint32 *aLength); \
 61  NS_SCRIPTABLE NS_IMETHOD Item(PRUint32 index, nsIDOMWindow **_retval); \
 62  NS_SCRIPTABLE NS_IMETHOD NamedItem(const nsAString & name, nsIDOMWindow **_retval); 
 63
 64/* Use this macro to declare functions that forward the behavior of this interface to another object. */
 65#define NS_FORWARD_NSIDOMWINDOWCOLLECTION(_to) \
 66  NS_SCRIPTABLE NS_IMETHOD GetLength(PRUint32 *aLength) { return _to GetLength(aLength); } \
 67  NS_SCRIPTABLE NS_IMETHOD Item(PRUint32 index, nsIDOMWindow **_retval) { return _to Item(index, _retval); } \
 68  NS_SCRIPTABLE NS_IMETHOD NamedItem(const nsAString & name, nsIDOMWindow **_retval) { return _to NamedItem(name, _retval); } 
 69
 70/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
 71#define NS_FORWARD_SAFE_NSIDOMWINDOWCOLLECTION(_to) \
 72  NS_SCRIPTABLE NS_IMETHOD GetLength(PRUint32 *aLength) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetLength(aLength); } \
 73  NS_SCRIPTABLE NS_IMETHOD Item(PRUint32 index, nsIDOMWindow **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->Item(index, _retval); } \
 74  NS_SCRIPTABLE NS_IMETHOD NamedItem(const nsAString & name, nsIDOMWindow **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->NamedItem(name, _retval); } 
 75
 76#if 0
 77/* Use the code below as a template for the implementation class for this interface. */
 78
 79/* Header file */
 80class nsDOMWindowCollection : public nsIDOMWindowCollection
 81{
 82public:
 83  NS_DECL_ISUPPORTS
 84  NS_DECL_NSIDOMWINDOWCOLLECTION
 85
 86  nsDOMWindowCollection();
 87
 88private:
 89  ~nsDOMWindowCollection();
 90
 91protected:
 92  /* additional members */
 93};
 94
 95/* Implementation file */
 96NS_IMPL_ISUPPORTS1(nsDOMWindowCollection, nsIDOMWindowCollection)
 97
 98nsDOMWindowCollection::nsDOMWindowCollection()
 99{
100  /* member initializers and constructor code */
101}
102
103nsDOMWindowCollection::~nsDOMWindowCollection()
104{
105  /* destructor code */
106}
107
108/* readonly attribute unsigned long length; */
109NS_IMETHODIMP nsDOMWindowCollection::GetLength(PRUint32 *aLength)
110{
111    return NS_ERROR_NOT_IMPLEMENTED;
112}
113
114/* nsIDOMWindow item (in unsigned long index); */
115NS_IMETHODIMP nsDOMWindowCollection::Item(PRUint32 index, nsIDOMWindow **_retval)
116{
117    return NS_ERROR_NOT_IMPLEMENTED;
118}
119
120/* nsIDOMWindow namedItem (in DOMString name); */
121NS_IMETHODIMP nsDOMWindowCollection::NamedItem(const nsAString & name, nsIDOMWindow **_retval)
122{
123    return NS_ERROR_NOT_IMPLEMENTED;
124}
125
126/* End of implementation class template. */
127#endif
128
129
130#endif /* __gen_nsIDOMWindowCollection_h__ */