ZNC  trunk
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
CModInfo Class Reference

#include <Modules.h>

+ Collaboration diagram for CModInfo:

Public Types

enum  EModuleType { GlobalModule, UserModule, NetworkModule }
 
typedef CModule *(* ModLoader) (ModHandle p, CUser *pUser, CIRCNetwork *pNetwork, const CString &sModName, const CString &sModPath, EModuleType eType)
 

Public Member Functions

 CModInfo ()
 
 CModInfo (const CString &sName, const CString &sPath, EModuleType eType)
 
 ~CModInfo ()
 
bool operator< (const CModInfo &Info) const
 
bool SupportsType (EModuleType eType) const
 
void AddType (EModuleType eType)
 
const CStringGetName () const
 
const CStringGetPath () const
 
const CStringGetDescription () const
 
const CStringGetWikiPage () const
 
const CStringGetArgsHelpText () const
 
bool GetHasArgs () const
 
ModLoader GetLoader () const
 
EModuleType GetDefaultType () const
 
void SetName (const CString &s)
 
void SetPath (const CString &s)
 
void SetDescription (const CString &s)
 
void SetWikiPage (const CString &s)
 
void SetArgsHelpText (const CString &s)
 
void SetHasArgs (bool b=false)
 
void SetLoader (ModLoader fLoader)
 
void SetDefaultType (EModuleType eType)
 
CString t_s (const CString &sEnglish, const CString &sContext="") const
 

Static Public Member Functions

static CString ModuleTypeToString (EModuleType eType)
 

Protected Attributes

std::set< EModuleTypem_seType
 
EModuleType m_eDefaultType
 
CString m_sName
 
CString m_sPath
 
CString m_sDescription
 
CString m_sWikiPage
 
CString m_sArgsHelpText
 
bool m_bHasArgs
 
ModLoader m_fLoader
 

Member Typedef Documentation

◆ ModLoader

typedef CModule*(* CModInfo::ModLoader) (ModHandle p, CUser *pUser, CIRCNetwork *pNetwork, const CString &sModName, const CString &sModPath, EModuleType eType)

Member Enumeration Documentation

◆ EModuleType

Enumerator
GlobalModule 
UserModule 
NetworkModule 

Constructor & Destructor Documentation

◆ CModInfo() [1/2]

CModInfo::CModInfo ( )
inline

◆ CModInfo() [2/2]

CModInfo::CModInfo ( const CString sName,
const CString sPath,
EModuleType  eType 
)
inline

◆ ~CModInfo()

CModInfo::~CModInfo ( )
inline

Member Function Documentation

◆ AddType()

void CModInfo::AddType ( EModuleType  eType)
inline

◆ GetArgsHelpText()

const CString& CModInfo::GetArgsHelpText ( ) const
inline

◆ GetDefaultType()

EModuleType CModInfo::GetDefaultType ( ) const
inline

◆ GetDescription()

const CString& CModInfo::GetDescription ( ) const
inline

◆ GetHasArgs()

bool CModInfo::GetHasArgs ( ) const
inline

◆ GetLoader()

ModLoader CModInfo::GetLoader ( ) const
inline

◆ GetName()

const CString& CModInfo::GetName ( ) const
inline

Referenced by operator<().

◆ GetPath()

const CString& CModInfo::GetPath ( ) const
inline

◆ GetWikiPage()

const CString& CModInfo::GetWikiPage ( ) const
inline

◆ ModuleTypeToString()

static CString CModInfo::ModuleTypeToString ( EModuleType  eType)
inlinestatic

◆ operator<()

bool CModInfo::operator< ( const CModInfo Info) const
inline

References GetName().

◆ SetArgsHelpText()

void CModInfo::SetArgsHelpText ( const CString s)
inline

◆ SetDefaultType()

void CModInfo::SetDefaultType ( EModuleType  eType)
inline

◆ SetDescription()

void CModInfo::SetDescription ( const CString s)
inline

◆ SetHasArgs()

void CModInfo::SetHasArgs ( bool  b = false)
inline

◆ SetLoader()

void CModInfo::SetLoader ( ModLoader  fLoader)
inline

◆ SetName()

void CModInfo::SetName ( const CString s)
inline

◆ SetPath()

void CModInfo::SetPath ( const CString s)
inline

◆ SetWikiPage()

void CModInfo::SetWikiPage ( const CString s)
inline

◆ SupportsType()

bool CModInfo::SupportsType ( EModuleType  eType) const
inline

◆ t_s()

CString CModInfo::t_s ( const CString sEnglish,
const CString sContext = "" 
) const

Member Data Documentation

◆ m_bHasArgs

bool CModInfo::m_bHasArgs
protected

◆ m_eDefaultType

EModuleType CModInfo::m_eDefaultType
protected

◆ m_fLoader

ModLoader CModInfo::m_fLoader
protected

◆ m_sArgsHelpText

CString CModInfo::m_sArgsHelpText
protected

◆ m_sDescription

CString CModInfo::m_sDescription
protected

◆ m_seType

std::set<EModuleType> CModInfo::m_seType
protected

◆ m_sName

CString CModInfo::m_sName
protected

◆ m_sPath

CString CModInfo::m_sPath
protected

◆ m_sWikiPage

CString CModInfo::m_sWikiPage
protected

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