Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes | Protected Attributes
nsXFormsDOMEvent Class Reference

Implementation for XForms events. More...

#include <nsXFormsDOMEvent.h>

Inheritance diagram for nsXFormsDOMEvent:
Inheritance graph
[legend]
Collaboration diagram for nsXFormsDOMEvent:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSIXFORMSDOMEVENT
NS_DECL_NSIDOMNSEVENT
NS_IMETHOD 
DuplicatePrivateData ()
NS_IMETHOD SetTarget (nsIDOMEventTarget *aTarget)
NS_IMETHOD SetCurrentTarget (nsIDOMEventTarget *aTarget)
NS_IMETHOD SetOriginalTarget (nsIDOMEventTarget *aTarget)
NS_IMETHOD IsDispatchStopped (PRBool *aIsDispatchPrevented)
NS_IMETHOD GetInternalNSEvent (nsEvent **aNSEvent)
NS_IMETHOD HasOriginalTarget (PRBool *aResult)
NS_IMETHOD SetTrusted (PRBool aTrusted)
 nsXFormsDOMEvent (nsIDOMEvent *aInner, nsCOMArray< nsIXFormsContextInfo > *aContextInfo)
 Implementation for XForms events.
virtual ~nsXFormsDOMEvent ()
nsresult SetContextInfo (nsCOMArray< nsIXFormsContextInfo > *aContextInfo)
nsIXFormsContextInfo getContextInfo (in DOMString aName)
 Get a context property from an nsXFormsDOMEvent.
void stopPropagation ()
 The stopPropagation method is used prevent further propagation of an event during event flow.
void preventDefault ()
 If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur.
void initEvent (in DOMString eventTypeArg, in boolean canBubbleArg, in boolean cancelableArg)
 The initEvent method is used to initialize the value of an Event created through the DocumentEvent interface.
void preventBubble ()
void preventCapture ()

Public Attributes

const unsigned short CAPTURING_PHASE = 1
 The current event phase is the capturing phase.
const unsigned short AT_TARGET = 2
 The event is currently being evaluated at the target EventTarget.
const unsigned short BUBBLING_PHASE = 3
 The current event phase is the bubbling phase.
readonly attribute DOMString type
 The name of the event (case-insensitive).
readonly attribute
nsIDOMEventTarget 
target
 Used to indicate the EventTarget to which the event was originally dispatched.
readonly attribute
nsIDOMEventTarget 
currentTarget
 Used to indicate the EventTarget whose EventListeners are currently being processed.
readonly attribute unsigned short eventPhase
 Used to indicate which phase of event flow is currently being evaluated.
readonly attribute boolean bubbles
 Used to indicate whether or not an event is a bubbling event.
readonly attribute boolean cancelable
 Used to indicate whether or not an event can have its default action prevented.
readonly attribute DOMTimeStamp timeStamp
 Used to specify the time (in milliseconds relative to the epoch) at which the event was created.
const long MOUSEDOWN = 0x00000001
const long MOUSEUP = 0x00000002
const long MOUSEOVER = 0x00000004
const long MOUSEOUT = 0x00000008
const long MOUSEMOVE = 0x00000010
const long MOUSEDRAG = 0x00000020
const long CLICK = 0x00000040
const long DBLCLICK = 0x00000080
const long KEYDOWN = 0x00000100
const long KEYUP = 0x00000200
const long KEYPRESS = 0x00000400
const long DRAGDROP = 0x00000800
const long FOCUS = 0x00001000
const long BLUR = 0x00002000
const long SELECT = 0x00004000
const long CHANGE = 0x00008000
const long RESET = 0x00010000
const long SUBMIT = 0x00020000
const long SCROLL = 0x00040000
const long LOAD = 0x00080000
const long UNLOAD = 0x00100000
const long XFER_DONE = 0x00200000
const long ABORT = 0x00400000
const long ERROR = 0x00800000
const long LOCATE = 0x01000000
const long MOVE = 0x02000000
const long RESIZE = 0x04000000
const long FORWARD = 0x08000000
const long HELP = 0x10000000
const long BACK = 0x20000000
const long TEXT = 0x40000000
const long ALT_MASK = 0x00000001
const long CONTROL_MASK = 0x00000002
const long SHIFT_MASK = 0x00000004
const long META_MASK = 0x00000008
readonly attribute
nsIDOMEventTarget 
originalTarget
 The original target of the event, before any retargetings.
