KVIrc 5.2.6
Developer APIs
KviKvsTreeNodeAliasSimpleCommand Class Reference

Treenode alias simple command call class. More...

#include <KviKvsTreeNodeAliasSimpleCommand.h>

+ Inheritance diagram for KviKvsTreeNodeAliasSimpleCommand:

Public Member Functions

virtual void contextDescription (QString &szBuffer)
 Sets the buffer as Alias Simple Command.
 
virtual void dump (const char *prefix)
 Dumps the tree.
 
virtual bool execute (KviKvsRunTimeContext *c)
 Evaluates the command.
 
 KviKvsTreeNodeAliasSimpleCommand (const QChar *pLocation, const QString &szCmdName, KviKvsTreeNodeDataList *pParams)
 Constructs the treenode alias simple command call object.
 
 ~KviKvsTreeNodeAliasSimpleCommand ()
 Destroys the treenode alias simple command call object.
 
- Public Member Functions inherited from KviKvsTreeNodeSimpleCommand
 KviKvsTreeNodeSimpleCommand (const QChar *pLocation, const QString &szCmdName, KviKvsTreeNodeDataList *params)
 
 ~KviKvsTreeNodeSimpleCommand ()
 
- Public Member Functions inherited from KviKvsTreeNodeCommandWithParameters
void dumpParameterList (const char *prefix)
 
 KviKvsTreeNodeCommandWithParameters (const QChar *pLocation, const QString &szCmdName, KviKvsTreeNodeDataList *params)
 
KviKvsTreeNodeDataListparams ()
 
 ~KviKvsTreeNodeCommandWithParameters ()
 
- Public Member Functions inherited from KviKvsTreeNodeCommand
const QString & commandName ()
 
void dumpSwitchList (const char *prefix)
 
 KviKvsTreeNodeCommand (const QChar *pLocation, const QString &szCmdName)
 
 ~KviKvsTreeNodeCommand ()
 
- Public Member Functions inherited from KviKvsTreeNodeInstruction
 KviKvsTreeNodeInstruction (const QChar *pLocation)
 Constructs the treenode instruction object.
 
 ~KviKvsTreeNodeInstruction ()
 Destroys the treenode instruction object.
 
- Public Member Functions inherited from KviKvsTreeNode
 KviKvsTreeNode (const QChar *pLocation)
 Constructs the treenode object.
 
const QChar * location ()
 Returns the location char.
 
KviKvsTreeNodeparent ()
 Returns the parent object.
 
void setParent (KviKvsTreeNode *p)
 Sets the parent object.
 
virtual ~KviKvsTreeNode ()
 Destroys the treenode object.
 

Additional Inherited Members

- Protected Member Functions inherited from KviKvsTreeNodeCommand
void setSwitchList (KviKvsTreeNodeSwitchList *sw)
 
- Protected Member Functions inherited from KviKvsTreeNode
void setLocation (const QChar *pLocation)
 Sets the location char.
 
- Protected Attributes inherited from KviKvsTreeNodeCommandWithParameters
KviKvsTreeNodeDataListm_pParams
 
- Protected Attributes inherited from KviKvsTreeNodeCommand
KviKvsTreeNodeSwitchListm_pSwitches
 
QString m_szCmdName
 
- Protected Attributes inherited from KviKvsTreeNode
const QChar * m_pLocation
 
KviKvsTreeNodem_pParent
 

Detailed Description

Treenode alias simple command call class.

Constructor & Destructor Documentation

◆ KviKvsTreeNodeAliasSimpleCommand()

KviKvsTreeNodeAliasSimpleCommand::KviKvsTreeNodeAliasSimpleCommand ( const QChar * pLocation,
const QString & szCmdName,
KviKvsTreeNodeDataList * pParams )

Constructs the treenode alias simple command call object.

Parameters
pLocationThe location char of the instruction
szCmdNameThe name of the command
pParamsThe parameters' list
Returns
KviKvsTreeNodeAliasSimpleCommand

◆ ~KviKvsTreeNodeAliasSimpleCommand()

KviKvsTreeNodeAliasSimpleCommand::~KviKvsTreeNodeAliasSimpleCommand ( )
default

Destroys the treenode alias simple command call object.

Member Function Documentation

◆ contextDescription()

void KviKvsTreeNodeAliasSimpleCommand::contextDescription ( QString & szBuffer)
virtual

Sets the buffer as Alias Simple Command.

Parameters
szBufferThe buffer :)
Returns
void

Reimplemented from KviKvsTreeNodeSimpleCommand.

References KviKvsTreeNodeCommand::m_szCmdName, and szBuffer.

◆ dump()

void KviKvsTreeNodeAliasSimpleCommand::dump ( const char * prefix)
virtual

Dumps the tree.

Parameters
prefixThe prefix of the instruction
Returns
void

Reimplemented from KviKvsTreeNodeSimpleCommand.

References KviKvsTreeNodeCommandWithParameters::dumpParameterList(), KviKvsTreeNodeCommand::dumpSwitchList(), and KviKvsTreeNodeCommand::m_szCmdName.

◆ execute()


The documentation for this class was generated from the following files: