KVIrc  4.9.2
DeveloperAPIs
KviKvsTreeNodeSpecialCommandClass.h
Go to the documentation of this file.
1 #ifndef _KVI_KVS_TREENODE_SPECIALCOMMANDCLASS_H_
2 #define _KVI_KVS_TREENODE_SPECIALCOMMANDCLASS_H_
3 //=============================================================================
4 //
5 // File : KviKvsTreeNodeSpecialCommandClass.h
6 // Creation date : Fri 12 Aug 2005 03:23:31 by Szymon Stefanek
7 //
8 // This file is part of the KVIrc IRC Client distribution
9 // Copyright (C) 2005-2010 Szymon Stefanek <pragma at kvirc dot net>
10 //
11 // This program is FREE software. You can redistribute it and/or
12 // modify it under the terms of the GNU General Public License
13 // as published by the Free Software Foundation; either version 2
14 // of the License, or (at your option) any later version.
15 //
16 // This program is distributed in the HOPE that it will be USEFUL,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 // See the GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU General Public License
22 // along with this program. If not, write to the Free Software Foundation,
23 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 //
25 //=============================================================================
26 
27 #include "kvi_settings.h"
28 #include "KviQString.h"
30 #include "KviKvsTreeNodeBase.h"
31 #include "KviKvsTreeNodeDataList.h"
32 
34 
36 {
37 public:
38  KviKvsTreeNodeSpecialCommandClassFunctionDefinition(const QChar * pLocation, const QString & szName, const QString & szBuffer, const QString & szReminder, unsigned int uHandlerFlags);
40 
41 protected:
42  QString m_szName;
43  QString m_szReminder;
44  QString m_szBuffer;
45  unsigned int m_uHandlerFlags;
46 
47 public:
48  unsigned int handlerFlags() { return m_uHandlerFlags; };
49  const QString & name() { return m_szName; };
50  const QString & reminder() { return m_szReminder; };
51  const QString & buffer() { return m_szBuffer; };
52  virtual void contextDescription(QString & szBuffer);
53  virtual void dump(const char * prefix);
54 };
55 
57 {
58 public:
59  KviKvsTreeNodeSpecialCommandClass(const QChar * pLocation, KviKvsTreeNodeDataList * pParams);
61 
62 protected:
65 
66 public:
67  void addFunctionDefinition(KviKvsTreeNodeSpecialCommandClassFunctionDefinition * pDef);
68  virtual void contextDescription(QString & szBuffer);
69  virtual void dump(const char * prefix);
70  virtual bool execute(KviKvsRunTimeContext * c);
71 };
72 
73 #endif
unsigned int m_uHandlerFlags
Definition: KviKvsTreeNodeSpecialCommandClass.h:45
Treenode class.
Definition: KviKvsTreeNodeBase.h:40
#define KVIRC_API
Definition: kvi_settings.h:128
char s char s char s s s s s char char c s *s c s s s d c s *s d c d d d d c
Definition: KviIrcNumericCodes.h:391
Treenode handling.
QString m_szBuffer
Definition: KviKvsTreeNodeSpecialCommandClass.h:44
virtual void dump(const char *prefix)=0
Dumps the tree.
KviPointerList< KviKvsTreeNodeSpecialCommandClassFunctionDefinition > * m_pFunctions
Definition: KviKvsTreeNodeSpecialCommandClass.h:64
const QString & buffer()
Definition: KviKvsTreeNodeSpecialCommandClass.h:51
virtual ~KviKvsTreeNodeSpecialCommandClassFunctionDefinition()
Definition: KviKvsTreeNodeSpecialCommandClass.h:39
KviKvsTreeNodeDataList * m_pParams
Definition: KviKvsTreeNodeSpecialCommandClass.h:63
const QString & name()
Definition: KviKvsTreeNodeSpecialCommandClass.h:49
const QString & reminder()
Definition: KviKvsTreeNodeSpecialCommandClass.h:50
Definition: KviKvsTreeNodeSpecialCommandClass.h:35
Definition: KviKvsTreeNodeDataList.h:35
Definition: KviKvsTreeNodeSpecialCommand.h:31
QString m_szReminder
Definition: KviKvsTreeNodeSpecialCommandClass.h:43
Definition: KviKvsTreeNodeSpecialCommandClass.h:56
virtual void contextDescription(QString &szBuffer)=0
Sets the buffer.
Definition: KviKvsRunTimeContext.h:103
unsigned int handlerFlags()
Definition: KviKvsTreeNodeSpecialCommandClass.h:48
virtual bool execute(KviKvsRunTimeContext *c)=0
This is the main entry point to the tree visit.
char szBuffer[4096]
Definition: winamp.cpp:77
This file contains compile time settings.
virtual void contextDescription(QString &szBuffer)
Sets the buffer as Instruction.
Definition: KviKvsTreeNodeSpecialCommand.cpp:35
Helper functions for the QString class.
virtual void dump(const char *prefix)
Dumps the instructions tree.
Definition: KviKvsTreeNodeSpecialCommand.cpp:42