\section{KKey\-Server::Sym Struct Reference}
\label{structKKeyServer_1_1Sym}\index{KKeyServer::Sym@{KKeyServer::Sym}}
Represents a key symbol.  


{\tt \#include $<$kkeyserver\_\-x11.h$>$}

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Sym} ()
\item 
{\bf Sym} (uint sym)
\item 
{\bf Sym} (const {\bf QString} \&s)
\item 
bool {\bf init\-Qt} (int key\-Qt)
\item 
bool {\bf init} (const {\bf QString} \&s)
\item 
int {\bf qt} () const 
\item 
{\bf QString} {\bf to\-String\-Internal} () const \label{structKKeyServer_1_1Sym_a6}

\item 
{\bf QString} {\bf to\-String} () const 
\item 
uint {\bf get\-Mods\-Required} () const 
\item 
uint {\bf get\-Sym\-Variation} () const 
\item 
{\bf operator uint} () const 
\item 
{\bf Sym} \& {\bf operator=} (uint sym)
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
uint {\bf m\_\-sym}
\end{CompactItemize}


\subsection{Detailed Description}
Represents a key symbol. 

\begin{Desc}
\item[See also:]{\bf KKey}{\rm (p.\,\pageref{classKKey})} 

{\bf KKey\-Server}{\rm (p.\,\pageref{namespaceKKeyServer})}\end{Desc}




Definition at line 47 of file kkeyserver\_\-x11.h.

\subsection{Constructor \& Destructor Documentation}
\index{KKeyServer::Sym@{KKey\-Server::Sym}!Sym@{Sym}}
\index{Sym@{Sym}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KKey\-Server::Sym::Sym ()\hspace{0.3cm}{\tt  [inline]}}\label{structKKeyServer_1_1Sym_a0}


Creates a null symbol. 



Definition at line 54 of file kkeyserver\_\-x11.h.\index{KKeyServer::Sym@{KKey\-Server::Sym}!Sym@{Sym}}
\index{Sym@{Sym}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KKey\-Server::Sym::Sym (uint {\em sym})\hspace{0.3cm}{\tt  [inline]}}\label{structKKeyServer_1_1Sym_a1}


Creates asymbol with the given value. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em sym}]the value\end{description}
\end{Desc}


Definition at line 60 of file kkeyserver\_\-x11.h.\index{KKeyServer::Sym@{KKey\-Server::Sym}!Sym@{Sym}}
\index{Sym@{Sym}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KKey\-Server::Sym::Sym (const {\bf QString} \& {\em s})\hspace{0.3cm}{\tt  [inline]}}\label{structKKeyServer_1_1Sym_a2}


Creates a symbol from the given string description. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]the description of the symbol \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf to\-String()}{\rm (p.\,\pageref{structKKeyServer_1_1Sym_a7})}\end{Desc}


Definition at line 67 of file kkeyserver\_\-x11.h.

\subsection{Member Function Documentation}
\index{KKeyServer::Sym@{KKey\-Server::Sym}!initQt@{initQt}}
\index{initQt@{initQt}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KKey\-Server::Sym::init\-Qt (int {\em key\-Qt})}\label{structKKeyServer_1_1Sym_a3}


Initializes the symbol with the given {\bf Qt} key code. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em key\-Qt}]the qt key code \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]true if successful, false otherwise \end{Desc}
\begin{Desc}
\item[See also:]Qt::Key\end{Desc}


Definition at line 404 of file kkeyserver\_\-x11.cpp.

References endl(), QString::lower(), m\_\-sym, QString::number(), and QString::unicode().

Referenced by KKey\-Server::key\-Qt\-To\-Sym().\index{KKeyServer::Sym@{KKey\-Server::Sym}!init@{init}}
\index{init@{init}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KKey\-Server::Sym::init (const {\bf QString} \& {\em s})}\label{structKKeyServer_1_1Sym_a4}


Initializes the key with the given string description. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em s}]the string description \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]true if successful, false otherwise \end{Desc}
\begin{Desc}
\item[See also:]{\bf to\-String()}{\rm (p.\,\pageref{structKKeyServer_1_1Sym_a7})}\end{Desc}


Definition at line 435 of file kkeyserver\_\-x11.cpp.

References QString::latin1(), m\_\-sym, and QString::upper().\index{KKeyServer::Sym@{KKey\-Server::Sym}!qt@{qt}}
\index{qt@{qt}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KKey\-Server::Sym::qt () const}\label{structKKeyServer_1_1Sym_a5}


Returns the qt key code of the symbol. 

\begin{Desc}
\item[Returns:]the qt key code\end{Desc}


Definition at line 475 of file kkeyserver\_\-x11.cpp.

References m\_\-sym, and QString::upper().

Referenced by KKey\-Server::sym\-To\-Key\-Qt().\index{KKeyServer::Sym@{KKey\-Server::Sym}!toString@{toString}}
\index{toString@{toString}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KKey\-Server::Sym::to\-String () const}\label{structKKeyServer_1_1Sym_a7}


Returns the string representation of the symbol. 

\begin{Desc}
\item[Returns:]the string representation of the symbol\end{Desc}


Definition at line 533 of file kkeyserver\_\-x11.cpp.\index{KKeyServer::Sym@{KKey\-Server::Sym}!getModsRequired@{getModsRequired}}
\index{getModsRequired@{getModsRequired}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint KKey\-Server::Sym::get\-Mods\-Required () const}\label{structKKeyServer_1_1Sym_a8}


Returns the mods that are required for this symbol as ORed {\bf KKey::Mod\-Flag}{\rm (p.\,\pageref{classKKey_w8})}'s. 

For example, Break requires a Ctrl to be valid. \begin{Desc}
\item[Returns:]the required {\bf KKey::Mod\-Flag}{\rm (p.\,\pageref{classKKey_w8})}'s \end{Desc}
\begin{Desc}
\item[See also:]{\bf KKey::Mod\-Flag}{\rm (p.\,\pageref{classKKey_w8})}\end{Desc}


Definition at line 535 of file kkeyserver\_\-x11.cpp.

References QChar::is\-Letter(), QChar::lower(), m\_\-sym, QChar::unicode(), and QChar::upper().\index{KKeyServer::Sym@{KKey\-Server::Sym}!getSymVariation@{getSymVariation}}
\index{getSymVariation@{getSymVariation}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint KKey\-Server::Sym::get\-Sym\-Variation () const}\label{structKKeyServer_1_1Sym_a9}


TODO: please find out what this method does and document it. 



Definition at line 567 of file kkeyserver\_\-x11.cpp.

References m\_\-sym.\index{KKeyServer::Sym@{KKey\-Server::Sym}!operator uint@{operator uint}}
\index{operator uint@{operator uint}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KKey\-Server::Sym::operator uint () const\hspace{0.3cm}{\tt  [inline]}}\label{structKKeyServer_1_1Sym_a10}


Casts the symbol to its integer representation. 



Definition at line 120 of file kkeyserver\_\-x11.h.\index{KKeyServer::Sym@{KKey\-Server::Sym}!operator=@{operator=}}
\index{operator=@{operator=}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Sym}\& KKey\-Server::Sym::operator= (uint {\em sym})\hspace{0.3cm}{\tt  [inline]}}\label{structKKeyServer_1_1Sym_a11}


Overloaded operator to convert ints to {\bf Sym}{\rm (p.\,\pageref{structKKeyServer_1_1Sym})}. 



Definition at line 125 of file kkeyserver\_\-x11.h.

\subsection{Member Data Documentation}
\index{KKeyServer::Sym@{KKey\-Server::Sym}!m_sym@{m\_\-sym}}
\index{m_sym@{m\_\-sym}!KKeyServer::Sym@{KKey\-Server::Sym}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint {\bf KKey\-Server::Sym::m\_\-sym}}\label{structKKeyServer_1_1Sym_o0}


the actual value of the symbol 



Definition at line 51 of file kkeyserver\_\-x11.h.

Referenced by get\-Mods\-Required(), get\-Sym\-Variation(), KKey::init(), init(), init\-Qt(), KKey\-Server::key\-Qt\-To\-Sym(), and qt().

The documentation for this struct was generated from the following files:\begin{CompactItemize}
\item 
kkeyserver\_\-x11.h\item 
kkeyserver\_\-x11.cpp\end{CompactItemize}
