Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

DOM::MutationEvent Class Reference

Introduced in DOM Level 2. More...

#include <dom2_events.h>

Inheritance diagram for DOM::MutationEvent:

DOM::Event List of all members.

Public Types

enum  attrChangeType { MODIFICATION = 1, ADDITION = 2, REMOVAL = 3 }

Public Methods

 MutationEvent ()
 MutationEvent (const MutationEvent &other)
 MutationEvent (const Event &other)
MutationEvent & operator= (const MutationEvent &other)
MutationEvent & operator= (const Event &other)
virtual ~MutationEvent ()
Node relatedNode () const
DOMString prevValue () const
DOMString newValue () const
DOMString attrName () const
unsigned short attrChange () const
void initMutationEvent (const DOMString &typeArg, bool canBubbleArg, bool cancelableArg, const Node &relatedNodeArg, const DOMString &prevValueArg, const DOMString &newValueArg, const DOMString &attrNameArg, unsigned short attrChangeArg)

Protected Methods

 MutationEvent (MutationEventImpl *impl)

Detailed Description

Introduced in DOM Level 2.

The MutationEvent interface provides specific contextual information associated with Mutation events.


Member Enumeration Documentation

enum DOM::MutationEvent::attrChangeType
 

An integer indicating in which way the Attr was changed.

ADDITION: The Attr was just added.

MODIFICATION: The Attr was modified in place.

REMOVAL: The Attr was just removed.

Enumeration values:
MODIFICATION 
ADDITION 
REMOVAL 


Constructor & Destructor Documentation

DOM::MutationEvent::MutationEvent  
 

DOM::MutationEvent::MutationEvent const MutationEvent &    other
 

DOM::MutationEvent::MutationEvent const Event   other
 

virtual DOM::MutationEvent::~MutationEvent   [virtual]
 

DOM::MutationEvent::MutationEvent MutationEventImpl *    impl [protected]
 


Member Function Documentation

MutationEvent& DOM::MutationEvent::operator= const MutationEvent &    other
 

MutationEvent& DOM::MutationEvent::operator= const Event   other
 

Reimplemented from DOM::Event.

Node DOM::MutationEvent::relatedNode  
 

relatedNode is used to identify a secondary node related to a mutation event.

For example, if a mutation event is dispatched to a node indicating that its parent has changed, the relatedNode is the changed parent. If an event is instead dispatched to a subtree indicating a node was changed within it, the relatedNode is the changed node. In the case of the DOMAttrModified event it indicates the Attr node which was modified, added, or removed.

DOMString DOM::MutationEvent::prevValue  
 

prevValue indicates the previous value of the Attr node in DOMAttrModified events, and of the CharacterData node in DOMCharDataModified events.

DOMString DOM::MutationEvent::newValue  
 

newValue indicates the new value of the Attr node in DOMAttrModified events, and of the CharacterData node in DOMCharDataModified events.

DOMString DOM::MutationEvent::attrName  
 

attrName indicates the name of the changed Attr node in a DOMAttrModified event.

unsigned short DOM::MutationEvent::attrChange  
 

attrChange indicates the type of change which triggered the DOMAttrModified event.

The values can be MODIFICATION, ADDITION, or REMOVAL.

void DOM::MutationEvent::initMutationEvent const DOMString   typeArg,
bool    canBubbleArg,
bool    cancelableArg,
const Node   relatedNodeArg,
const DOMString   prevValueArg,
const DOMString   newValueArg,
const DOMString   attrNameArg,
unsigned short    attrChangeArg
 

The initMutationEvent method is used to initialize the value of a MutationEvent created through the DocumentEvent interface.

This method may only be called before the MutationEvent 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.

Parameters:
typeArg  Specifies the event type.
canBubbleArg  Specifies whether or not the event can bubble.
cancelableArg  Specifies whether or not the event's default action can be prevented.
relatedNodeArg  Specifies the Event's related Node.
prevValueArg  Specifies the Event's prevValue attribute. This value may be null.
newValueArg  Specifies the Event's newValue attribute. This value may be null.
attrNameArg  Specifies the Event's attrName attribute. This value may be null.
attrChangeArg  Specifies the Event's attrChange attribute


The documentation for this class was generated from the following file:
Generated on Sat Jan 31 23:28:24 2004 for XPath by doxygen1.2.18