\section{DOM::Mutation\-Event Class Reference}
\label{classDOM_1_1MutationEvent}\index{DOM::MutationEvent@{DOM::MutationEvent}}
Introduced in {\bf DOM}{\rm (p.\,\pageref{namespaceDOM})} Level 2.  


{\tt \#include $<$dom2\_\-events.h$>$}

Inheritance diagram for DOM::Mutation\-Event:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=76pt]{classDOM_1_1MutationEvent__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for DOM::Mutation\-Event:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=76pt]{classDOM_1_1MutationEvent__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf attr\-Change\-Type} \{ {\bf MODIFICATION} =  1, 
{\bf ADDITION} =  2, 
{\bf REMOVAL} =  3
 \}
\begin{CompactList}\small\item\em An integer indicating in which way the {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} was changed. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Mutation\-Event} (const  {\bf Mutation\-Event} \&other)\label{classDOM_1_1MutationEvent_a1}

\item 
{\bf Mutation\-Event} (const  {\bf Event} \&other)\label{classDOM_1_1MutationEvent_a2}

\item 
{\bf Mutation\-Event} \& {\bf operator=} (const  {\bf Mutation\-Event} \&other)\label{classDOM_1_1MutationEvent_a3}

\item 
{\bf Mutation\-Event} \& {\bf operator=} (const  {\bf Event} \&other)\label{classDOM_1_1MutationEvent_a4}

\item 
{\bf Node} {\bf related\-Node} () const 
\begin{CompactList}\small\item\em related\-Node is used to identify a secondary node related to a mutation event. \item\end{CompactList}\item 
{\bf DOMString} {\bf prev\-Value} () const 
\begin{CompactList}\small\item\em prev\-Value indicates the previous value of the {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} node in DOMAttr\-Modified events, and of the {\bf Character\-Data}{\rm (p.\,\pageref{classDOM_1_1CharacterData})} node in DOMChar\-Data\-Modified events. \item\end{CompactList}\item 
{\bf DOMString} {\bf new\-Value} () const 
\begin{CompactList}\small\item\em new\-Value indicates the new value of the {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} node in DOMAttr\-Modified events, and of the {\bf Character\-Data}{\rm (p.\,\pageref{classDOM_1_1CharacterData})} node in DOMChar\-Data\-Modified events. \item\end{CompactList}\item 
{\bf DOMString} {\bf attr\-Name} () const 
\begin{CompactList}\small\item\em attr\-Name indicates the name of the changed {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} node in a DOMAttr\-Modified event. \item\end{CompactList}\item 
unsigned short {\bf attr\-Change} () const 
\begin{CompactList}\small\item\em attr\-Change indicates the type of change which triggered the DOMAttr\-Modified event. \item\end{CompactList}\item 
void {\bf init\-Mutation\-Event} (const  {\bf DOMString} \&type\-Arg, bool can\-Bubble\-Arg, bool cancelable\-Arg, const  {\bf Node} \&related\-Node\-Arg, const  {\bf DOMString} \&prev\-Value\-Arg, const  {\bf DOMString} \&new\-Value\-Arg, const  {\bf DOMString} \&attr\-Name\-Arg, unsigned short attr\-Change\-Arg)
\begin{CompactList}\small\item\em The init\-Mutation\-Event method is used to initialize the value of a {\bf Mutation\-Event}{\rm (p.\,\pageref{classDOM_1_1MutationEvent})} created through the Document\-Event interface. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf Mutation\-Event} (Mutation\-Event\-Impl $\ast$impl)\label{classDOM_1_1MutationEvent_b0}

\end{CompactItemize}


\subsection{Detailed Description}
Introduced in {\bf DOM}{\rm (p.\,\pageref{namespaceDOM})} Level 2. 

The {\bf Mutation\-Event}{\rm (p.\,\pageref{classDOM_1_1MutationEvent})} interface provides specific contextual information associated with Mutation events. 



Definition at line 728 of file dom2\_\-events.h.

\subsection{Member Enumeration Documentation}
\index{DOM::MutationEvent@{DOM::Mutation\-Event}!attrChangeType@{attrChangeType}}
\index{attrChangeType@{attrChangeType}!DOM::MutationEvent@{DOM::Mutation\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf DOM::Mutation\-Event::attr\-Change\-Type}}\label{classDOM_1_1MutationEvent_w3}


An integer indicating in which way the {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} was changed. 

ADDITION: The {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} was just added.

MODIFICATION: The {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} was modified in place.

REMOVAL: The {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} was just removed. 

Definition at line 747 of file dom2\_\-events.h.

\subsection{Member Function Documentation}
\index{DOM::MutationEvent@{DOM::Mutation\-Event}!relatedNode@{relatedNode}}
\index{relatedNode@{relatedNode}!DOM::MutationEvent@{DOM::Mutation\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Node} Mutation\-Event::related\-Node () const}\label{classDOM_1_1MutationEvent_a6}


related\-Node 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 related\-Node is the changed parent. If an event is instead dispatched to a subtree indicating a node was changed within it, the related\-Node is the changed node. In the case of the DOMAttr\-Modified event it indicates the {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} node which was modified, added, or removed. 

Definition at line 572 of file dom2\_\-events.cpp.\index{DOM::MutationEvent@{DOM::Mutation\-Event}!prevValue@{prevValue}}
\index{prevValue@{prevValue}!DOM::MutationEvent@{DOM::Mutation\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DOMString} Mutation\-Event::prev\-Value () const}\label{classDOM_1_1MutationEvent_a7}


prev\-Value indicates the previous value of the {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} node in DOMAttr\-Modified events, and of the {\bf Character\-Data}{\rm (p.\,\pageref{classDOM_1_1CharacterData})} node in DOMChar\-Data\-Modified events. 



Definition at line 580 of file dom2\_\-events.cpp.\index{DOM::MutationEvent@{DOM::Mutation\-Event}!newValue@{newValue}}
\index{newValue@{newValue}!DOM::MutationEvent@{DOM::Mutation\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DOMString} Mutation\-Event::new\-Value () const}\label{classDOM_1_1MutationEvent_a8}


new\-Value indicates the new value of the {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} node in DOMAttr\-Modified events, and of the {\bf Character\-Data}{\rm (p.\,\pageref{classDOM_1_1CharacterData})} node in DOMChar\-Data\-Modified events. 



Definition at line 588 of file dom2\_\-events.cpp.\index{DOM::MutationEvent@{DOM::Mutation\-Event}!attrName@{attrName}}
\index{attrName@{attrName}!DOM::MutationEvent@{DOM::Mutation\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DOMString} Mutation\-Event::attr\-Name () const}\label{classDOM_1_1MutationEvent_a9}


attr\-Name indicates the name of the changed {\bf Attr}{\rm (p.\,\pageref{classDOM_1_1Attr})} node in a DOMAttr\-Modified event. 



Definition at line 596 of file dom2\_\-events.cpp.\index{DOM::MutationEvent@{DOM::Mutation\-Event}!attrChange@{attrChange}}
\index{attrChange@{attrChange}!DOM::MutationEvent@{DOM::Mutation\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned short Mutation\-Event::attr\-Change () const}\label{classDOM_1_1MutationEvent_a10}


attr\-Change indicates the type of change which triggered the DOMAttr\-Modified event. 

The values can be MODIFICATION, ADDITION, or REMOVAL. 

Definition at line 604 of file dom2\_\-events.cpp.\index{DOM::MutationEvent@{DOM::Mutation\-Event}!initMutationEvent@{initMutationEvent}}
\index{initMutationEvent@{initMutationEvent}!DOM::MutationEvent@{DOM::Mutation\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Mutation\-Event::init\-Mutation\-Event (const {\bf DOMString} \& {\em type\-Arg}, bool {\em can\-Bubble\-Arg}, bool {\em cancelable\-Arg}, const {\bf Node} \& {\em related\-Node\-Arg}, const {\bf DOMString} \& {\em prev\-Value\-Arg}, const {\bf DOMString} \& {\em new\-Value\-Arg}, const {\bf DOMString} \& {\em attr\-Name\-Arg}, unsigned short {\em attr\-Change\-Arg})}\label{classDOM_1_1MutationEvent_a11}


The init\-Mutation\-Event method is used to initialize the value of a {\bf Mutation\-Event}{\rm (p.\,\pageref{classDOM_1_1MutationEvent})} created through the Document\-Event interface. 

This method may only be called before the {\bf Mutation\-Event}{\rm (p.\,\pageref{classDOM_1_1MutationEvent})} has been dispatched via the dispatch\-Event method, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em type\-Arg}]Specifies the event type.\item[{\em can\-Bubble\-Arg}]Specifies whether or not the event can bubble.\item[{\em cancelable\-Arg}]Specifies whether or not the event's default action can be prevented.\item[{\em related\-Node\-Arg}]Specifies the Event's related {\bf Node}{\rm (p.\,\pageref{classDOM_1_1Node})}.\item[{\em prev\-Value\-Arg}]Specifies the Event's prev\-Value attribute. This value may be null.\item[{\em new\-Value\-Arg}]Specifies the Event's new\-Value attribute. This value may be null.\item[{\em attr\-Name\-Arg}]Specifies the Event's attr\-Name attribute. This value may be null.\item[{\em attr\-Change\-Arg}]Specifies the Event's attr\-Change attribute \end{description}
\end{Desc}


Definition at line 612 of file dom2\_\-events.cpp.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
dom2\_\-events.h\item 
dom2\_\-events.cpp\end{CompactItemize}
