/gecko_api/include/nsIDOMHTMLDocument.h
C Header | 304 lines | 192 code | 56 blank | 56 comment | 0 complexity | fe0d31258ea7a95b2b1910c1ee321211 MD5 | raw file
1/* 2 * DO NOT EDIT. THIS FILE IS GENERATED FROM /builds/tinderbox/XR-Trunk/Darwin_8.8.4_Depend/mozilla/dom/public/idl/html/nsIDOMHTMLDocument.idl 3 */ 4 5#ifndef __gen_nsIDOMHTMLDocument_h__ 6#define __gen_nsIDOMHTMLDocument_h__ 7 8 9#ifndef __gen_nsIDOMDocument_h__ 10#include "nsIDOMDocument.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: nsIDOMHTMLDocument */ 19#define NS_IDOMHTMLDOCUMENT_IID_STR "a6cf9084-15b3-11d2-932e-00805f8add32" 20 21#define NS_IDOMHTMLDOCUMENT_IID \ 22 {0xa6cf9084, 0x15b3, 0x11d2, \ 23 { 0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32 }} 24 25/** 26 * The nsIDOMHTMLDocument interface is the interface to a [X]HTML 27 * document object. 28 * 29 * For more information on this interface please see 30 * http://www.w3.org/TR/DOM-Level-2-HTML/ 31 * 32 * @status FROZEN 33 */ 34class NS_NO_VTABLE NS_SCRIPTABLE nsIDOMHTMLDocument : public nsIDOMDocument { 35 public: 36 37 NS_DECLARE_STATIC_IID_ACCESSOR(NS_IDOMHTMLDOCUMENT_IID) 38 39 /* attribute DOMString title; */ 40 NS_SCRIPTABLE NS_IMETHOD GetTitle(nsAString & aTitle) = 0; 41 NS_SCRIPTABLE NS_IMETHOD SetTitle(const nsAString & aTitle) = 0; 42 43 /* readonly attribute DOMString referrer; */ 44 NS_SCRIPTABLE NS_IMETHOD GetReferrer(nsAString & aReferrer) = 0; 45 46 /* [noscript] readonly attribute DOMString domain; */ 47 NS_IMETHOD GetDomain(nsAString & aDomain) = 0; 48 49 /* readonly attribute DOMString URL; */ 50 NS_SCRIPTABLE NS_IMETHOD GetURL(nsAString & aURL) = 0; 51 52 /* attribute nsIDOMHTMLElement body; */ 53 NS_SCRIPTABLE NS_IMETHOD GetBody(nsIDOMHTMLElement * *aBody) = 0; 54 NS_SCRIPTABLE NS_IMETHOD SetBody(nsIDOMHTMLElement * aBody) = 0; 55 56 /* readonly attribute nsIDOMHTMLCollection images; */ 57 NS_SCRIPTABLE NS_IMETHOD GetImages(nsIDOMHTMLCollection * *aImages) = 0; 58 59 /* readonly attribute nsIDOMHTMLCollection applets; */ 60 NS_SCRIPTABLE NS_IMETHOD GetApplets(nsIDOMHTMLCollection * *aApplets) = 0; 61 62 /* readonly attribute nsIDOMHTMLCollection links; */ 63 NS_SCRIPTABLE NS_IMETHOD GetLinks(nsIDOMHTMLCollection * *aLinks) = 0; 64 65 /* readonly attribute nsIDOMHTMLCollection forms; */ 66 NS_SCRIPTABLE NS_IMETHOD GetForms(nsIDOMHTMLCollection * *aForms) = 0; 67 68 /* readonly attribute nsIDOMHTMLCollection anchors; */ 69 NS_SCRIPTABLE NS_IMETHOD GetAnchors(nsIDOMHTMLCollection * *aAnchors) = 0; 70 71 /* attribute DOMString cookie; */ 72 NS_SCRIPTABLE NS_IMETHOD GetCookie(nsAString & aCookie) = 0; 73 NS_SCRIPTABLE NS_IMETHOD SetCookie(const nsAString & aCookie) = 0; 74 75 /* [noscript] void open (); */ 76 NS_IMETHOD Open(void) = 0; 77 78 /* void close (); */ 79 NS_SCRIPTABLE NS_IMETHOD Close(void) = 0; 80 81 /* [noscript] void write (in DOMString text); */ 82 NS_IMETHOD Write(const nsAString & text) = 0; 83 84 /* [noscript] void writeln (in DOMString text); */ 85 NS_IMETHOD Writeln(const nsAString & text) = 0; 86 87 /* nsIDOMNodeList getElementsByName (in DOMString elementName); */ 88 NS_SCRIPTABLE NS_IMETHOD GetElementsByName(const nsAString & elementName, nsIDOMNodeList **_retval) = 0; 89 90}; 91 92 NS_DEFINE_STATIC_IID_ACCESSOR(nsIDOMHTMLDocument, NS_IDOMHTMLDOCUMENT_IID) 93 94/* Use this macro when declaring classes that implement this interface. */ 95#define NS_DECL_NSIDOMHTMLDOCUMENT \ 96 NS_SCRIPTABLE NS_IMETHOD GetTitle(nsAString & aTitle); \ 97 NS_SCRIPTABLE NS_IMETHOD SetTitle(const nsAString & aTitle); \ 98 NS_SCRIPTABLE NS_IMETHOD GetReferrer(nsAString & aReferrer); \ 99 NS_IMETHOD GetDomain(nsAString & aDomain); \ 100 NS_SCRIPTABLE NS_IMETHOD GetURL(nsAString & aURL); \ 101 NS_SCRIPTABLE NS_IMETHOD GetBody(nsIDOMHTMLElement * *aBody); \ 102 NS_SCRIPTABLE NS_IMETHOD SetBody(nsIDOMHTMLElement * aBody); \ 103 NS_SCRIPTABLE NS_IMETHOD GetImages(nsIDOMHTMLCollection * *aImages); \ 104 NS_SCRIPTABLE NS_IMETHOD GetApplets(nsIDOMHTMLCollection * *aApplets); \ 105 NS_SCRIPTABLE NS_IMETHOD GetLinks(nsIDOMHTMLCollection * *aLinks); \ 106 NS_SCRIPTABLE NS_IMETHOD GetForms(nsIDOMHTMLCollection * *aForms); \ 107 NS_SCRIPTABLE NS_IMETHOD GetAnchors(nsIDOMHTMLCollection * *aAnchors); \ 108 NS_SCRIPTABLE NS_IMETHOD GetCookie(nsAString & aCookie); \ 109 NS_SCRIPTABLE NS_IMETHOD SetCookie(const nsAString & aCookie); \ 110 NS_IMETHOD Open(void); \ 111 NS_SCRIPTABLE NS_IMETHOD Close(void); \ 112 NS_IMETHOD Write(const nsAString & text); \ 113 NS_IMETHOD Writeln(const nsAString & text); \ 114 NS_SCRIPTABLE NS_IMETHOD GetElementsByName(const nsAString & elementName, nsIDOMNodeList **_retval); 115 116/* Use this macro to declare functions that forward the behavior of this interface to another object. */ 117#define NS_FORWARD_NSIDOMHTMLDOCUMENT(_to) \ 118 NS_SCRIPTABLE NS_IMETHOD GetTitle(nsAString & aTitle) { return _to GetTitle(aTitle); } \ 119 NS_SCRIPTABLE NS_IMETHOD SetTitle(const nsAString & aTitle) { return _to SetTitle(aTitle); } \ 120 NS_SCRIPTABLE NS_IMETHOD GetReferrer(nsAString & aReferrer) { return _to GetReferrer(aReferrer); } \ 121 NS_IMETHOD GetDomain(nsAString & aDomain) { return _to GetDomain(aDomain); } \ 122 NS_SCRIPTABLE NS_IMETHOD GetURL(nsAString & aURL) { return _to GetURL(aURL); } \ 123 NS_SCRIPTABLE NS_IMETHOD GetBody(nsIDOMHTMLElement * *aBody) { return _to GetBody(aBody); } \ 124 NS_SCRIPTABLE NS_IMETHOD SetBody(nsIDOMHTMLElement * aBody) { return _to SetBody(aBody); } \ 125 NS_SCRIPTABLE NS_IMETHOD GetImages(nsIDOMHTMLCollection * *aImages) { return _to GetImages(aImages); } \ 126 NS_SCRIPTABLE NS_IMETHOD GetApplets(nsIDOMHTMLCollection * *aApplets) { return _to GetApplets(aApplets); } \ 127 NS_SCRIPTABLE NS_IMETHOD GetLinks(nsIDOMHTMLCollection * *aLinks) { return _to GetLinks(aLinks); } \ 128 NS_SCRIPTABLE NS_IMETHOD GetForms(nsIDOMHTMLCollection * *aForms) { return _to GetForms(aForms); } \ 129 NS_SCRIPTABLE NS_IMETHOD GetAnchors(nsIDOMHTMLCollection * *aAnchors) { return _to GetAnchors(aAnchors); } \ 130 NS_SCRIPTABLE NS_IMETHOD GetCookie(nsAString & aCookie) { return _to GetCookie(aCookie); } \ 131 NS_SCRIPTABLE NS_IMETHOD SetCookie(const nsAString & aCookie) { return _to SetCookie(aCookie); } \ 132 NS_IMETHOD Open(void) { return _to Open(); } \ 133 NS_SCRIPTABLE NS_IMETHOD Close(void) { return _to Close(); } \ 134 NS_IMETHOD Write(const nsAString & text) { return _to Write(text); } \ 135 NS_IMETHOD Writeln(const nsAString & text) { return _to Writeln(text); } \ 136 NS_SCRIPTABLE NS_IMETHOD GetElementsByName(const nsAString & elementName, nsIDOMNodeList **_retval) { return _to GetElementsByName(elementName, _retval); } 137 138/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */ 139#define NS_FORWARD_SAFE_NSIDOMHTMLDOCUMENT(_to) \ 140 NS_SCRIPTABLE NS_IMETHOD GetTitle(nsAString & aTitle) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetTitle(aTitle); } \ 141 NS_SCRIPTABLE NS_IMETHOD SetTitle(const nsAString & aTitle) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetTitle(aTitle); } \ 142 NS_SCRIPTABLE NS_IMETHOD GetReferrer(nsAString & aReferrer) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetReferrer(aReferrer); } \ 143 NS_IMETHOD GetDomain(nsAString & aDomain) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDomain(aDomain); } \ 144 NS_SCRIPTABLE NS_IMETHOD GetURL(nsAString & aURL) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetURL(aURL); } \ 145 NS_SCRIPTABLE NS_IMETHOD GetBody(nsIDOMHTMLElement * *aBody) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetBody(aBody); } \ 146 NS_SCRIPTABLE NS_IMETHOD SetBody(nsIDOMHTMLElement * aBody) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetBody(aBody); } \ 147 NS_SCRIPTABLE NS_IMETHOD GetImages(nsIDOMHTMLCollection * *aImages) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetImages(aImages); } \ 148 NS_SCRIPTABLE NS_IMETHOD GetApplets(nsIDOMHTMLCollection * *aApplets) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetApplets(aApplets); } \ 149 NS_SCRIPTABLE NS_IMETHOD GetLinks(nsIDOMHTMLCollection * *aLinks) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetLinks(aLinks); } \ 150 NS_SCRIPTABLE NS_IMETHOD GetForms(nsIDOMHTMLCollection * *aForms) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetForms(aForms); } \ 151 NS_SCRIPTABLE NS_IMETHOD GetAnchors(nsIDOMHTMLCollection * *aAnchors) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAnchors(aAnchors); } \ 152 NS_SCRIPTABLE NS_IMETHOD GetCookie(nsAString & aCookie) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCookie(aCookie); } \ 153 NS_SCRIPTABLE NS_IMETHOD SetCookie(const nsAString & aCookie) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetCookie(aCookie); } \ 154 NS_IMETHOD Open(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->Open(); } \ 155 NS_SCRIPTABLE NS_IMETHOD Close(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->Close(); } \ 156 NS_IMETHOD Write(const nsAString & text) { return !_to ? NS_ERROR_NULL_POINTER : _to->Write(text); } \ 157 NS_IMETHOD Writeln(const nsAString & text) { return !_to ? NS_ERROR_NULL_POINTER : _to->Writeln(text); } \ 158 NS_SCRIPTABLE NS_IMETHOD GetElementsByName(const nsAString & elementName, nsIDOMNodeList **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetElementsByName(elementName, _retval); } 159 160#if 0 161/* Use the code below as a template for the implementation class for this interface. */ 162 163/* Header file */ 164class nsDOMHTMLDocument : public nsIDOMHTMLDocument 165{ 166public: 167 NS_DECL_ISUPPORTS 168 NS_DECL_NSIDOMHTMLDOCUMENT 169 170 nsDOMHTMLDocument(); 171 172private: 173 ~nsDOMHTMLDocument(); 174 175protected: 176 /* additional members */ 177}; 178 179/* Implementation file */ 180NS_IMPL_ISUPPORTS1(nsDOMHTMLDocument, nsIDOMHTMLDocument) 181 182nsDOMHTMLDocument::nsDOMHTMLDocument() 183{ 184 /* member initializers and constructor code */ 185} 186 187nsDOMHTMLDocument::~nsDOMHTMLDocument() 188{ 189 /* destructor code */ 190} 191 192/* attribute DOMString title; */ 193NS_IMETHODIMP nsDOMHTMLDocument::GetTitle(nsAString & aTitle) 194{ 195 return NS_ERROR_NOT_IMPLEMENTED; 196} 197NS_IMETHODIMP nsDOMHTMLDocument::SetTitle(const nsAString & aTitle) 198{ 199 return NS_ERROR_NOT_IMPLEMENTED; 200} 201 202/* readonly attribute DOMString referrer; */ 203NS_IMETHODIMP nsDOMHTMLDocument::GetReferrer(nsAString & aReferrer) 204{ 205 return NS_ERROR_NOT_IMPLEMENTED; 206} 207 208/* [noscript] readonly attribute DOMString domain; */ 209NS_IMETHODIMP nsDOMHTMLDocument::GetDomain(nsAString & aDomain) 210{ 211 return NS_ERROR_NOT_IMPLEMENTED; 212} 213 214/* readonly attribute DOMString URL; */ 215NS_IMETHODIMP nsDOMHTMLDocument::GetURL(nsAString & aURL) 216{ 217 return NS_ERROR_NOT_IMPLEMENTED; 218} 219 220/* attribute nsIDOMHTMLElement body; */ 221NS_IMETHODIMP nsDOMHTMLDocument::GetBody(nsIDOMHTMLElement * *aBody) 222{ 223 return NS_ERROR_NOT_IMPLEMENTED; 224} 225NS_IMETHODIMP nsDOMHTMLDocument::SetBody(nsIDOMHTMLElement * aBody) 226{ 227 return NS_ERROR_NOT_IMPLEMENTED; 228} 229 230/* readonly attribute nsIDOMHTMLCollection images; */ 231NS_IMETHODIMP nsDOMHTMLDocument::GetImages(nsIDOMHTMLCollection * *aImages) 232{ 233 return NS_ERROR_NOT_IMPLEMENTED; 234} 235 236/* readonly attribute nsIDOMHTMLCollection applets; */ 237NS_IMETHODIMP nsDOMHTMLDocument::GetApplets(nsIDOMHTMLCollection * *aApplets) 238{ 239 return NS_ERROR_NOT_IMPLEMENTED; 240} 241 242/* readonly attribute nsIDOMHTMLCollection links; */ 243NS_IMETHODIMP nsDOMHTMLDocument::GetLinks(nsIDOMHTMLCollection * *aLinks) 244{ 245 return NS_ERROR_NOT_IMPLEMENTED; 246} 247 248/* readonly attribute nsIDOMHTMLCollection forms; */ 249NS_IMETHODIMP nsDOMHTMLDocument::GetForms(nsIDOMHTMLCollection * *aForms) 250{ 251 return NS_ERROR_NOT_IMPLEMENTED; 252} 253 254/* readonly attribute nsIDOMHTMLCollection anchors; */ 255NS_IMETHODIMP nsDOMHTMLDocument::GetAnchors(nsIDOMHTMLCollection * *aAnchors) 256{ 257 return NS_ERROR_NOT_IMPLEMENTED; 258} 259 260/* attribute DOMString cookie; */ 261NS_IMETHODIMP nsDOMHTMLDocument::GetCookie(nsAString & aCookie) 262{ 263 return NS_ERROR_NOT_IMPLEMENTED; 264} 265NS_IMETHODIMP nsDOMHTMLDocument::SetCookie(const nsAString & aCookie) 266{ 267 return NS_ERROR_NOT_IMPLEMENTED; 268} 269 270/* [noscript] void open (); */ 271NS_IMETHODIMP nsDOMHTMLDocument::Open() 272{ 273 return NS_ERROR_NOT_IMPLEMENTED; 274} 275 276/* void close (); */ 277NS_IMETHODIMP nsDOMHTMLDocument::Close() 278{ 279 return NS_ERROR_NOT_IMPLEMENTED; 280} 281 282/* [noscript] void write (in DOMString text); */ 283NS_IMETHODIMP nsDOMHTMLDocument::Write(const nsAString & text) 284{ 285 return NS_ERROR_NOT_IMPLEMENTED; 286} 287 288/* [noscript] void writeln (in DOMString text); */ 289NS_IMETHODIMP nsDOMHTMLDocument::Writeln(const nsAString & text) 290{ 291 return NS_ERROR_NOT_IMPLEMENTED; 292} 293 294/* nsIDOMNodeList getElementsByName (in DOMString elementName); */ 295NS_IMETHODIMP nsDOMHTMLDocument::GetElementsByName(const nsAString & elementName, nsIDOMNodeList **_retval) 296{ 297 return NS_ERROR_NOT_IMPLEMENTED; 298} 299 300/* End of implementation class template. */ 301#endif 302 303 304#endif /* __gen_nsIDOMHTMLDocument_h__ */