KVIrc 5.2.6
Developer APIs
KviKvsCallbackObject Class Reference

#include <KviKvsCallbackObject.h>

+ Inheritance diagram for KviKvsCallbackObject:

Public Types

enum  CallbackFlags { OnlyIfWindowExists = 1 }
 
enum  CallbackStatus { Success , Error , HaltEncountered , TargetWindowDead }
 

Public Member Functions

 KviKvsCallbackObject (const QString &szCallbackSource, KviWindow *pTargetWindow, const QString &szCallbackCode, KviKvsVariantList *pMagicParams, unsigned int uFlags=0)
 
virtual ~KviKvsCallbackObject ()
 

Protected Member Functions

CallbackStatus execute (KviKvsVariantList *pParams=nullptr, KviKvsVariant *pRetVal=nullptr)
 

Protected Attributes

KviKvsVariantListm_pMagicParams
 
KviKvsScriptm_pScript
 
KviWindowm_pTargetConsole
 
KviWindowm_pTargetWindow
 
unsigned int m_uFlags
 

Member Enumeration Documentation

◆ CallbackFlags

Enumerator
OnlyIfWindowExists 

◆ CallbackStatus

Enumerator
Success 
Error 
HaltEncountered 
TargetWindowDead 

Constructor & Destructor Documentation

◆ KviKvsCallbackObject()

◆ ~KviKvsCallbackObject()

KviKvsCallbackObject::~KviKvsCallbackObject ( )
virtual

References m_pMagicParams, and m_pScript.

Member Function Documentation

◆ execute()

Member Data Documentation

◆ m_pMagicParams

KviKvsVariantList* KviKvsCallbackObject::m_pMagicParams
protected

◆ m_pScript

KviKvsScript* KviKvsCallbackObject::m_pScript
protected

◆ m_pTargetConsole

KviWindow* KviKvsCallbackObject::m_pTargetConsole
protected

Referenced by execute(), and KviKvsCallbackObject().

◆ m_pTargetWindow

KviWindow* KviKvsCallbackObject::m_pTargetWindow
protected

Referenced by execute(), and KviKvsCallbackObject().

◆ m_uFlags

unsigned int KviKvsCallbackObject::m_uFlags
protected

Referenced by execute(), and KviKvsCallbackObject().


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