KVIrc 5.2.6
Developer APIs
KviModule Class Reference

#include <KviModule.h>

+ Inheritance diagram for KviModule:

Public Member Functions

bool ctrl (const char *operation, void *param)
 
const QString & filename ()
 
KviModuleExtensionDescriptorfindExtensionDescriptor (const KviCString &szType, const KviCString &szName)
 
void getDefaultConfigFileName (QString &szBuffer)
 
void * getSymbol (const char *symname)
 
QLibrary * handle ()
 
bool isLocked ()
 
void lock ()
 
KviModuleInfomoduleInfo ()
 
const QString & name ()
 
KviModuleExtensionDescriptorregisterExtension (const KviCString &szType, const KviCString &szName, const QString &szVisibleName, KviModuleExtensionAllocRoutine r)
 
KviModuleExtensionDescriptorregisterExtension (const KviCString &szType, const KviCString &szName, const QString &szVisibleName, KviModuleExtensionAllocRoutine r, const QPixmap &icon)
 
void unlock ()
 
void unregisterAllExtensions ()
 
 ~KviModule ()
 
- Public Member Functions inherited from KviKvsModuleInterface
void completeCommand (const QString &cmd, std::vector< QString > &matches)
 
void completeFunction (const QString &cmd, std::vector< QString > &matches)
 
void getAllFunctionsCommandsModule (QStringList *list, QString &szModuleName)
 
 KviKvsModuleInterface ()
 
KviKvsModuleCallbackCommandExecRoutinekvsFindCallbackCommand (const QString &szCommand)
 
KviKvsModuleFunctionExecRoutinekvsFindFunction (const QString &szFunction)
 
KviKvsModuleSimpleCommandExecRoutinekvsFindSimpleCommand (const QString &szCommand)
 
bool kvsRegisterAppEventHandler (unsigned int iEventIdx, KviKvsModuleEventHandlerRoutine r)
 
void kvsRegisterCallbackCommand (const QString &szCommand, KviKvsModuleCallbackCommandExecRoutine r)
 
void kvsRegisterFunction (const QString &szFunction, KviKvsModuleFunctionExecRoutine r)
 
bool kvsRegisterRawEventHandler (unsigned int iRawIdx, KviKvsModuleEventHandlerRoutine r)
 
void kvsRegisterSimpleCommand (const QString &szCommand, KviKvsModuleSimpleCommandExecRoutine r)
 
void kvsUnregisterAllAppEventHandlers ()
 
void kvsUnregisterAllCallbackCommands ()
 
void kvsUnregisterAllEventHandlers ()
 
void kvsUnregisterAllFunctions ()
 
void kvsUnregisterAllRawEventHandlers ()
 
void kvsUnregisterAllSimpleCommands ()
 
void kvsUnregisterAppEventHandler (unsigned int iEventIdx)
 
void kvsUnregisterCallbackCommand (const QString &szCommand)
 
void kvsUnregisterFunction (const QString &szFunction)
 
void kvsUnregisterRawEventHandler (unsigned int iRawIdx)
 
void kvsUnregisterSimpleCommand (const QString &szCommand)
 
 ~KviKvsModuleInterface ()
 

Static Public Member Functions

static void unregisterMetaObject (const char *metaObjName)
 

Protected Member Functions

 KviModule (QLibrary *handle, KviModuleInfo *info, const QString &name, const QString &filename)
 
unsigned int secondsSinceLastAccess ()
 
void updateAccessTime ()
 
- Protected Member Functions inherited from KviKvsModuleInterface
void registerDefaultCommands ()
 

Private Attributes

long int m_lastAccessTime
 
QLibrary * m_pLibrary
 
KviModuleInfom_pModuleInfo
 
QString m_szFileName
 
QString m_szName
 
unsigned int m_uLock
 

Friends

class KviModuleManager
 
class KviPointerHashTable< const char *, KviModule >
 
class KviUserParser
 

Additional Inherited Members

- Protected Attributes inherited from KviKvsModuleInterface
KviPointerHashTable< QString, KviKvsModuleCallbackCommandExecRoutine > * m_pModuleCallbackCommandExecRoutineDict
 
KviPointerHashTable< QString, KviKvsModuleFunctionExecRoutine > * m_pModuleFunctionExecRoutineDict
 
KviPointerHashTable< QString, KviKvsModuleSimpleCommandExecRoutine > * m_pModuleSimpleCommandExecRoutineDict
 

Constructor & Destructor Documentation

◆ KviModule()

KviModule::KviModule ( QLibrary * handle,
KviModuleInfo * info,
const QString & name,
const QString & filename )
protected

◆ ~KviModule()

KviModule::~KviModule ( )

Member Function Documentation

◆ ctrl()

◆ filename()

const QString & KviModule::filename ( )
inline

Referenced by KviModule().

◆ findExtensionDescriptor()

KviModuleExtensionDescriptor * KviModule::findExtensionDescriptor ( const KviCString & szType,
const KviCString & szName )

◆ getDefaultConfigFileName()

◆ getSymbol()

void * KviModule::getSymbol ( const char * symname)

References m_pLibrary.

Referenced by KviScriptEditor::destroyInstance().

◆ handle()

QLibrary * KviModule::handle ( )
inline

Referenced by KviModule().

◆ isLocked()

bool KviModule::isLocked ( )
inline

◆ lock()

◆ moduleInfo()

KviModuleInfo * KviModule::moduleInfo ( )
inline

◆ name()

const QString & KviModule::name ( )
inline

◆ registerExtension() [1/2]

KviModuleExtensionDescriptor * KviModule::registerExtension ( const KviCString & szType,
const KviCString & szName,
const QString & szVisibleName,
KviModuleExtensionAllocRoutine r )

◆ registerExtension() [2/2]

KviModuleExtensionDescriptor * KviModule::registerExtension ( const KviCString & szType,
const KviCString & szName,
const QString & szVisibleName,
KviModuleExtensionAllocRoutine r,
const QPixmap & icon )

◆ secondsSinceLastAccess()

unsigned int KviModule::secondsSinceLastAccess ( )
protected

References m_lastAccessTime.

◆ unlock()

◆ unregisterAllExtensions()

void KviModule::unregisterAllExtensions ( )

◆ unregisterMetaObject()

static void KviModule::unregisterMetaObject ( const char * metaObjName)
static

◆ updateAccessTime()

void KviModule::updateAccessTime ( )
protected

Friends And Related Symbol Documentation

◆ KviModuleManager

friend class KviModuleManager
friend

◆ KviPointerHashTable< const char *, KviModule >

friend class KviPointerHashTable< const char *, KviModule >
friend

◆ KviUserParser

friend class KviUserParser
friend

Member Data Documentation

◆ m_lastAccessTime

long int KviModule::m_lastAccessTime
private

◆ m_pLibrary

QLibrary* KviModule::m_pLibrary
private

Referenced by getSymbol(), KviModule(), and ~KviModule().

◆ m_pModuleInfo

KviModuleInfo* KviModule::m_pModuleInfo
private

Referenced by ctrl(), and KviModule().

◆ m_szFileName

QString KviModule::m_szFileName
private

Referenced by KviModule().

◆ m_szName

QString KviModule::m_szName
private

◆ m_uLock

unsigned int KviModule::m_uLock
private

Referenced by KviModule().


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