readonly attribute
nsIDOMEventTarget 
explicitOriginalTarget
 The explicit original target of the event.
readonly attribute
nsIDOMEventTarget 
tmpRealOriginalTarget
readonly attribute boolean isTrusted

Protected Attributes

nsCOMPtr< nsIDOMEventmInner
nsInterfaceHashtable
< nsStringHashKey,
nsIXFormsContextInfo
mContextInfo
 Hashtable of all context info properties for a given event.

Detailed Description

Implementation for XForms events.

Definition at line 55 of file nsXFormsDOMEvent.h.


Constructor & Destructor Documentation

Implementation for XForms events.

Definition at line 69 of file nsXFormsDOMEvent.cpp.

{
  mInner = aInner;
  mContextInfo.Init();
  SetContextInfo(aContextInfo);
}

Definition at line 77 of file nsXFormsDOMEvent.cpp.

{}

Member Function Documentation

Implements nsIPrivateDOMEvent.

Definition at line 148 of file nsXFormsDOMEvent.cpp.

{
  nsCOMPtr<nsIPrivateDOMEvent> privEvent = do_QueryInterface(mInner);
  return privEvent->DuplicatePrivateData();
}

Here is the call graph for this function:

nsIXFormsContextInfo nsIXFormsDOMEvent::getContextInfo ( in DOMString  aName) [inherited]

Get a context property from an nsXFormsDOMEvent.

Parameters:
aName- context property name.

Implements nsIPrivateDOMEvent.

Definition at line 183 of file nsXFormsDOMEvent.cpp.

{
  nsCOMPtr<nsIPrivateDOMEvent> privEvent = do_QueryInterface(mInner);
  return privEvent->GetInternalNSEvent(aNSEvent);
}

Here is the call graph for this function:

Implements nsIPrivateDOMEvent.

Definition at line 190 of file nsXFormsDOMEvent.cpp.

{
  nsCOMPtr<nsIPrivateDOMEvent> privEvent = do_QueryInterface(mInner);
  return privEvent->HasOriginalTarget(aResult);
}

Here is the call graph for this function:

void nsIDOMEvent::initEvent ( in DOMString  eventTypeArg,
in boolean  canBubbleArg,
in boolean  cancelableArg 
) [inherited]

The initEvent method is used to initialize the value of an Event created through the DocumentEvent interface.

This method may only be called before the Event has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times the final invocation takes precedence. If called from a subclass of Event interface only the values specified in the initEvent method are modified, all other attributes are left unchanged.

Parameters:
eventTypeArgSpecifies the event type. This type may be any event type currently defined in this specification or a new event type.. The string must be an XML name. Any new event type must not begin with any upper, lower, or mixed case version of the string "DOM". This prefix is reserved for future DOM event sets. It is also strongly recommended that third parties adding their own events use their own prefix to avoid confusion and lessen the probability of conflicts with other new events.
canBubbleArgSpecifies whether or not the event can bubble.
cancelableArgSpecifies whether or not the event's default action can be prevented.
NS_METHOD nsXFormsDOMEvent::IsDispatchStopped ( PRBool aIsDispatchPrevented) [virtual]

Implements nsIPrivateDOMEvent.

Definition at line 176 of file nsXFormsDOMEvent.cpp.

{
  nsCOMPtr<nsIPrivateDOMEvent> privEvent = do_QueryInterface(mInner);
  return privEvent->IsDispatchStopped(aIsDispatchPrevented);
}

Here is the call graph for this function:

If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur.

If, during any stage of event flow, the preventDefault method is called the event is canceled. Any default action associated with the event will not occur. Calling this method for a non-cancelable event has no effect. Once preventDefault has been called it will remain in effect throughout the remainder of the event's propagation. This method may be used during any stage of event flow.

