KateSyntaxDocument Class Reference

#include <katesyntaxdocument.h>

Inheritance diagram for KateSyntaxDocument:

Public Member Functions
	KateSyntaxDocument (KConfig *config, bool force=false)
	~KateSyntaxDocument ()
QStringList &	finddata (const QString &mainGroup, const QString &type, bool clearList=true)
void	freeGroupInfo (KateSyntaxContextData *data)
KateSyntaxContextData *	getConfig (const QString &mainGroupName, const QString &config)
KateSyntaxContextData *	getGroupInfo (const QString &mainGroupName, const QString &group)
KateSyntaxContextData *	getSubItems (KateSyntaxContextData *data)
QString	groupData (const KateSyntaxContextData *data, const QString &name)
QString	groupItemData (const KateSyntaxContextData *data, const QString &name)
const KateSyntaxModeList &	modeList ()
bool	nextGroup (KateSyntaxContextData *data)
bool	nextItem (KateSyntaxContextData *data)
bool	setIdentifier (const QString &identifier)
Public Member Functions inherited from QDomDocument
	QDomDocument ()
	QDomDocument (const QString &name)
	QDomDocument (const QDomDocument &x)
	QDomDocument (const QDomDocumentType &doctype)
	~QDomDocument ()
QDomAttr	createAttribute (const QString &name)
QDomAttr	createAttributeNS (const QString &nsURI, const QString &qName)
QDomCDATASection	createCDATASection (const QString &value)
QDomComment	createComment (const QString &value)
QDomDocumentFragment	createDocumentFragment ()
QDomElement	createElement (const QString &tagName)
QDomElement	createElementNS (const QString &nsURI, const QString &qName)
QDomEntityReference	createEntityReference (const QString &name)
QDomProcessingInstruction	createProcessingInstruction (const QString &target, const QString &data)
QDomText	createTextNode (const QString &value)
QDomDocumentType	doctype () const
QDomElement	documentElement () const
QDomElement	elementById (const QString &elementId)
QDomNodeList	elementsByTagName (const QString &tagname) const
QDomNodeList	elementsByTagNameNS (const QString &nsURI, const QString &localName)
QDomImplementation	implementation () const
QDomNode	importNode (const QDomNode &importedNode, bool deep)
QDomNode::NodeType	nodeType () const
QDomDocument &	operator= (const QDomDocument &x)
bool	setContent (QXmlInputSource *source, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)
bool	setContent (const QByteArray &buffer, QString *errorMsg, int *errorLine, int *errorColumn)
bool	setContent (QIODevice *dev, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)
bool	setContent (QIODevice *dev, QString *errorMsg, int *errorLine, int *errorColumn)
bool	setContent (const QString &text, QString *errorMsg, int *errorLine, int *errorColumn)
bool	setContent (const QByteArray &data, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)
bool	setContent (const QString &text, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)
bool	setContent (QXmlInputSource *source, QXmlReader *reader, QString *errorMsg, int *errorLine, int *errorColumn)
QByteArray	toByteArray (int indent) const
QString	toString (int indent) const
Public Member Functions inherited from QDomNode
	QDomNode ()
	QDomNode (const QDomNode &n)
	~QDomNode ()
