kate Library API Documentation

SyntaxDocument Class Reference

Store and manage the information about Syntax Highlighting. More...

#include <katesyntaxdocument.h>

Inheritance diagram for SyntaxDocument:

QDomDocument List of all members.

Public Member Functions

 SyntaxDocument (bool force=false)
 ~SyntaxDocument ()
bool setIdentifier (const QString &identifier)
SyntaxModeList modeList ()
bool nextGroup (syntaxContextData *data)
bool nextItem (syntaxContextData *data)
QString groupItemData (const syntaxContextData *data, const QString &name)
QString groupData (const syntaxContextData *data, const QString &name)
void freeGroupInfo (syntaxContextData *data)
syntaxContextDatagetSubItems (syntaxContextData *data)
syntaxContextDatagetConfig (const QString &mainGroupName, const QString &config)
syntaxContextDatagetGroupInfo (const QString &mainGroupName, const QString &group)
QStringListfinddata (const QString &mainGroup, const QString &type, bool clearList=true)

Detailed Description

Store and manage the information about Syntax Highlighting.

Definition at line 57 of file katesyntaxdocument.h.


Constructor & Destructor Documentation

SyntaxDocument::SyntaxDocument bool  force = false  ) 
 

Constructor: Sets the current file to nothing and build the ModeList (katesyntaxhighlightingrc).

Definition at line 33 of file katesyntaxdocument.cpp.

References QPtrList::setAutoDelete().

SyntaxDocument::~SyntaxDocument  ) 
 

Desctructor.

Definition at line 44 of file katesyntaxdocument.cpp.


Member Function Documentation

bool SyntaxDocument::setIdentifier const QString identifier  ) 
 

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

identifier = File name and path of the new xml needed

Definition at line 52 of file katesyntaxdocument.cpp.

References QFile::close(), KMessageBox::error(), QFile::open(), QDomDocument::setContent(), and QString::utf8().

SyntaxModeList SyntaxDocument::modeList  ) 
 

Get the mode list.

Definition at line 94 of file katesyntaxdocument.cpp.

bool SyntaxDocument::nextGroup syntaxContextData data  ) 
 

Jump to the next group, syntaxContextData::currentGroup will point to the next group.

Definition at line 102 of file katesyntaxdocument.cpp.

References syntaxContextData::currentGroup, QDomNode::isComment(), QDomNode::nextSibling(), syntaxContextData::parent, and QDomNode::toElement().

bool SyntaxDocument::nextItem syntaxContextData data  ) 
 

Jump to the next item, syntaxContextData::item will point to the next item.

Definition at line 133 of file katesyntaxdocument.cpp.

References syntaxContextData::currentGroup, QDomNode::isComment(), syntaxContextData::item, QDomNode::nextSibling(), and QDomNode::toElement().

QString SyntaxDocument::groupItemData const syntaxContextData data,
const QString name
 

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

Definition at line 161 of file katesyntaxdocument.cpp.

References QDomElement::attribute(), QString::isEmpty(), syntaxContextData::item, and QDomElement::tagName().

syntaxContextData * SyntaxDocument::getConfig const QString mainGroupName,
const QString config
 

Get the syntaxContextData of the DomElement Config inside mainGroupName It just fills syntaxContextData::item.

Definition at line 255 of file katesyntaxdocument.cpp.

References syntaxContextData::item.

syntaxContextData * SyntaxDocument::getGroupInfo const QString mainGroupName,
const QString group
 

Get the syntaxContextData of the QDomElement Config inside mainGroupName syntaxContextData::parent will contain the QDomElement found.

Definition at line 271 of file katesyntaxdocument.cpp.

References syntaxContextData::parent.

QStringList & SyntaxDocument::finddata const QString mainGroup,
const QString type,
bool  clearList = true
 

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

Definition at line 286 of file katesyntaxdocument.cpp.

References QDomNodeList::count(), QDomDocument::documentElement(), QDomElement::elementsByTagName(), QString::isEmpty(), QDomNode::isNull(), QDomNodeList::item(), kdDebug(), QDomNode::nextSibling(), QDomElement::tagName(), and QDomNode::toElement().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kate Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed May 5 07:22:36 2004 by doxygen 1.3.6 written by Dimitri van Heesch, © 1997-2003