Version 1.8 of gecko-sdk. Downloaded from here:...

gecko-sdk/include/nsIDOMWindowUtils.h

+/*
+ * DO NOT EDIT.  THIS FILE IS GENERATED FROM c:/builds/tinderbox/XR-Mozilla1.8.0-Release/WINNT_5.2_Depend/mozilla/dom/public/idl/base/nsIDOMWindowUtils.idl
+ */
+
+#ifndef __gen_nsIDOMWindowUtils_h__
+#define __gen_nsIDOMWindowUtils_h__
+
+
+#ifndef __gen_nsISupports_h__
+#include "nsISupports.h"
+#endif
+
+/* For IDL files that don't want to include root IDL files. */
+#ifndef NS_NO_VTABLE
+#define NS_NO_VTABLE
+#endif
+
+/* starting interface:    nsIDOMWindowUtils */
+#define NS_IDOMWINDOWUTILS_IID_STR "8a157a4f-a81e-489f-baf2-bc8970d60472"
+
+#define NS_IDOMWINDOWUTILS_IID \
+  {0x8a157a4f, 0xa81e, 0x489f, \
+    { 0xba, 0xf2, 0xbc, 0x89, 0x70, 0xd6, 0x04, 0x72 }}
+
+/**
+ * nsIDOMWindowUtils is intended for giving privileged script access to
+ * additional properties and methods of nsIDOMWindow unavailable to
+ * content script. Access this interface by calling getInterface on a DOMWindow.
+ */
+class NS_NO_VTABLE nsIDOMWindowUtils : public nsISupports {
+ public: 
+
+  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IDOMWINDOWUTILS_IID)
+
+  /**
+   * Image animation mode of the window. When this attribute's value
+   * is changed, the implementation should set all images in the window
+   * to the given value. That is, when set to kDontAnimMode, all images
+   * will stop animating. The attribute's value must be one of the
+   * animationMode values from imgIContainer.
+   * @note Images may individually override the window's setting after
+   *       the window's mode is set. Therefore images given different modes
+   *       since the last setting of the window's mode may behave
+   *       out of line with the window's overall mode.
+   * @note The attribute's value is the window's overall mode. It may
+   *       for example continue to report kDontAnimMode after all images
+   *       have subsequently been individually animated.
+   * @note Only images immediately in this window are affected;
+   *       this is not recursive to subwindows.
+   * @see imgIContainer
+   */
+  /* attribute unsigned short imageAnimationMode; */
+  NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode) = 0;
+  NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode) = 0;
+
+  /**
+   * Function to get metadata associated with the window's current document
+   * @param aName the name of the metadata.  This should be all lowercase.
+   * @return the value of the metadata, or the empty string if it's not set
+   */
+  /* AString getDocumentMetadata (in AString aName); */
+  NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval) = 0;
+
+};
+
+/* Use this macro when declaring classes that implement this interface. */
+#define NS_DECL_NSIDOMWINDOWUTILS \
+  NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode); \
+  NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode); \
+  NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval); 
+
+/* Use this macro to declare functions that forward the behavior of this interface to another object. */
+#define NS_FORWARD_NSIDOMWINDOWUTILS(_to) \
+  NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode) { return _to GetImageAnimationMode(aImageAnimationMode); } \
+  NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode) { return _to SetImageAnimationMode(aImageAnimationMode); } \
+  NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval) { return _to GetDocumentMetadata(aName, _retval); } 
+
+/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
+#define NS_FORWARD_SAFE_NSIDOMWINDOWUTILS(_to) \
+  NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetImageAnimationMode(aImageAnimationMode); } \
+  NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetImageAnimationMode(aImageAnimationMode); } \
+  NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDocumentMetadata(aName, _retval); } 
+
+#if 0
+/* Use the code below as a template for the implementation class for this interface. */
+
+/* Header file */
+class nsDOMWindowUtils : public nsIDOMWindowUtils
+{
+public:
+  NS_DECL_ISUPPORTS
+  NS_DECL_NSIDOMWINDOWUTILS
+
+  nsDOMWindowUtils();
+
+private:
+  ~nsDOMWindowUtils();
+
+protected:
+  /* additional members */
+};
+
+/* Implementation file */
+NS_IMPL_ISUPPORTS1(nsDOMWindowUtils, nsIDOMWindowUtils)
+
+nsDOMWindowUtils::nsDOMWindowUtils()
+{
+  /* member initializers and constructor code */
+}
+
+nsDOMWindowUtils::~nsDOMWindowUtils()
+{
+  /* destructor code */
+}
+
+/* attribute unsigned short imageAnimationMode; */
+NS_IMETHODIMP nsDOMWindowUtils::GetImageAnimationMode(PRUint16 *aImageAnimationMode)
+{
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+NS_IMETHODIMP nsDOMWindowUtils::SetImageAnimationMode(PRUint16 aImageAnimationMode)
+{
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+/* AString getDocumentMetadata (in AString aName); */
+NS_IMETHODIMP nsDOMWindowUtils::GetDocumentMetadata(const nsAString & aName, nsAString & _retval)
+{
+    return NS_ERROR_NOT_IMPLEMENTED;
+}
+
+/* End of implementation class template. */
+#endif
+
+
+#endif /* __gen_nsIDOMWindowUtils_h__ */