\section{Kate\-Syntax\-Document Class Reference}
\label{classKateSyntaxDocument}\index{KateSyntaxDocument@{KateSyntaxDocument}}
Store and manage the information about Syntax Highlighting.  


{\tt \#include $<$katesyntaxdocument.h$>$}

Inheritance diagram for Kate\-Syntax\-Document:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=74pt]{classKateSyntaxDocument__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for Kate\-Syntax\-Document:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=248pt]{classKateSyntaxDocument__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Kate\-Syntax\-Document} (bool force=false)
\item 
{\bf $\sim$Kate\-Syntax\-Document} ()
\item 
bool {\bf set\-Identifier} (const {\bf QString} \&identifier)
\item 
const {\bf Kate\-Syntax\-Mode\-List} \& {\bf mode\-List} ()
\item 
bool {\bf next\-Group} ({\bf Kate\-Syntax\-Context\-Data} $\ast$data)
\item 
bool {\bf next\-Item} ({\bf Kate\-Syntax\-Context\-Data} $\ast$data)
\item 
{\bf QString} {\bf group\-Item\-Data} (const {\bf Kate\-Syntax\-Context\-Data} $\ast$data, const {\bf QString} \&name)
\item 
{\bf QString} {\bf group\-Data} (const {\bf Kate\-Syntax\-Context\-Data} $\ast$data, const {\bf QString} \&name)\label{classKateSyntaxDocument_a7}

\item 
void {\bf free\-Group\-Info} ({\bf Kate\-Syntax\-Context\-Data} $\ast$data)\label{classKateSyntaxDocument_a8}

\item 
{\bf Kate\-Syntax\-Context\-Data} $\ast$ {\bf get\-Sub\-Items} ({\bf Kate\-Syntax\-Context\-Data} $\ast$data)\label{classKateSyntaxDocument_a9}

\item 
{\bf Kate\-Syntax\-Context\-Data} $\ast$ {\bf get\-Config} (const {\bf QString} \&main\-Group\-Name, const {\bf QString} \&config)
\item 
{\bf Kate\-Syntax\-Context\-Data} $\ast$ {\bf get\-Group\-Info} (const {\bf QString} \&main\-Group\-Name, const {\bf QString} \&group)
\item 
{\bf QString\-List} \& {\bf finddata} (const {\bf QString} \&main\-Group, const {\bf QString} \&type, bool clear\-List=true)
\end{CompactItemize}


\subsection{Detailed Description}
Store and manage the information about Syntax Highlighting. 



Definition at line 64 of file katesyntaxdocument.h.

\subsection{Constructor \& Destructor Documentation}
\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!KateSyntaxDocument@{KateSyntaxDocument}}
\index{KateSyntaxDocument@{KateSyntaxDocument}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Kate\-Syntax\-Document::Kate\-Syntax\-Document (bool {\em force} = {\tt false})}\label{classKateSyntaxDocument_a0}


Constructor Sets the current file to nothing and build the Mode\-List (katesyntaxhighlightingrc). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em force}]fore the update of the hl cache \end{description}
\end{Desc}


Definition at line 34 of file katesyntaxdocument.cpp.\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!~KateSyntaxDocument@{$\sim$KateSyntaxDocument}}
\index{~KateSyntaxDocument@{$\sim$KateSyntaxDocument}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Kate\-Syntax\-Document::$\sim${\bf Kate\-Syntax\-Document} ()}\label{classKateSyntaxDocument_a1}


Desctructor. 



Definition at line 41 of file katesyntaxdocument.cpp.

References QValue\-List::size().

\subsection{Member Function Documentation}
\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!setIdentifier@{setIdentifier}}
\index{setIdentifier@{setIdentifier}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Kate\-Syntax\-Document::set\-Identifier (const {\bf QString} \& {\em identifier})}\label{classKateSyntaxDocument_a2}


If the open hl file is different from the one needed, it opens the new one and assign some other things. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em identifier}]file name and path of the new xml needed \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]success \end{Desc}


Definition at line 51 of file katesyntaxdocument.cpp.

References QFile::close(), KMessage\-Box::error(), QFile::open(), QDom\-Document::set\-Content(), and QString::utf8().\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!modeList@{modeList}}
\index{modeList@{modeList}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf Kate\-Syntax\-Mode\-List}\& Kate\-Syntax\-Document::mode\-List ()\hspace{0.3cm}{\tt  [inline]}}\label{classKateSyntaxDocument_a3}


