KVIrc 5.2.0
Developer APIs
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
KviKvsScriptAddon Class Reference

#include <KviKvsScriptAddonManager.h>

+ Inheritance diagram for KviKvsScriptAddon:

Public Member Functions

void addInstalledFile (const QString &szFileName)
 
const QString & configureCallbackCode ()
 
const QString & description ()
 
const QString & descriptionCode ()
 
void executeConfigureCallback (KviWindow *pWnd)
 
void executeHelpCallback (KviWindow *pWnd)
 
const QString & helpCallbackCode ()
 
QPixmap * icon ()
 
const QString & iconId ()
 
const QStringList & installedFiles () const
 
 KviKvsScriptAddon (const KviKvsScriptAddon &a)
 
const QString & name () const
 
void setConfigureCallback (const QString &szConfigureCallbackCode)
 
void setHelpCallback (const QString &szHelpCallbackCode)
 
const QString & uninstallCallbackCode ()
 
const QString & version () const
 
const QString & visibleName ()
 
const QString & visibleNameCode ()
 
 ~KviKvsScriptAddon ()
 

Protected Member Functions

void allocateScripts (const QString &sVisibleNameCode, const QString &szDescriptionCode, const QString &szUninstallCallbackCode)
 
void executeUninstallCallback (KviWindow *pWnd)
 
 KviKvsScriptAddon ()
 
 KviKvsScriptAddon (QString szName, QString szVersion, const QString &szVisibleNameCode, const QString &szDescriptionCode, const QString &szUninstallCallbackCode, QString szIconId)
 
bool load (KviConfigurationFile *cfg, const QString &szName)
 
void save (KviConfigurationFile *cfg)
 

Protected Attributes

QStringList m_lInstalledFiles
 
KviKvsScriptm_pConfigureCallback
 
KviKvsScriptm_pDescriptionScript
 
KviKvsScriptm_pHelpCallback
 
KviKvsScriptm_pUninstallCallback
 
KviKvsScriptm_pVisibleNameScript
 
QString m_szDescription
 
QString m_szIconId
 
QString m_szName
 
QString m_szVersion
 
QString m_szVisibleName
 

Friends

class KviKvsScriptAddonManager
 

Constructor & Destructor Documentation

◆ KviKvsScriptAddon() [1/3]

KviKvsScriptAddon::KviKvsScriptAddon ( )
protected

◆ KviKvsScriptAddon() [2/3]

KviKvsScriptAddon::KviKvsScriptAddon ( QString  szName,
QString  szVersion,
const QString &  szVisibleNameCode,
const QString &  szDescriptionCode,
const QString &  szUninstallCallbackCode,
QString  szIconId 
)
protected

◆ KviKvsScriptAddon() [3/3]

KviKvsScriptAddon::KviKvsScriptAddon ( const KviKvsScriptAddon a)

◆ ~KviKvsScriptAddon()

KviKvsScriptAddon::~KviKvsScriptAddon ( )

Member Function Documentation

◆ addInstalledFile()

void KviKvsScriptAddon::addInstalledFile ( const QString &  szFileName)

Register a file to be uninstalled after the uninstall callback. The file name MUST be relative to the local kvirc directory.

References m_lInstalledFiles.

◆ allocateScripts()

void KviKvsScriptAddon::allocateScripts ( const QString &  sVisibleNameCode,
const QString &  szDescriptionCode,
const QString &  szUninstallCallbackCode 
)
protected

◆ configureCallbackCode()

const QString & KviKvsScriptAddon::configureCallbackCode ( )

◆ description()

const QString & KviKvsScriptAddon::description ( )

◆ descriptionCode()

const QString & KviKvsScriptAddon::descriptionCode ( )

References KviKvsScript::code(), and m_pDescriptionScript.

Referenced by save().

◆ executeConfigureCallback()

void KviKvsScriptAddon::executeConfigureCallback ( KviWindow pWnd)

◆ executeHelpCallback()

void KviKvsScriptAddon::executeHelpCallback ( KviWindow pWnd)

◆ executeUninstallCallback()

void KviKvsScriptAddon::executeUninstallCallback ( KviWindow pWnd)
protected

◆ helpCallbackCode()

const QString & KviKvsScriptAddon::helpCallbackCode ( )

◆ icon()

QPixmap * KviKvsScriptAddon::icon ( )

◆ iconId()

const QString & KviKvsScriptAddon::iconId ( )
inline

◆ installedFiles()

const QStringList & KviKvsScriptAddon::installedFiles ( ) const
inline

◆ load()

bool KviKvsScriptAddon::load ( KviConfigurationFile cfg,
const QString &  szName 
)
protected

◆ name()

const QString & KviKvsScriptAddon::name ( ) const
inline

◆ save()

void KviKvsScriptAddon::save ( KviConfigurationFile cfg)
protected

◆ setConfigureCallback()

void KviKvsScriptAddon::setConfigureCallback ( const QString &  szConfigureCallbackCode)

◆ setHelpCallback()

void KviKvsScriptAddon::setHelpCallback ( const QString &  szHelpCallbackCode)

◆ uninstallCallbackCode()

const QString & KviKvsScriptAddon::uninstallCallbackCode ( )

References KviKvsScript::code(), and m_pUninstallCallback.

Referenced by save().

◆ version()

const QString & KviKvsScriptAddon::version ( ) const
inline

◆ visibleName()

const QString & KviKvsScriptAddon::visibleName ( )

◆ visibleNameCode()

const QString & KviKvsScriptAddon::visibleNameCode ( )

References KviKvsScript::code(), and m_pVisibleNameScript.

Referenced by save().

Friends And Related Symbol Documentation

◆ KviKvsScriptAddonManager

friend class KviKvsScriptAddonManager
friend

Member Data Documentation

◆ m_lInstalledFiles

QStringList KviKvsScriptAddon::m_lInstalledFiles
protected

Referenced by addInstalledFile(), load(), and save().

◆ m_pConfigureCallback

KviKvsScript* KviKvsScriptAddon::m_pConfigureCallback
protected

◆ m_pDescriptionScript

KviKvsScript* KviKvsScriptAddon::m_pDescriptionScript
protected

◆ m_pHelpCallback

KviKvsScript* KviKvsScriptAddon::m_pHelpCallback
protected

◆ m_pUninstallCallback

KviKvsScript* KviKvsScriptAddon::m_pUninstallCallback
protected

◆ m_pVisibleNameScript

KviKvsScript* KviKvsScriptAddon::m_pVisibleNameScript
protected

◆ m_szDescription

QString KviKvsScriptAddon::m_szDescription
protected

Referenced by description().

◆ m_szIconId

QString KviKvsScriptAddon::m_szIconId
protected

Referenced by icon(), KviKvsScriptAddon(), load(), and save().

◆ m_szName

QString KviKvsScriptAddon::m_szName
protected

◆ m_szVersion

QString KviKvsScriptAddon::m_szVersion
protected

Referenced by KviKvsScriptAddon(), load(), and save().

◆ m_szVisibleName

QString KviKvsScriptAddon::m_szVisibleName
protected

Referenced by visibleName().


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