KateSyntaxDocument Class Reference

#include <katesyntaxdocument.h>

Inheritance diagram for KateSyntaxDocument:

QDomDocument List of all members.

Detailed Description

Store and manage the information about Syntax Highlighting.

Definition at line 64 of file katesyntaxdocument.h.


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)

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.

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.

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.

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.

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.

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.

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.

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.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys