• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Kate

KateSyntaxDocument Class Reference

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

#include <katesyntaxdocument.h>

Inheritance diagram for KateSyntaxDocument:

Inheritance graph
[legend]

List of all members.


Public Member Functions

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)
 KateSyntaxDocument (KConfig *config, bool force=false)
const KateSyntaxModeList & modeList ()
bool nextGroup (KateSyntaxContextData *data)
bool nextItem (KateSyntaxContextData *data)
bool setIdentifier (const QString &identifier)
 ~KateSyntaxDocument ()

Detailed Description

Store and manage the information about Syntax Highlighting.

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

KateSyntaxDocument::~KateSyntaxDocument (  ) 

Desctructor.

Definition at line 48 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 195 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 180 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 160 of file katesyntaxdocument.cpp.

const KateSyntaxModeList& KateSyntaxDocument::modeList (  )  [inline]

Get the mode list.

Returns:
mode list

Definition at line 99 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 101 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 132 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.

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


The documentation for this class was generated from the following files:
  • katesyntaxdocument.h
  • katesyntaxdocument.cpp

Kate

Skip menu "Kate"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal