/gecko_api/include/nsIDOMMouseEvent.h

  1/*
  2 * DO NOT EDIT.  THIS FILE IS GENERATED FROM /builds/tinderbox/XR-Trunk/Darwin_8.8.4_Depend/mozilla/dom/public/idl/events/nsIDOMMouseEvent.idl
  3 */
  4
  5#ifndef __gen_nsIDOMMouseEvent_h__
  6#define __gen_nsIDOMMouseEvent_h__
  7
  8
  9#ifndef __gen_nsIDOMUIEvent_h__
 10#include "nsIDOMUIEvent.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:    nsIDOMMouseEvent */
 19#define NS_IDOMMOUSEEVENT_IID_STR "ff751edc-8b02-aae7-0010-8301838a3123"
 20
 21#define NS_IDOMMOUSEEVENT_IID \
 22  {0xff751edc, 0x8b02, 0xaae7, \
 23    { 0x00, 0x10, 0x83, 0x01, 0x83, 0x8a, 0x31, 0x23 }}
 24
 25/**
 26 * The nsIDOMMouseEvent interface is the datatype for all mouse events
 27 * in the Document Object Model.
 28 *
 29 * For more information on this interface please see
 30 * http://www.w3.org/TR/DOM-Level-2-Events/
 31 *
 32 * @status FROZEN
 33 */
 34class NS_NO_VTABLE NS_SCRIPTABLE nsIDOMMouseEvent : public nsIDOMUIEvent {
 35 public: 
 36
 37  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IDOMMOUSEEVENT_IID)
 38
 39  /* readonly attribute long screenX; */
 40  NS_SCRIPTABLE NS_IMETHOD GetScreenX(PRInt32 *aScreenX) = 0;
 41
 42  /* readonly attribute long screenY; */
 43  NS_SCRIPTABLE NS_IMETHOD GetScreenY(PRInt32 *aScreenY) = 0;
 44
 45  /* readonly attribute long clientX; */
 46  NS_SCRIPTABLE NS_IMETHOD GetClientX(PRInt32 *aClientX) = 0;
 47
 48  /* readonly attribute long clientY; */
 49  NS_SCRIPTABLE NS_IMETHOD GetClientY(PRInt32 *aClientY) = 0;
 50
 51  /* readonly attribute boolean ctrlKey; */
 52  NS_SCRIPTABLE NS_IMETHOD GetCtrlKey(PRBool *aCtrlKey) = 0;
 53
 54  /* readonly attribute boolean shiftKey; */
 55  NS_SCRIPTABLE NS_IMETHOD GetShiftKey(PRBool *aShiftKey) = 0;
 56
 57  /* readonly attribute boolean altKey; */
 58  NS_SCRIPTABLE NS_IMETHOD GetAltKey(PRBool *aAltKey) = 0;
 59
 60  /* readonly attribute boolean metaKey; */
 61  NS_SCRIPTABLE NS_IMETHOD GetMetaKey(PRBool *aMetaKey) = 0;
 62
 63  /* readonly attribute unsigned short button; */
 64  NS_SCRIPTABLE NS_IMETHOD GetButton(PRUint16 *aButton) = 0;
 65
 66  /* readonly attribute nsIDOMEventTarget relatedTarget; */
 67  NS_SCRIPTABLE NS_IMETHOD GetRelatedTarget(nsIDOMEventTarget * *aRelatedTarget) = 0;
 68
 69  /* void initMouseEvent (in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in nsIDOMAbstractView viewArg, in long detailArg, in long screenXArg, in long screenYArg, in long clientXArg, in long clientYArg, in boolean ctrlKeyArg, in boolean altKeyArg, in boolean shiftKeyArg, in boolean metaKeyArg, in unsigned short buttonArg, in nsIDOMEventTarget relatedTargetArg); */
 70  NS_SCRIPTABLE NS_IMETHOD InitMouseEvent(const nsAString & typeArg, PRBool canBubbleArg, PRBool cancelableArg, nsIDOMAbstractView *viewArg, PRInt32 detailArg, PRInt32 screenXArg, PRInt32 screenYArg, PRInt32 clientXArg, PRInt32 clientYArg, PRBool ctrlKeyArg, PRBool altKeyArg, PRBool shiftKeyArg, PRBool metaKeyArg, PRUint16 buttonArg, nsIDOMEventTarget *relatedTargetArg) = 0;
 71
 72};
 73
 74  NS_DEFINE_STATIC_IID_ACCESSOR(nsIDOMMouseEvent, NS_IDOMMOUSEEVENT_IID)
 75
 76/* Use this macro when declaring classes that implement this interface. */
 77#define NS_DECL_NSIDOMMOUSEEVENT \
 78  NS_SCRIPTABLE NS_IMETHOD GetScreenX(PRInt32 *aScreenX); \
 79  NS_SCRIPTABLE NS_IMETHOD GetScreenY(PRInt32 *aScreenY); \
 80  NS_SCRIPTABLE NS_IMETHOD GetClientX(PRInt32 *aClientX); \
 81  NS_SCRIPTABLE NS_IMETHOD GetClientY(PRInt32 *aClientY); \
 82  NS_SCRIPTABLE NS_IMETHOD GetCtrlKey(PRBool *aCtrlKey); \
 83  NS_SCRIPTABLE NS_IMETHOD GetShiftKey(PRBool *aShiftKey); \
 84  NS_SCRIPTABLE NS_IMETHOD GetAltKey(PRBool *aAltKey); \
 85  NS_SCRIPTABLE NS_IMETHOD GetMetaKey(PRBool *aMetaKey); \
 86  NS_SCRIPTABLE NS_IMETHOD GetButton(PRUint16 *aButton); \
 87  NS_SCRIPTABLE NS_IMETHOD GetRelatedTarget(nsIDOMEventTarget * *aRelatedTarget); \
 88  NS_SCRIPTABLE NS_IMETHOD InitMouseEvent(const nsAString & typeArg, PRBool canBubbleArg, PRBool cancelableArg, nsIDOMAbstractView *viewArg, PRInt32 detailArg, PRInt32 screenXArg, PRInt32 screenYArg, PRInt32 clientXArg, PRInt32 clientYArg, PRBool ctrlKeyArg, PRBool altKeyArg, PRBool shiftKeyArg, PRBool metaKeyArg, PRUint16 buttonArg, nsIDOMEventTarget *relatedTargetArg); 
 89
 90/* Use this macro to declare functions that forward the behavior of this interface to another object. */
 91#define NS_FORWARD_NSIDOMMOUSEEVENT(_to) \
 92  NS_SCRIPTABLE NS_IMETHOD GetScreenX(PRInt32 *aScreenX) { return _to GetScreenX(aScreenX); } \
 93  NS_SCRIPTABLE NS_IMETHOD GetScreenY(PRInt32 *aScreenY) { return _to GetScreenY(aScreenY); } \
 94  NS_SCRIPTABLE NS_IMETHOD GetClientX(PRInt32 *aClientX) { return _to GetClientX(aClientX); } \
 95  NS_SCRIPTABLE NS_IMETHOD GetClientY(PRInt32 *aClientY) { return _to GetClientY(aClientY); } \
 96  NS_SCRIPTABLE NS_IMETHOD GetCtrlKey(PRBool *aCtrlKey) { return _to GetCtrlKey(aCtrlKey); } \
 97  NS_SCRIPTABLE NS_IMETHOD GetShiftKey(PRBool *aShiftKey) { return _to GetShiftKey(aShiftKey); } \
 98  NS_SCRIPTABLE NS_IMETHOD GetAltKey(PRBool *aAltKey) { return _to GetAltKey(aAltKey); } \
 99  NS_SCRIPTABLE NS_IMETHOD GetMetaKey(PRBool *aMetaKey) { return _to GetMetaKey(aMetaKey); } \
100  NS_SCRIPTABLE NS_IMETHOD GetButton(PRUint16 *aButton) { return _to GetButton(aButton); } \
101  NS_SCRIPTABLE NS_IMETHOD GetRelatedTarget(nsIDOMEventTarget * *aRelatedTarget) { return _to GetRelatedTarget(aRelatedTarget); } \
102  NS_SCRIPTABLE NS_IMETHOD InitMouseEvent(const nsAString & typeArg, PRBool canBubbleArg, PRBool cancelableArg, nsIDOMAbstractView *viewArg, PRInt32 detailArg, PRInt32 screenXArg, PRInt32 screenYArg, PRInt32 clientXArg, PRInt32 clientYArg, PRBool ctrlKeyArg, PRBool altKeyArg, PRBool shiftKeyArg, PRBool metaKeyArg, PRUint16 buttonArg, nsIDOMEventTarget *relatedTargetArg) { return _to InitMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg); } 
103
104/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
105#define NS_FORWARD_SAFE_NSIDOMMOUSEEVENT(_to) \
106  NS_SCRIPTABLE NS_IMETHOD GetScreenX(PRInt32 *aScreenX) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetScreenX(aScreenX); } \
107  NS_SCRIPTABLE NS_IMETHOD GetScreenY(PRInt32 *aScreenY) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetScreenY(aScreenY); } \
108  NS_SCRIPTABLE NS_IMETHOD GetClientX(PRInt32 *aClientX) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetClientX(aClientX); } \
109  NS_SCRIPTABLE NS_IMETHOD GetClientY(PRInt32 *aClientY) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetClientY(aClientY); } \
110  NS_SCRIPTABLE NS_IMETHOD GetCtrlKey(PRBool *aCtrlKey) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCtrlKey(aCtrlKey); } \
111  NS_SCRIPTABLE NS_IMETHOD GetShiftKey(PRBool *aShiftKey) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetShiftKey(aShiftKey); } \
112  NS_SCRIPTABLE NS_IMETHOD GetAltKey(PRBool *aAltKey) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAltKey(aAltKey); } \
113  NS_SCRIPTABLE NS_IMETHOD GetMetaKey(PRBool *aMetaKey) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetMetaKey(aMetaKey); } \
114  NS_SCRIPTABLE NS_IMETHOD GetButton(PRUint16 *aButton) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetButton(aButton); } \
115  NS_SCRIPTABLE NS_IMETHOD GetRelatedTarget(nsIDOMEventTarget * *aRelatedTarget) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetRelatedTarget(aRelatedTarget); } \
116  NS_SCRIPTABLE NS_IMETHOD InitMouseEvent(const nsAString & typeArg, PRBool canBubbleArg, PRBool cancelableArg, nsIDOMAbstractView *viewArg, PRInt32 detailArg, PRInt32 screenXArg, PRInt32 screenYArg, PRInt32 clientXArg, PRInt32 clientYArg, PRBool ctrlKeyArg, PRBool altKeyArg, PRBool shiftKeyArg, PRBool metaKeyArg, PRUint16 buttonArg, nsIDOMEventTarget *relatedTargetArg) { return !_to ? NS_ERROR_NULL_POINTER : _to->InitMouseEvent(typeArg, canBubbleArg, cancelableArg, viewArg, detailArg, screenXArg, screenYArg, clientXArg, clientYArg, ctrlKeyArg, altKeyArg, shiftKeyArg, metaKeyArg, buttonArg, relatedTargetArg); } 
117
118#if 0
119/* Use the code below as a template for the implementation class for this interface. */
120
121/* Header file */
122class nsDOMMouseEvent : public nsIDOMMouseEvent
123{
124public:
125  NS_DECL_ISUPPORTS
126  NS_DECL_NSIDOMMOUSEEVENT
127
128  nsDOMMouseEvent();
129
130private:
131  ~nsDOMMouseEvent();
132
133protected:
134  /* additional members */
135};
136
137/* Implementation file */
138NS_IMPL_ISUPPORTS1(nsDOMMouseEvent, nsIDOMMouseEvent)
139
140nsDOMMouseEvent::nsDOMMouseEvent()
141{
142  /* member initializers and constructor code */
143}
144
145nsDOMMouseEvent::~nsDOMMouseEvent()
146{
147  /* destructor code */
148}
149
150/* readonly attribute long screenX; */
151NS_IMETHODIMP nsDOMMouseEvent::GetScreenX(PRInt32 *aScreenX)
152{
153    return NS_ERROR_NOT_IMPLEMENTED;
154}
155
156/* readonly attribute long screenY; */
157NS_IMETHODIMP nsDOMMouseEvent::GetScreenY(PRInt32 *aScreenY)
158{
159    return NS_ERROR_NOT_IMPLEMENTED;
160}
161
162/* readonly attribute long clientX; */
163NS_IMETHODIMP nsDOMMouseEvent::GetClientX(PRInt32 *aClientX)
164{
165    return NS_ERROR_NOT_IMPLEMENTED;
166}
167
168/* readonly attribute long clientY; */
169NS_IMETHODIMP nsDOMMouseEvent::GetClientY(PRInt32 *aClientY)
170{
171    return NS_ERROR_NOT_IMPLEMENTED;
172}
173
174/* readonly attribute boolean ctrlKey; */
175NS_IMETHODIMP nsDOMMouseEvent::GetCtrlKey(PRBool *aCtrlKey)
176{
177    return NS_ERROR_NOT_IMPLEMENTED;
178}
179
180/* readonly attribute boolean shiftKey; */
181NS_IMETHODIMP nsDOMMouseEvent::GetShiftKey(PRBool *aShiftKey)
182{
183    return NS_ERROR_NOT_IMPLEMENTED;
184}
185
186/* readonly attribute boolean altKey; */
187NS_IMETHODIMP nsDOMMouseEvent::GetAltKey(PRBool *aAltKey)
188{
189    return NS_ERROR_NOT_IMPLEMENTED;
190}
191
192/* readonly attribute boolean metaKey; */
193NS_IMETHODIMP nsDOMMouseEvent::GetMetaKey(PRBool *aMetaKey)
194{
195    return NS_ERROR_NOT_IMPLEMENTED;
196}
197
198/* readonly attribute unsigned short button; */
199NS_IMETHODIMP nsDOMMouseEvent::GetButton(PRUint16 *aButton)
200{
201    return NS_ERROR_NOT_IMPLEMENTED;
202}
203
204/* readonly attribute nsIDOMEventTarget relatedTarget; */
205NS_IMETHODIMP nsDOMMouseEvent::GetRelatedTarget(nsIDOMEventTarget * *aRelatedTarget)
206{
207    return NS_ERROR_NOT_IMPLEMENTED;
208}
209
210/* void initMouseEvent (in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in nsIDOMAbstractView viewArg, in long detailArg, in long screenXArg, in long screenYArg, in long clientXArg, in long clientYArg, in boolean ctrlKeyArg, in boolean altKeyArg, in boolean shiftKeyArg, in boolean metaKeyArg, in unsigned short buttonArg, in nsIDOMEventTarget relatedTargetArg); */
211NS_IMETHODIMP nsDOMMouseEvent::InitMouseEvent(const nsAString & typeArg, PRBool canBubbleArg, PRBool cancelableArg, nsIDOMAbstractView *viewArg, PRInt32 detailArg, PRInt32 screenXArg, PRInt32 screenYArg, PRInt32 clientXArg, PRInt32 clientYArg, PRBool ctrlKeyArg, PRBool altKeyArg, PRBool shiftKeyArg, PRBool metaKeyArg, PRUint16 buttonArg, nsIDOMEventTarget *relatedTargetArg)
212{
213    return NS_ERROR_NOT_IMPLEMENTED;
214}
215
216/* End of implementation class template. */
217#endif
218
219
220#endif /* __gen_nsIDOMMouseEvent_h__ */