.TH "KateSyntaxDocument" kde3 "11 Jun 2005" "Version Version 3.4.1" "kate Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KateSyntaxDocument \- Store and manage the information about Syntax Highlighting.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <katesyntaxdocument.h>\fP
.PP
Inherits \fBQDomDocument\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKateSyntaxDocument\fP (bool force=false)"
.br
.ti -1c
.RI "\fB~KateSyntaxDocument\fP ()"
.br
.ti -1c
.RI "bool \fBsetIdentifier\fP (const \fBQString\fP &identifier)"
.br
.ti -1c
.RI "const \fBKateSyntaxModeList\fP & \fBmodeList\fP ()"
.br
.ti -1c
.RI "bool \fBnextGroup\fP (\fBKateSyntaxContextData\fP *data)"
.br
.ti -1c
.RI "bool \fBnextItem\fP (\fBKateSyntaxContextData\fP *data)"
.br
.ti -1c
.RI "\fBQString\fP \fBgroupItemData\fP (const \fBKateSyntaxContextData\fP *data, const \fBQString\fP &name)"
.br
.ti -1c
.RI "\fBQString\fP \fBgroupData\fP (const \fBKateSyntaxContextData\fP *data, const \fBQString\fP &name)"
.br
.ti -1c
.RI "void \fBfreeGroupInfo\fP (\fBKateSyntaxContextData\fP *data)"
.br
.ti -1c
.RI "\fBKateSyntaxContextData\fP * \fBgetSubItems\fP (\fBKateSyntaxContextData\fP *data)"
.br
.ti -1c
.RI "\fBKateSyntaxContextData\fP * \fBgetConfig\fP (const \fBQString\fP &mainGroupName, const \fBQString\fP &config)"
.br
.ti -1c
.RI "\fBKateSyntaxContextData\fP * \fBgetGroupInfo\fP (const \fBQString\fP &mainGroupName, const \fBQString\fP &group)"
.br
.ti -1c
.RI "\fBQStringList\fP & \fBfinddata\fP (const \fBQString\fP &mainGroup, const \fBQString\fP &type, bool clearList=true)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Store and manage the information about Syntax Highlighting. 
.PP
Definition at line 64 of file katesyntaxdocument.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KateSyntaxDocument::KateSyntaxDocument (bool force = \fCfalse\fP)"
.PP
Constructor Sets the current file to nothing and build the ModeList (katesyntaxhighlightingrc). 
.PP
\fBParameters:\fP
.RS 4
\fIforce\fP fore the update of the hl cache 
.RE
.PP

.PP
Definition at line 34 of file katesyntaxdocument.cpp.
.SS "KateSyntaxDocument::~\fBKateSyntaxDocument\fP ()"
.PP
Desctructor. 
.PP
Definition at line 41 of file katesyntaxdocument.cpp.
.PP
References QValueList::size().
.SH "Member Function Documentation"
.PP 
.SS "bool KateSyntaxDocument::setIdentifier (const \fBQString\fP & identifier)"
.PP
If the open hl file is different from the one needed, it opens the new one and assign some other things. 
.PP
\fBParameters:\fP
.RS 4
\fIidentifier\fP file name and path of the new xml needed 
.RE
.PP
\fBReturns:\fP
.RS 4
success 
.RE
.PP

.PP
Definition at line 51 of file katesyntaxdocument.cpp.
.PP
References QFile::close(), KMessageBox::error(), QFile::open(), QDomDocument::setContent(), and QString::utf8().
.SS "const \fBKateSyntaxModeList\fP& KateSyntaxDocument::modeList ()\fC [inline]\fP"
.PP
Get the mode list. 
.PP
\fBReturns:\fP
.RS 4
mode list 
.RE
.PP

.PP
Definition at line 91 of file katesyntaxdocument.h.
.SS "bool KateSyntaxDocument::nextGroup (\fBKateSyntaxContextData\fP * data)"
.PP
Jump to the next group, KateSyntaxContextData::currentGroup will point to the next group. 
.PP
\fBParameters:\fP
.RS 4
\fIdata\fP context 
.RE
.PP
\fBReturns:\fP
.RS 4
success 
.RE
.PP

.PP
Definition at line 94 of file katesyntaxdocument.cpp.
.PP
References QDomNode::isComment(), QDomNode::isNull(), QDomNode::nextSibling(), and QDomNode::toElement().
.SS "bool KateSyntaxDocument::nextItem (\fBKateSyntaxContextData\fP * data)"
.PP
Jump to the next item, KateSyntaxContextData::item will point to the next item. 
.PP
\fBParameters:\fP
.RS 4
\fIdata\fP context 
.RE
.PP
\fBReturns:\fP
.RS 4
success 
.RE
.PP

.PP
Definition at line 125 of file katesyntaxdocument.cpp.
.PP
References QDomNode::firstChild(), QDomNode::isComment(), QDomNode::isNull(), QDomNode::nextSibling(), and QDomNode::toElement().
.SS "\fBQString\fP KateSyntaxDocument::groupItemData (const \fBKateSyntaxContextData\fP * data, const \fBQString\fP & name)"
.PP
This function is used to fetch the atributes of the tags. 
.PP
Definition at line 153 of file katesyntaxdocument.cpp.
.PP
References QString::isEmpty().
.SS "\fBKateSyntaxContextData\fP * KateSyntaxDocument::getConfig (const \fBQString\fP & mainGroupName, const \fBQString\fP & config)"
.PP
Get the \fBKateSyntaxContextData\fP of the DomElement Config inside mainGroupName It just fills KateSyntaxContextData::item. 
.PP
Definition at line 247 of file katesyntaxdocument.cpp.
.PP
References KateSyntaxContextData::item.
.SS "\fBKateSyntaxContextData\fP * KateSyntaxDocument::getGroupInfo (const \fBQString\fP & mainGroupName, const \fBQString\fP & group)"
.PP
Get the \fBKateSyntaxContextData\fP of the \fBQDomElement\fP Config inside mainGroupName KateSyntaxContextData::parent will contain the \fBQDomElement\fP found. 
.PP
Definition at line 263 of file katesyntaxdocument.cpp.
.PP
References KateSyntaxContextData::parent.
.SS "\fBQStringList\fP & KateSyntaxDocument::finddata (const \fBQString\fP & mainGroup, const \fBQString\fP & type, bool clearList = \fCtrue\fP)"
.PP
Returns a list with all the keywords inside the list type. 
.PP
Definition at line 278 of file katesyntaxdocument.cpp.
.PP
References QDomNodeList::count(), QDomDocument::documentElement(), QDomElement::elementsByTagName(), endl(), QString::isEmpty(), QDomNode::isNull(), QDomNodeList::item(), kdDebug(), QDomNode::nextSibling(), QDomElement::tagName(), and QDomNode::toElement().

.SH "Author"
.PP 
Generated automatically by Doxygen for kate Library from the source code.
