/gecko_api/include/nsIDOMHTMLDocument.h

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