KateSyntaxDocument Class Reference

#include <katesyntaxdocument.h>

Inherits TQDomDocument.

Public Member Functions
	KateSyntaxDocument (bool force=false)
	~KateSyntaxDocument ()
bool	setIdentifier (const TQString &identifier)
const KateSyntaxModeList &	modeList ()
bool	nextGroup (KateSyntaxContextData *data)
bool	nextItem (KateSyntaxContextData *data)
TQString	groupItemData (const KateSyntaxContextData *data, const TQString &name)
TQString	groupData (const KateSyntaxContextData *data, const TQString &name)
void	freeGroupInfo (KateSyntaxContextData *data)
KateSyntaxContextData *	getSubItems (KateSyntaxContextData *data)
KateSyntaxContextData *	getConfig (const TQString &mainGroupName, const TQString &config)
KateSyntaxContextData *	getGroupInfo (const TQString &mainGroupName, const TQString &group)
TQStringList &	finddata (const TQString &mainGroup, const TQString &type, bool clearList=true)

Detailed Description

Store and manage the information about Syntax Highlighting.

Definition at line 64 of file katesyntaxdocument.h.

Constructor & Destructor Documentation

KateSyntaxDocument()

KateSyntaxDocument::KateSyntaxDocument

(

bool

force = false

)

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

Parameters

force

fore the update of the hl cache

Definition at line 34 of file katesyntaxdocument.cpp.

~KateSyntaxDocument()

KateSyntaxDocument::~KateSyntaxDocument

(

)

Desctructor.

Definition at line 41 of file katesyntaxdocument.cpp.

Member Function Documentation

finddata()

TQStringList & KateSyntaxDocument::finddata	(	const TQString &	mainGroup,
		const TQString &	type,
		bool	clearList = true
	)

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

Definition at line 278 of file katesyntaxdocument.cpp.

freeGroupInfo()

void KateSyntaxDocument::freeGroupInfo

(

KateSyntaxContextData *

data

)

Definition at line 188 of file katesyntaxdocument.cpp.

getConfig()

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

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

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

Definition at line 247 of file katesyntaxdocument.cpp.

getGroupInfo()

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

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

Definition at line 263 of file katesyntaxdocument.cpp.

getSubItems()

KateSyntaxContextData * KateSyntaxDocument::getSubItems

(

KateSyntaxContextData *

data

)

Definition at line 194 of file katesyntaxdocument.cpp.

groupData()

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

Definition at line 173 of file katesyntaxdocument.cpp.

groupItemData()

TQString KateSyntaxDocument::groupItemData	(	const KateSyntaxContextData *	data,
		const TQString &	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 153 of file katesyntaxdocument.cpp.

modeList()

const KateSyntaxModeList & KateSyntaxDocument::modeList ( )

inline

Get the mode list.

Returns

mode list

Definition at line 91 of file katesyntaxdocument.h.

nextGroup()

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 94 of file katesyntaxdocument.cpp.

nextItem()

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 125 of file katesyntaxdocument.cpp.

setIdentifier()

bool KateSyntaxDocument::setIdentifier

(

const TQString &

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 51 of file katesyntaxdocument.cpp.

---

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

• katesyntaxdocument.h
• katesyntaxdocument.cpp