• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kate
 

kate

  • kate
  • part
katesyntaxdocument.h
1 /* This file is part of the KDE libraries
2  Copyright (C) 2001 Joseph Wenninger <jowenn@kde.org>
3  Copyright (C) 2000 Scott Manson <sdmanson@alltel.net>
4 
5  This library is free software; you can redistribute it and/or
6  modify it under the terms of the GNU Library General Public
7  License version 2 as published by the Free Software Foundation.
8 
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  Boston, MA 02110-1301, USA.
18 */
19 
20 #ifndef __KATE_SYNTAXDOCUMENT_H__
21 #define __KATE_SYNTAXDOCUMENT_H__
22 
23 #include <tqdom.h>
24 #include <tqstringlist.h>
25 
29 class KateSyntaxModeListItem
30 {
31  public:
32  TQString name;
33  TQString nameTranslated;
34  TQString section;
35  TQString mimetype;
36  TQString extension;
37  TQString identifier;
38  TQString version;
39  TQString priority;
40  TQString author;
41  TQString license;
42  bool hidden;
43 };
44 
48 typedef TQValueList<KateSyntaxModeListItem*> KateSyntaxModeList;
49 
53 class KateSyntaxContextData
54 {
55  public:
56  TQDomElement parent;
57  TQDomElement currentGroup;
58  TQDomElement item;
59 };
60 
64 class KateSyntaxDocument : public TQDomDocument
65 {
66  public:
72  KateSyntaxDocument(bool force = false);
73 
77  ~KateSyntaxDocument();
78 
85  bool setIdentifier(const TQString& identifier);
86 
91  const KateSyntaxModeList &modeList() { return myModeList; }
92 
98  bool nextGroup(KateSyntaxContextData* data);
99 
105  bool nextItem(KateSyntaxContextData* data);
106 
110  TQString groupItemData(const KateSyntaxContextData* data,const TQString& name);
111  TQString groupData(const KateSyntaxContextData* data,const TQString& name);
112 
113  void freeGroupInfo(KateSyntaxContextData* data);
114  KateSyntaxContextData* getSubItems(KateSyntaxContextData* data);
115 
120  KateSyntaxContextData* getConfig(const TQString& mainGroupName, const TQString &config);
121 
126  KateSyntaxContextData* getGroupInfo(const TQString& mainGroupName, const TQString &group);
127 
131  TQStringList& finddata(const TQString& mainGroup,const TQString& type,bool clearList=true);
132 
133  private:
138  void setupModeList(bool force);
139 
144  bool getElement (TQDomElement &element, const TQString &mainGroupName, const TQString &config);
145 
149  KateSyntaxModeList myModeList;
150 
154  TQString currentFile;
155 
159  TQStringList m_data;
160 };
161 
162 #endif
KateSyntaxContextData
Class holding the data around the current QDomElement.
Definition: katesyntaxdocument.h:54
KateSyntaxDocument
Store and manage the information about Syntax Highlighting.
Definition: katesyntaxdocument.h:65
KateSyntaxDocument::modeList
const KateSyntaxModeList & modeList()
Get the mode list.
Definition: katesyntaxdocument.h:91
KateSyntaxDocument::~KateSyntaxDocument
~KateSyntaxDocument()
Desctructor.
Definition: katesyntaxdocument.cpp:41
KateSyntaxDocument::getGroupInfo
KateSyntaxContextData * getGroupInfo(const TQString &mainGroupName, const TQString &group)
Get the KateSyntaxContextData of the TQDomElement Config inside mainGroupName KateSyntaxContextData::...
Definition: katesyntaxdocument.cpp:263
KateSyntaxDocument::groupItemData
TQString groupItemData(const KateSyntaxContextData *data, const TQString &name)
This function is used to fetch the atributes of the tags.
Definition: katesyntaxdocument.cpp:153
KateSyntaxDocument::KateSyntaxDocument
KateSyntaxDocument(bool force=false)
Constructor Sets the current file to nothing and build the ModeList (katesyntaxhighlightingrc)
Definition: katesyntaxdocument.cpp:34
KateSyntaxDocument::finddata
TQStringList & finddata(const TQString &mainGroup, const TQString &type, bool clearList=true)
Returns a list with all the keywords inside the list type.
Definition: katesyntaxdocument.cpp:278
KateSyntaxDocument::nextItem
bool nextItem(KateSyntaxContextData *data)
Jump to the next item, KateSyntaxContextData::item will point to the next item.
Definition: katesyntaxdocument.cpp:125
KateSyntaxDocument::setIdentifier
bool setIdentifier(const TQString &identifier)
If the open hl file is different from the one needed, it opens the new one and assign some other thin...
Definition: katesyntaxdocument.cpp:51
KateSyntaxDocument::nextGroup
bool nextGroup(KateSyntaxContextData *data)
Jump to the next group, KateSyntaxContextData::currentGroup will point to the next group.
Definition: katesyntaxdocument.cpp:94
KateSyntaxDocument::getConfig
KateSyntaxContextData * getConfig(const TQString &mainGroupName, const TQString &config)
Get the KateSyntaxContextData of the DomElement Config inside mainGroupName It just fills KateSyntaxC...
Definition: katesyntaxdocument.cpp:247
KateSyntaxModeListItem
Information about each syntax hl Mode.
Definition: katesyntaxdocument.h:30

kate

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

kate

Skip menu "kate"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for kate by doxygen 1.9.1
This website is maintained by Timothy Pearson.