Definition at line 81 of file nsXFormsDOMEvent.cpp.

{
 if (aContextInfo) {
   for (int i = 0; i < aContextInfo->Count(); i++) {
     nsCOMPtr<nsIXFormsContextInfo> ctxtInfo = aContextInfo->ObjectAt(i);
     nsAutoString name;
     ctxtInfo->GetName(name);
     mContextInfo.Put(name, ctxtInfo);
   }
 }
 return NS_OK;
}

Here is the call graph for this function:

Implements nsIPrivateDOMEvent.

Definition at line 162 of file nsXFormsDOMEvent.cpp.

{
  nsCOMPtr<nsIPrivateDOMEvent> privEvent = do_QueryInterface(mInner);
  return privEvent->SetCurrentTarget(aTarget);
}

Here is the call graph for this function:

Implements nsIPrivateDOMEvent.

Definition at line 169 of file nsXFormsDOMEvent.cpp.

{
  nsCOMPtr<nsIPrivateDOMEvent> privEvent = do_QueryInterface(mInner);
  return privEvent->SetOriginalTarget(aTarget);
}

Here is the call graph for this function:

Implements nsIPrivateDOMEvent.

Definition at line 155 of file nsXFormsDOMEvent.cpp.

{
  nsCOMPtr<nsIPrivateDOMEvent> privEvent = do_QueryInterface(mInner);
  return privEvent->SetTarget(aTarget);
}

Here is the call graph for this function:

Implements nsIPrivateDOMEvent.

Definition at line 197 of file nsXFormsDOMEvent.cpp.

{
  nsCOMPtr<nsIPrivateDOMEvent> privEvent = do_QueryInterface(mInner);
  return privEvent->SetTrusted(aTrusted);
}

Here is the call graph for this function:

The stopPropagation method is used prevent further propagation of an event during event flow.

If this method is called by any EventListener the event will cease propagating through the tree. The event will complete dispatch to all listeners on the current EventTarget before event flow stops. This method may be used during any stage of event flow.


Member Data Documentation

const long nsIDOMNSEvent::ABORT = 0x00400000 [inherited]

Definition at line 72 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::ALT_MASK = 0x00000001 [inherited]

Definition at line 82 of file nsIDOMNSEvent.idl.

const unsigned short nsIDOMEvent::AT_TARGET = 2 [inherited]

The event is currently being evaluated at the target EventTarget.

Definition at line 66 of file nsIDOMEvent.idl.

const long nsIDOMNSEvent::BACK = 0x20000000 [inherited]

Definition at line 79 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::BLUR = 0x00002000 [inherited]

Definition at line 63 of file nsIDOMNSEvent.idl.

readonly attribute boolean nsIDOMEvent::bubbles [inherited]

Used to indicate whether or not an event is a bubbling event.

If the event can bubble the value is true, else the value is false.

Definition at line 102 of file nsIDOMEvent.idl.

const unsigned short nsIDOMEvent::BUBBLING_PHASE = 3 [inherited]

The current event phase is the bubbling phase.

Definition at line 71 of file nsIDOMEvent.idl.

Used to indicate whether or not an event can have its default action prevented.

If the default action can be prevented the value is true, else the value is false.

Definition at line 109 of file nsIDOMEvent.idl.

const unsigned short nsIDOMEvent::CAPTURING_PHASE = 1 [inherited]

The current event phase is the capturing phase.

Definition at line 61 of file nsIDOMEvent.idl.

const long nsIDOMNSEvent::CHANGE = 0x00008000 [inherited]

Definition at line 65 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::CLICK = 0x00000040 [inherited]

Definition at line 56 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::CONTROL_MASK = 0x00000002 [inherited]

Definition at line 83 of file nsIDOMNSEvent.idl.

Used to indicate the EventTarget whose EventListeners are currently being processed.

This is particularly useful during capturing and bubbling.

Definition at line 90 of file nsIDOMEvent.idl.

const long nsIDOMNSEvent::DBLCLICK = 0x00000080 [inherited]