QDomNode	appendChild (const QDomNode &newChild)
QDomNamedNodeMap	attributes () const
QDomNodeList	childNodes () const
void	clear ()
QDomNode	cloneNode (bool deep) const
int	columnNumber () const
QDomNode	firstChild () const
QDomElement	firstChildElement (const QString &tagName) const
bool	hasAttributes () const
bool	hasChildNodes () const
QDomNode	insertAfter (const QDomNode &newChild, const QDomNode &refChild)
QDomNode	insertBefore (const QDomNode &newChild, const QDomNode &refChild)
bool	isAttr () const
bool	isCDATASection () const
bool	isCharacterData () const
bool	isComment () const
bool	isDocument () const
bool	isDocumentFragment () const
bool	isDocumentType () const
bool	isElement () const
bool	isEntity () const
bool	isEntityReference () const
bool	isNotation () const
bool	isNull () const
bool	isProcessingInstruction () const
bool	isSupported (const QString &feature, const QString &version) const
bool	isText () const
QDomNode	lastChild () const
QDomElement	lastChildElement (const QString &tagName) const
int	lineNumber () const
QString	localName () const
QDomNode	namedItem (const QString &name) const
QString	namespaceURI () const
QDomNode	nextSibling () const
QDomElement	nextSiblingElement (const QString &tagName) const
QString	nodeName () const
NodeType	nodeType () const
QString	nodeValue () const
void	normalize ()
bool	operator!= (const QDomNode &n) const
QDomNode &	operator= (const QDomNode &n)
bool	operator== (const QDomNode &n) const
QDomDocument	ownerDocument () const
QDomNode	parentNode () const
QString	prefix () const
QDomNode	previousSibling () const
QDomElement	previousSiblingElement (const QString &tagName) const
QDomNode	removeChild (const QDomNode &oldChild)
QDomNode	replaceChild (const QDomNode &newChild, const QDomNode &oldChild)
void	save (QTextStream &str, int indent) const
void	save (QTextStream &str, int indent, EncodingPolicy encodingPolicy) const
void	setNodeValue (const QString &v)
void	setPrefix (const QString &pre)
QDomAttr	toAttr () const
QDomCDATASection	toCDATASection () const
QDomCharacterData	toCharacterData () const
QDomComment	toComment () const
QDomDocument	toDocument () const
QDomDocumentFragment	toDocumentFragment () const
QDomDocumentType	toDocumentType () const
QDomElement	toElement () const
QDomEntity	toEntity () const
QDomEntityReference	toEntityReference () const
QDomNotation	toNotation () const
QDomProcessingInstruction	toProcessingInstruction () const
QDomText	toText () const

Detailed Description

Store and manage the information about Syntax Highlighting.

Definition at line 73 of file katesyntaxdocument.h.

Constructor & Destructor Documentation

KateSyntaxDocument::KateSyntaxDocument ( KConfig *  config, bool  force = false  )

explicit

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

Parameters

force

fore the update of the hl cache

Definition at line 41 of file katesyntaxdocument.cpp.

KateSyntaxDocument::~KateSyntaxDocument

(

)

Desctructor.

Definition at line 49 of file katesyntaxdocument.cpp.

Member Function Documentation

QStringList & KateSyntaxDocument::finddata	(	const QString &	mainGroup,
		const QString &	type,
		bool	clearList = true
	)

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

Definition at line 293 of file katesyntaxdocument.cpp.

void KateSyntaxDocument::freeGroupInfo

(

KateSyntaxContextData *

data

)

Definition at line 196 of file katesyntaxdocument.cpp.

KateSyntaxContextData * KateSyntaxDocument::getConfig	(	const QString &	mainGroupName,
		const QString &	config
	)

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

Get the KateSyntaxContextData of the QDomElement Config inside mainGroupName KateSyntaxContextData::item will contain the QDomElement found.

Definition at line 262 of file katesyntaxdocument.cpp.

KateSyntaxContextData * KateSyntaxDocument::getGroupInfo	(	const QString &	mainGroupName,
		const QString &	group
	)

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

Definition at line 278 of file katesyntaxdocument.cpp.

KateSyntaxContextData * KateSyntaxDocument::getSubItems

(

KateSyntaxContextData *

data

)

Definition at line 201 of file katesyntaxdocument.cpp.

QString KateSyntaxDocument::groupData	(	const KateSyntaxContextData *	data,
		const QString &	name
	)

Definition at line 181 of file katesyntaxdocument.cpp.

QString KateSyntaxDocument::groupItemData	(	const KateSyntaxContextData *	data,
		const QString &	name
	)

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

This function is used to fetch the atributes of the tags of the item in a KateSyntaxContextData.

Definition at line 161 of file katesyntaxdocument.cpp.

const KateSyntaxModeList& KateSyntaxDocument::modeList ( )

inline

Get the mode list.

Returns

mode list

Definition at line 100 of file katesyntaxdocument.h.

bool KateSyntaxDocument::nextGroup

(

KateSyntaxContextData *

data

)

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

Parameters

data

context

Returns

success

Definition at line 102 of file katesyntaxdocument.cpp.

bool KateSyntaxDocument::nextItem

(

KateSyntaxContextData *

data

)

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

Parameters

data

context

Returns

success

Definition at line 133 of file katesyntaxdocument.cpp.

bool KateSyntaxDocument::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.

Parameters

identifier

file name and path of the new xml needed

Returns

success

identifier = File name and path of the new xml needed

Definition at line 59 of file katesyntaxdocument.cpp.

---

The documentation for this class was generated from the following files:

• katesyntaxdocument.h
• katesyntaxdocument.cpp