KateSyntaxDocument Class Reference

#include <katesyntaxdocument.h>

Inherits QDomDocument.

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)

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