\section{DOM::Text\-Event Class Reference}
\label{classDOM_1_1TextEvent}\index{DOM::TextEvent@{DOM::TextEvent}}
DOM::Text\-Event The detail attribute inherited from {\bf UIEvent}{\rm (p.\,\pageref{classDOM_1_1UIEvent})} is used to indicate the number of keypresses which have occurred during key repetition.  


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

Inheritance diagram for DOM::Text\-Event:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=64pt]{classDOM_1_1TextEvent__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for DOM::Text\-Event:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=64pt]{classDOM_1_1TextEvent__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Text\-Event} (const  {\bf Text\-Event} \&other)\label{classDOM_1_1TextEvent_a1}

\item 
{\bf Text\-Event} (const  {\bf Event} \&other)\label{classDOM_1_1TextEvent_a2}

\item 
{\bf Text\-Event} \& {\bf operator=} (const  {\bf Text\-Event} \&other)\label{classDOM_1_1TextEvent_a3}

\item 
{\bf Text\-Event} \& {\bf operator=} (const  {\bf Event} \&other)\label{classDOM_1_1TextEvent_a4}

\item 
void {\bf init\-Text\-Event} (const  {\bf DOMString} \&type\-Arg, bool can\-Bubble\-Arg, bool cancelable\-Arg, const  {\bf Abstract\-View} \&view\-Arg, long detail\-Arg, const  {\bf DOMString} \&output\-String\-Arg, unsigned long key\-Val\-Arg, unsigned long virt\-Key\-Val\-Arg, bool input\-Generated\-Arg, bool num\-Pad\-Arg)
\begin{CompactList}\small\item\em init\-Text\-Event \item\end{CompactList}\item 
void {\bf init\-Modifier} (unsigned long modifier\-Arg, bool value\-Arg)
\begin{CompactList}\small\item\em init\-Modifier \item\end{CompactList}\item 
bool {\bf input\-Generated} () const 
\begin{CompactList}\small\item\em input\-Generated of type boolean \item\end{CompactList}\item 
unsigned long {\bf key\-Val} () const 
\begin{CompactList}\small\item\em key\-Val of type unsigned long \item\end{CompactList}\item 
bool {\bf num\-Pad} () const 
\begin{CompactList}\small\item\em num\-Pad of type boolean \item\end{CompactList}\item 
{\bf DOMString} {\bf output\-String} () const 
\begin{CompactList}\small\item\em output\-String of type {\bf DOMString}{\rm (p.\,\pageref{classDOM_1_1DOMString})} \item\end{CompactList}\item 
unsigned long {\bf virt\-Key\-Val} () const 
\begin{CompactList}\small\item\em virt\-Key\-Val of type unsigned long \item\end{CompactList}\item 
bool {\bf check\-Modifier} (unsigned long modifer\-Arg)
\begin{CompactList}\small\item\em check\-Modifier \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf Text\-Event} (Text\-Event\-Impl $\ast$impl)\label{classDOM_1_1TextEvent_b0}

\end{CompactItemize}


\subsection{Detailed Description}
DOM::Text\-Event The detail attribute inherited from {\bf UIEvent}{\rm (p.\,\pageref{classDOM_1_1UIEvent})} is used to indicate the number of keypresses which have occurred during key repetition. 

If this information is not available this value should be 0. 



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

\subsection{Member Function Documentation}
\index{DOM::TextEvent@{DOM::Text\-Event}!initTextEvent@{initTextEvent}}
\index{initTextEvent@{initTextEvent}!DOM::TextEvent@{DOM::Text\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Text\-Event::init\-Text\-Event (const {\bf DOMString} \& {\em type\-Arg}, bool {\em can\-Bubble\-Arg}, bool {\em cancelable\-Arg}, const {\bf Abstract\-View} \& {\em view\-Arg}, long {\em detail\-Arg}, const {\bf DOMString} \& {\em output\-String\-Arg}, unsigned long {\em key\-Val\-Arg}, unsigned long {\em virt\-Key\-Val\-Arg}, bool {\em input\-Generated\-Arg}, bool {\em num\-Pad\-Arg})}\label{classDOM_1_1TextEvent_a6}


init\-Text\-Event 

The init\-Text\-Event method is used to initialize the value of a {\bf Mouse\-Event}{\rm (p.\,\pageref{classDOM_1_1MouseEvent})} created through the Document\-Event interface. This method may only be called before the {\bf Text\-Event}{\rm (p.\,\pageref{classDOM_1_1TextEvent})} 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. This method has no effect if called after the event has been dispatched.

Parameters:

type\-Arg of type {\bf DOMString}{\rm (p.\,\pageref{classDOM_1_1DOMString})} Specifies the event type. can\-Bubble\-Arg of type boolean Specifies whether or not the event can bubble. cancelable\-Arg of type boolean Specifies whether or not the event's default action can be prevent. view\-Arg of type views::Abstract\-View Specifies the Text\-Event's {\bf Abstract\-View}{\rm (p.\,\pageref{classDOM_1_1AbstractView})}. detail\-Arg of type unsigned short Specifies the number of repeated keypresses, if available. output\-String\-Arg of type {\bf DOMString}{\rm (p.\,\pageref{classDOM_1_1DOMString})} Specifies the Text\-Event's output\-String attribute key\-Val\-Arg of type unsigned long Specifies the Text\-Event's key\-Valattribute virt\-Key\-Val\-Arg of type unsigned long Specifies the Text\-Event's virt\-Key\-Valattribute input\-Generated\-Arg of type boolean Specifies the Text\-Event's input\-Generatedattribute num\-Pad\-Arg of type boolean Specifies the Text\-Event's num\-Padattribute

No Return Value. No Exceptions. 

Definition at line 459 of file dom2\_\-events.cpp.\index{DOM::TextEvent@{DOM::Text\-Event}!initModifier@{initModifier}}
\index{initModifier@{initModifier}!DOM::TextEvent@{DOM::Text\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Text\-Event::init\-Modifier (unsigned long {\em modifier\-Arg}, bool {\em value\-Arg})}\label{classDOM_1_1TextEvent_a7}


init\-Modifier 

The init\-Modifier method is used to initialize the values of any modifiers associated with a {\bf Text\-Event}{\rm (p.\,\pageref{classDOM_1_1TextEvent})} created through the Document\-Event interface. This method may only be called before the {\bf Text\-Event}{\rm (p.\,\pageref{classDOM_1_1TextEvent})} has been dispatched via the dispatch\-Event method, though it may be called multiple times during that phase if necessary. If called multiple times with the same modifier property the final invocation takes precedence. Unless explicitly give a value of true, all modifiers have a value of false. This method has no effect if called after the event has been dispatched. The list of keys below represents the allowable modifier paramaters for this method: DOM\_\-VK\_\-LEFT\_\-ALT DOM\_\-VK\_\-RIGHT\_\-ALT DOM\_\-VK\_\-LEFT\_\-CONTROL DOM\_\-VK\_\-RIGHT\_\-CONTROL DOM\_\-VK\_\-LEFT\_\-SHIFT DOM\_\-VK\_\-RIGHT\_\-SHIFT DOM\_\-VK\_\-META

Parameters:

modifier of type unsigned long The modifier which the user wishes to initialize value of type boolean The new value of the modifier.

No Return Value No Exceptions 

Definition at line 500 of file dom2\_\-events.cpp.\index{DOM::TextEvent@{DOM::Text\-Event}!inputGenerated@{inputGenerated}}
\index{inputGenerated@{inputGenerated}!DOM::TextEvent@{DOM::Text\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Text\-Event::input\-Generated () const}\label{classDOM_1_1TextEvent_a8}


input\-Generated of type boolean 

The input\-Generated attribute indicates whether the key event will normally cause visible output. If the key event does not generate any visible output, such as the use of a function key or the combination of certain modifier keys used in conjunction with another key, then the value will be false. If visible output is normally generated by the key event then the value will be true. The value of input\-Generated does not guarantee the creation of a character. If a key event causing visible output is cancelable it may be prevented from causing output. This attribute is intended primarily to differentiate between keys events which may or may not produce visible output depending on the system state. 

Definition at line 516 of file dom2\_\-events.cpp.\index{DOM::TextEvent@{DOM::Text\-Event}!keyVal@{keyVal}}
\index{keyVal@{keyVal}!DOM::TextEvent@{DOM::Text\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned long Text\-Event::key\-Val () const}\label{classDOM_1_1TextEvent_a9}


key\-Val of type unsigned long 

The value of key\-Val holds the value of the Unicode character associated with the depressed key. If the key has no Unicode representation or no Unicode character is available the value is 0. 

Definition at line 476 of file dom2\_\-events.cpp.\index{DOM::TextEvent@{DOM::Text\-Event}!numPad@{numPad}}
\index{numPad@{numPad}!DOM::TextEvent@{DOM::Text\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Text\-Event::num\-Pad () const}\label{classDOM_1_1TextEvent_a10}


num\-Pad of type boolean 

The num\-Pad attribute indicates whether or not the key event was generated on the number pad section of the keyboard. If the number pad was used to generate the key event the value is true, otherwise the value is false. 

Definition at line 524 of file dom2\_\-events.cpp.\index{DOM::TextEvent@{DOM::Text\-Event}!outputString@{outputString}}
\index{outputString@{outputString}!DOM::TextEvent@{DOM::Text\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf DOMString} Text\-Event::output\-String () const}\label{classDOM_1_1TextEvent_a11}


output\-String of type {\bf DOMString}{\rm (p.\,\pageref{classDOM_1_1DOMString})} 

output\-String holds the value of the output generated by the key event. This may be a single Unicode character or it may be a string. It may also be null in the case where no output was generated by the key event. 

Definition at line 484 of file dom2\_\-events.cpp.\index{DOM::TextEvent@{DOM::Text\-Event}!virtKeyVal@{virtKeyVal}}
\index{virtKeyVal@{virtKeyVal}!DOM::TextEvent@{DOM::Text\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned long Text\-Event::virt\-Key\-Val () const}\label{classDOM_1_1TextEvent_a12}


virt\-Key\-Val of type unsigned long 

When the key associated with a key event is not representable via a Unicode character virt\-Key\-Vale holds the virtual key code associated with the depressed key. If the key has a Unicode representation or no virtual code is available the value is DOM\_\-VK\_\-UNDEFINED. 

Definition at line 492 of file dom2\_\-events.cpp.\index{DOM::TextEvent@{DOM::Text\-Event}!checkModifier@{checkModifier}}
\index{checkModifier@{checkModifier}!DOM::TextEvent@{DOM::Text\-Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Text\-Event::check\-Modifier (unsigned long {\em modifer\-Arg})}\label{classDOM_1_1TextEvent_a13}


check\-Modifier 

Note: the below description does not match the actual behaviour. it's extended in a way that you can query multiple modifiers at once by logically OR`ing them. also, we use the {\bf Qt} modifier enum instead of the {\bf DOM}{\rm (p.\,\pageref{namespaceDOM})} one.

The Check\-Modifier method is used to check the status of a single modifier key associated with a {\bf Text\-Event}{\rm (p.\,\pageref{classDOM_1_1TextEvent})}. The identifier of the modifier in question is passed into the Check\-Modifier function. If the modifier is triggered it will return true. If not, it will return false. The list of keys below represents the allowable modifier paramaters for this method: DOM\_\-VK\_\-LEFT\_\-ALT DOM\_\-VK\_\-RIGHT\_\-ALT DOM\_\-VK\_\-LEFT\_\-CONTROL DOM\_\-VK\_\-RIGHT\_\-CONTROL DOM\_\-VK\_\-LEFT\_\-SHIFT DOM\_\-VK\_\-RIGHT\_\-SHIFT DOM\_\-VK\_\-META

Parameters:

modifer of type unsigned long The modifier which the user wishes to query.

Return Value: boolean The status of the modifier represented as a boolean.

No Exceptions 

Definition at line 508 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}
