/gecko_api/include/nsIDOMWindowUtils.h
C Header | 296 lines | 121 code | 43 blank | 132 comment | 0 complexity | 23f8ed7ec35c8a9e2ad2178d39ffb27f MD5 | raw file
- /*
- * DO NOT EDIT. THIS FILE IS GENERATED FROM /builds/tinderbox/XR-Trunk/Darwin_8.8.4_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
- class nsIDOMElement; /* forward declaration */
- /* starting interface: nsIDOMWindowUtils */
- #define NS_IDOMWINDOWUTILS_IID_STR "1cfc1a0a-e348-4b18-b61b-935c192f85c4"
- #define NS_IDOMWINDOWUTILS_IID \
- {0x1cfc1a0a, 0xe348, 0x4b18, \
- { 0xb6, 0x1b, 0x93, 0x5c, 0x19, 0x2f, 0x85, 0xc4 }}
- class NS_NO_VTABLE NS_SCRIPTABLE nsIDOMWindowUtils : public nsISupports {
- public:
- NS_DECLARE_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_SCRIPTABLE NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode) = 0;
- NS_SCRIPTABLE NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode) = 0;
- /**
- * Whether the charset of the window's current document has been forced by
- * the user.
- * Cannot be accessed from unprivileged context (not content-accessible)
- */
- /* readonly attribute boolean docCharsetIsForced; */
- NS_SCRIPTABLE NS_IMETHOD GetDocCharsetIsForced(PRBool *aDocCharsetIsForced) = 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
- *
- * Will throw a DOM security error if called without UniversalXPConnect
- * privileges.
- */
- /* AString getDocumentMetadata (in AString aName); */
- NS_SCRIPTABLE NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval) = 0;
- /**
- * Force an immediate redraw of this window.
- */
- /* void redraw (); */
- NS_SCRIPTABLE NS_IMETHOD Redraw(void) = 0;
- /** Synthesize a mouse event for a window. The event types supported
- * are:
- * mousedown, mouseup, mousemove, mouseover, mouseout, contextmenu
- *
- * Events are sent in coordinates offset by aX and aY from the window.
- *
- * Note that additional events may be fired as a result of this call. For
- * instance, typically a click event will be fired as a result of a
- * mousedown and mouseup in sequence.
- *
- * Normally at this level of events, the mouseover and mouseout events are
- * only fired when the window is entered or exited. For inter-element
- * mouseover and mouseout events, a movemove event fired on the new element
- * should be sufficient to generate the correct over and out events as well.
- *
- * Cannot be accessed from unprivileged context (not content-accessible)
- * Will throw a DOM security error if called without UniversalXPConnect
- * privileges.
- *
- * @param aType event type
- * @param aX x offset
- * @param aY y offset
- * @param aButton button to synthesize
- * @param aClickCount number of clicks that have been performed
- * @param aModifiers modifiers pressed, using constants defined in nsIDOMNSEvent
- */
- /* void sendMouseEvent (in AString aType, in long aX, in long aY, in long aButton, in long aClickCount, in long aModifiers); */
- NS_SCRIPTABLE NS_IMETHOD SendMouseEvent(const nsAString & aType, PRInt32 aX, PRInt32 aY, PRInt32 aButton, PRInt32 aClickCount, PRInt32 aModifiers) = 0;
- /**
- * Synthesize a key event to the window. The event types supported are:
- * keydown, keyup, keypress
- *
- * Key events generally end up being sent to the focused node.
- *
- * Cannot be accessed from unprivileged context (not content-accessible)
- * Will throw a DOM security error if called without UniversalXPConnect
- * privileges.
- *
- * @param aType event type
- * @param aKeyCode key code
- * @param aCharCode character code
- * @param aModifiers modifiers pressed, using constants defined in nsIDOMNSEvent
- */
- /* void sendKeyEvent (in AString aType, in long aKeyCode, in long aCharCode, in long aModifiers); */
- NS_SCRIPTABLE NS_IMETHOD SendKeyEvent(const nsAString & aType, PRInt32 aKeyCode, PRInt32 aCharCode, PRInt32 aModifiers) = 0;
- /**
- * See nsIWidget::SynthesizeNativeKeyEvent
- *
- * Cannot be accessed from unprivileged context (not content-accessible)
- * Will throw a DOM security error if called without UniversalXPConnect
- * privileges.
- */
- /* void sendNativeKeyEvent (in long aNativeKeyboardLayout, in long aNativeKeyCode, in long aModifierFlags, in AString aCharacters, in AString aUnmodifiedCharacters); */
- NS_SCRIPTABLE NS_IMETHOD SendNativeKeyEvent(PRInt32 aNativeKeyboardLayout, PRInt32 aNativeKeyCode, PRInt32 aModifierFlags, const nsAString & aCharacters, const nsAString & aUnmodifiedCharacters) = 0;
- /**
- * Focus the element aElement. The element should be in the same document
- * that the window is displaying. Pass null to blur the element, if any,
- * that currently has focus, and focus the document.
- *
- * Cannot be accessed from unprivileged context (not content-accessible)
- * Will throw a DOM security error if called without UniversalXPConnect
- * privileges.
- *
- * @param aElement the element to focus
- */
- /* void focus (in nsIDOMElement aElement); */
- NS_SCRIPTABLE NS_IMETHOD Focus(nsIDOMElement *aElement) = 0;
- /**
- * Force a garbage collection. This will run the cycle-collector twice to
- * make sure all garbage is collected.
- *
- * Will throw a DOM security error if called without UniversalXPConnect
- * privileges in non-debug builds. Available to all callers in debug builds.
- */
- /* void garbageCollect (); */
- NS_SCRIPTABLE NS_IMETHOD GarbageCollect(void) = 0;
- };
- NS_DEFINE_STATIC_IID_ACCESSOR(nsIDOMWindowUtils, NS_IDOMWINDOWUTILS_IID)
- /* Use this macro when declaring classes that implement this interface. */
- #define NS_DECL_NSIDOMWINDOWUTILS \
- NS_SCRIPTABLE NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode); \
- NS_SCRIPTABLE NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode); \
- NS_SCRIPTABLE NS_IMETHOD GetDocCharsetIsForced(PRBool *aDocCharsetIsForced); \
- NS_SCRIPTABLE NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval); \
- NS_SCRIPTABLE NS_IMETHOD Redraw(void); \
- NS_SCRIPTABLE NS_IMETHOD SendMouseEvent(const nsAString & aType, PRInt32 aX, PRInt32 aY, PRInt32 aButton, PRInt32 aClickCount, PRInt32 aModifiers); \
- NS_SCRIPTABLE NS_IMETHOD SendKeyEvent(const nsAString & aType, PRInt32 aKeyCode, PRInt32 aCharCode, PRInt32 aModifiers); \
- NS_SCRIPTABLE NS_IMETHOD SendNativeKeyEvent(PRInt32 aNativeKeyboardLayout, PRInt32 aNativeKeyCode, PRInt32 aModifierFlags, const nsAString & aCharacters, const nsAString & aUnmodifiedCharacters); \
- NS_SCRIPTABLE NS_IMETHOD Focus(nsIDOMElement *aElement); \
- NS_SCRIPTABLE NS_IMETHOD GarbageCollect(void);
- /* Use this macro to declare functions that forward the behavior of this interface to another object. */
- #define NS_FORWARD_NSIDOMWINDOWUTILS(_to) \
- NS_SCRIPTABLE NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode) { return _to GetImageAnimationMode(aImageAnimationMode); } \
- NS_SCRIPTABLE NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode) { return _to SetImageAnimationMode(aImageAnimationMode); } \
- NS_SCRIPTABLE NS_IMETHOD GetDocCharsetIsForced(PRBool *aDocCharsetIsForced) { return _to GetDocCharsetIsForced(aDocCharsetIsForced); } \
- NS_SCRIPTABLE NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval) { return _to GetDocumentMetadata(aName, _retval); } \
- NS_SCRIPTABLE NS_IMETHOD Redraw(void) { return _to Redraw(); } \
- NS_SCRIPTABLE NS_IMETHOD SendMouseEvent(const nsAString & aType, PRInt32 aX, PRInt32 aY, PRInt32 aButton, PRInt32 aClickCount, PRInt32 aModifiers) { return _to SendMouseEvent(aType, aX, aY, aButton, aClickCount, aModifiers); } \
- NS_SCRIPTABLE NS_IMETHOD SendKeyEvent(const nsAString & aType, PRInt32 aKeyCode, PRInt32 aCharCode, PRInt32 aModifiers) { return _to SendKeyEvent(aType, aKeyCode, aCharCode, aModifiers); } \
- NS_SCRIPTABLE NS_IMETHOD SendNativeKeyEvent(PRInt32 aNativeKeyboardLayout, PRInt32 aNativeKeyCode, PRInt32 aModifierFlags, const nsAString & aCharacters, const nsAString & aUnmodifiedCharacters) { return _to SendNativeKeyEvent(aNativeKeyboardLayout, aNativeKeyCode, aModifierFlags, aCharacters, aUnmodifiedCharacters); } \
- NS_SCRIPTABLE NS_IMETHOD Focus(nsIDOMElement *aElement) { return _to Focus(aElement); } \
- NS_SCRIPTABLE NS_IMETHOD GarbageCollect(void) { return _to GarbageCollect(); }
- /* 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_SCRIPTABLE NS_IMETHOD GetImageAnimationMode(PRUint16 *aImageAnimationMode) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetImageAnimationMode(aImageAnimationMode); } \
- NS_SCRIPTABLE NS_IMETHOD SetImageAnimationMode(PRUint16 aImageAnimationMode) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetImageAnimationMode(aImageAnimationMode); } \
- NS_SCRIPTABLE NS_IMETHOD GetDocCharsetIsForced(PRBool *aDocCharsetIsForced) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDocCharsetIsForced(aDocCharsetIsForced); } \
- NS_SCRIPTABLE NS_IMETHOD GetDocumentMetadata(const nsAString & aName, nsAString & _retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDocumentMetadata(aName, _retval); } \
- NS_SCRIPTABLE NS_IMETHOD Redraw(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->Redraw(); } \
- NS_SCRIPTABLE NS_IMETHOD SendMouseEvent(const nsAString & aType, PRInt32 aX, PRInt32 aY, PRInt32 aButton, PRInt32 aClickCount, PRInt32 aModifiers) { return !_to ? NS_ERROR_NULL_POINTER : _to->SendMouseEvent(aType, aX, aY, aButton, aClickCount, aModifiers); } \
- NS_SCRIPTABLE NS_IMETHOD SendKeyEvent(const nsAString & aType, PRInt32 aKeyCode, PRInt32 aCharCode, PRInt32 aModifiers) { return !_to ? NS_ERROR_NULL_POINTER : _to->SendKeyEvent(aType, aKeyCode, aCharCode, aModifiers); } \
- NS_SCRIPTABLE NS_IMETHOD SendNativeKeyEvent(PRInt32 aNativeKeyboardLayout, PRInt32 aNativeKeyCode, PRInt32 aModifierFlags, const nsAString & aCharacters, const nsAString & aUnmodifiedCharacters) { return !_to ? NS_ERROR_NULL_POINTER : _to->SendNativeKeyEvent(aNativeKeyboardLayout, aNativeKeyCode, aModifierFlags, aCharacters, aUnmodifiedCharacters); } \
- NS_SCRIPTABLE NS_IMETHOD Focus(nsIDOMElement *aElement) { return !_to ? NS_ERROR_NULL_POINTER : _to->Focus(aElement); } \
- NS_SCRIPTABLE NS_IMETHOD GarbageCollect(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->GarbageCollect(); }
- #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;
- }
- /* readonly attribute boolean docCharsetIsForced; */
- NS_IMETHODIMP nsDOMWindowUtils::GetDocCharsetIsForced(PRBool *aDocCharsetIsForced)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- /* AString getDocumentMetadata (in AString aName); */
- NS_IMETHODIMP nsDOMWindowUtils::GetDocumentMetadata(const nsAString & aName, nsAString & _retval)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- /* void redraw (); */
- NS_IMETHODIMP nsDOMWindowUtils::Redraw()
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- /* void sendMouseEvent (in AString aType, in long aX, in long aY, in long aButton, in long aClickCount, in long aModifiers); */
- NS_IMETHODIMP nsDOMWindowUtils::SendMouseEvent(const nsAString & aType, PRInt32 aX, PRInt32 aY, PRInt32 aButton, PRInt32 aClickCount, PRInt32 aModifiers)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- /* void sendKeyEvent (in AString aType, in long aKeyCode, in long aCharCode, in long aModifiers); */
- NS_IMETHODIMP nsDOMWindowUtils::SendKeyEvent(const nsAString & aType, PRInt32 aKeyCode, PRInt32 aCharCode, PRInt32 aModifiers)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- /* void sendNativeKeyEvent (in long aNativeKeyboardLayout, in long aNativeKeyCode, in long aModifierFlags, in AString aCharacters, in AString aUnmodifiedCharacters); */
- NS_IMETHODIMP nsDOMWindowUtils::SendNativeKeyEvent(PRInt32 aNativeKeyboardLayout, PRInt32 aNativeKeyCode, PRInt32 aModifierFlags, const nsAString & aCharacters, const nsAString & aUnmodifiedCharacters)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- /* void focus (in nsIDOMElement aElement); */
- NS_IMETHODIMP nsDOMWindowUtils::Focus(nsIDOMElement *aElement)
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- /* void garbageCollect (); */
- NS_IMETHODIMP nsDOMWindowUtils::GarbageCollect()
- {
- return NS_ERROR_NOT_IMPLEMENTED;
- }
- /* End of implementation class template. */
- #endif
- #endif /* __gen_nsIDOMWindowUtils_h__ */