Definition at line 57 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::DRAGDROP = 0x00000800 [inherited]

Definition at line 61 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::ERROR = 0x00800000 [inherited]

Definition at line 73 of file nsIDOMNSEvent.idl.

readonly attribute unsigned short nsIDOMEvent::eventPhase [inherited]

Used to indicate which phase of event flow is currently being evaluated.

Definition at line 96 of file nsIDOMEvent.idl.

The explicit original target of the event.

If the event was retargeted for some reason other than an anonymous boundary crossing, this will be set to the target before the retargeting occurs. For example, mouse events are retargeted to their parent node when they happen over text nodes (bug 185889), and in that case .target will show the parent and .explicitOriginalTarget will show the text node. .explicitOriginalTarget differs from .originalTarget in that it will never contain anonymous content.

Definition at line 99 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::FOCUS = 0x00001000 [inherited]

Definition at line 62 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::FORWARD = 0x08000000 [inherited]

Definition at line 77 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::HELP = 0x10000000 [inherited]

Definition at line 78 of file nsIDOMNSEvent.idl.

Definition at line 117 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::KEYDOWN = 0x00000100 [inherited]

Definition at line 58 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::KEYPRESS = 0x00000400 [inherited]

Definition at line 60 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::KEYUP = 0x00000200 [inherited]

Definition at line 59 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::LOAD = 0x00080000 [inherited]

Definition at line 69 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::LOCATE = 0x01000000 [inherited]

Definition at line 74 of file nsIDOMNSEvent.idl.

Hashtable of all context info properties for a given event.

key = context property name, value = nsIXFormsContextInfo

Definition at line 88 of file nsXFormsDOMEvent.h.

const long nsIDOMNSEvent::META_MASK = 0x00000008 [inherited]

Definition at line 85 of file nsIDOMNSEvent.idl.

Definition at line 83 of file nsXFormsDOMEvent.h.

const long nsIDOMNSEvent::MOUSEDOWN = 0x00000001 [inherited]

Definition at line 50 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::MOUSEDRAG = 0x00000020 [inherited]

Definition at line 55 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::MOUSEMOVE = 0x00000010 [inherited]

Definition at line 54 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::MOUSEOUT = 0x00000008 [inherited]

Definition at line 53 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::MOUSEOVER = 0x00000004 [inherited]

Definition at line 52 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::MOUSEUP = 0x00000002 [inherited]

Definition at line 51 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::MOVE = 0x02000000 [inherited]

Definition at line 75 of file nsIDOMNSEvent.idl.

The original target of the event, before any retargetings.

Definition at line 88 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::RESET = 0x00010000 [inherited]

Definition at line 66 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::RESIZE = 0x04000000 [inherited]

Definition at line 76 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::SCROLL = 0x00040000 [inherited]

Definition at line 68 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::SELECT = 0x00004000 [inherited]

Definition at line 64 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::SHIFT_MASK = 0x00000004 [inherited]

Definition at line 84 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::SUBMIT = 0x00020000 [inherited]

Definition at line 67 of file nsIDOMNSEvent.idl.

Used to indicate the EventTarget to which the event was originally dispatched.

Definition at line 83 of file nsIDOMEvent.idl.

const long nsIDOMNSEvent::TEXT = 0x40000000 [inherited]

Definition at line 80 of file nsIDOMNSEvent.idl.

Used to specify the time (in milliseconds relative to the epoch) at which the event was created.

Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.

Definition at line 119 of file nsIDOMEvent.idl.

Definition at line 105 of file nsIDOMNSEvent.idl.

readonly attribute DOMString nsIDOMEvent::type [inherited]

The name of the event (case-insensitive).

The name must be an XML name.

Definition at line 77 of file nsIDOMEvent.idl.

const long nsIDOMNSEvent::UNLOAD = 0x00100000 [inherited]

Definition at line 70 of file nsIDOMNSEvent.idl.

const long nsIDOMNSEvent::XFER_DONE = 0x00200000 [inherited]

Definition at line 71 of file nsIDOMNSEvent.idl.


The documentation for this class was generated from the following files: