kate Library API Documentation

KateSyntaxDocument Class Reference

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

#include <katesyntaxdocument.h>

Inheritance diagram for KateSyntaxDocument:

Inheritance graph
[legend]
Collaboration diagram for KateSyntaxDocument:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 KateSyntaxDocument (bool force=false)
 ~KateSyntaxDocument ()
bool setIdentifier (const QString &identifier)
const KateSyntaxModeListmodeList ()
bool nextGroup (KateSyntaxContextData *data)
bool nextItem (KateSyntaxContextData *data)
QString groupItemData (const KateSyntaxContextData *data, const QString &name)
QString groupData (const KateSyntaxContextData *data, const QString &name)
void freeGroupInfo (KateSyntaxContextData *data)
KateSyntaxContextDatagetSubItems (KateSyntaxContextData *data)
KateSyntaxContextDatagetConfig (const QString &mainGroupName, const QString &config)
KateSyntaxContextDatagetGroupInfo (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 64 of file katesyntaxdocument.h.


Constructor & Destructor Documentation

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.

References KateSyntaxDocument().

Referenced by KateSyntaxDocument().

KateSyntaxDocument::~KateSyntaxDocument  ) 
 

Desctructor.

Definition at line 41 of file katesyntaxdocument.cpp.


Member Function Documentation

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

Definition at line 51 of file katesyntaxdocument.cpp.

References setIdentifier().

Referenced by setIdentifier().

const KateSyntaxModeList& KateSyntaxDocument::modeList  )  [inline]
 

Get the mode list.

Returns:
mode list

Definition at line 91 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 94 of file katesyntaxdocument.cpp.

References KateSyntaxContextData::currentGroup, nextGroup(), and KateSyntaxContextData::parent.

Referenced by nextGroup().

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.

References KateSyntaxContextData::currentGroup, KateSyntaxContextData::item, and nextItem().

Referenced by nextItem().

QString KateSyntaxDocument::groupItemData const KateSyntaxContextData data,
const QString name
 

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

Definition at line 153 of file katesyntaxdocument.cpp.

References groupItemData(), and KateSyntaxContextData::item.

Referenced by groupItemData().

KateSyntaxContextData * KateSyntaxDocument::getConfig const QString mainGroupName,
const QString config
 

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

Definition at line 247 of file katesyntaxdocument.cpp.

References getConfig(), and KateSyntaxContextData::item.

Referenced by getConfig().

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

References getGroupInfo(), and KateSyntaxContextData::parent.

Referenced by getGroupInfo().

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

References endl(), finddata(), and kdDebug().

Referenced by finddata().


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.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 14 00:46:56 2005 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003