Get the mode list. 

\begin{Desc}
\item[Returns:]mode list \end{Desc}


Definition at line 91 of file katesyntaxdocument.h.\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!nextGroup@{nextGroup}}
\index{nextGroup@{nextGroup}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Kate\-Syntax\-Document::next\-Group ({\bf Kate\-Syntax\-Context\-Data} $\ast$ {\em data})}\label{classKateSyntaxDocument_a4}


Jump to the next group, Kate\-Syntax\-Context\-Data::current\-Group will point to the next group. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em data}]context \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]success \end{Desc}


Definition at line 94 of file katesyntaxdocument.cpp.

References QDom\-Node::is\-Comment(), QDom\-Node::is\-Null(), QDom\-Node::next\-Sibling(), and QDom\-Node::to\-Element().\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!nextItem@{nextItem}}
\index{nextItem@{nextItem}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Kate\-Syntax\-Document::next\-Item ({\bf Kate\-Syntax\-Context\-Data} $\ast$ {\em data})}\label{classKateSyntaxDocument_a5}


Jump to the next item, Kate\-Syntax\-Context\-Data::item will point to the next item. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em data}]context \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]success \end{Desc}


Definition at line 125 of file katesyntaxdocument.cpp.

References QDom\-Node::first\-Child(), QDom\-Node::is\-Comment(), QDom\-Node::is\-Null(), QDom\-Node::next\-Sibling(), and QDom\-Node::to\-Element().\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!groupItemData@{groupItemData}}
\index{groupItemData@{groupItemData}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Kate\-Syntax\-Document::group\-Item\-Data (const {\bf Kate\-Syntax\-Context\-Data} $\ast$ {\em data}, const {\bf QString} \& {\em name})}\label{classKateSyntaxDocument_a6}


This function is used to fetch the atributes of the tags. 



Definition at line 153 of file katesyntaxdocument.cpp.

References QString::is\-Empty().\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!getConfig@{getConfig}}
\index{getConfig@{getConfig}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Kate\-Syntax\-Context\-Data} $\ast$ Kate\-Syntax\-Document::get\-Config (const {\bf QString} \& {\em main\-Group\-Name}, const {\bf QString} \& {\em config})}\label{classKateSyntaxDocument_a10}


Get the {\bf Kate\-Syntax\-Context\-Data}{\rm (p.\,\pageref{classKateSyntaxContextData})} of the Dom\-Element Config inside main\-Group\-Name It just fills Kate\-Syntax\-Context\-Data::item. 



Definition at line 247 of file katesyntaxdocument.cpp.

References Kate\-Syntax\-Context\-Data::item.\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!getGroupInfo@{getGroupInfo}}
\index{getGroupInfo@{getGroupInfo}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Kate\-Syntax\-Context\-Data} $\ast$ Kate\-Syntax\-Document::get\-Group\-Info (const {\bf QString} \& {\em main\-Group\-Name}, const {\bf QString} \& {\em group})}\label{classKateSyntaxDocument_a11}


Get the {\bf Kate\-Syntax\-Context\-Data}{\rm (p.\,\pageref{classKateSyntaxContextData})} of the {\bf QDom\-Element} Config inside main\-Group\-Name Kate\-Syntax\-Context\-Data::parent will contain the {\bf QDom\-Element} found. 



Definition at line 263 of file katesyntaxdocument.cpp.

References Kate\-Syntax\-Context\-Data::parent.\index{KateSyntaxDocument@{Kate\-Syntax\-Document}!finddata@{finddata}}
\index{finddata@{finddata}!KateSyntaxDocument@{Kate\-Syntax\-Document}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString\-List} \& Kate\-Syntax\-Document::finddata (const {\bf QString} \& {\em main\-Group}, const {\bf QString} \& {\em type}, bool {\em clear\-List} = {\tt true})}\label{classKateSyntaxDocument_a12}


Returns a list with all the keywords inside the list type. 



Definition at line 278 of file katesyntaxdocument.cpp.

References QDom\-Node\-List::count(), QDom\-Document::document\-Element(), QDom\-Element::elements\-By\-Tag\-Name(), endl(), QString::is\-Empty(), QDom\-Node::is\-Null(), QDom\-Node\-List::item(), kd\-Debug(), QDom\-Node::next\-Sibling(), QDom\-Element::tag\-Name(), and QDom\-Node::to\-Element().

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