ZNC  trunk
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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

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

Member Enumeration Documentation

Enumerator
GlobalModule 
UserModule 
NetworkModule 

Constructor & Destructor Documentation

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

Member Function Documentation

void CModInfo::AddType ( EModuleType  eType)
inline

References m_seType.

const CString& CModInfo::GetArgsHelpText ( ) const
inline

References m_sArgsHelpText.

EModuleType CModInfo::GetDefaultType ( ) const
inline

References m_eDefaultType.

const CString& CModInfo::GetDescription ( ) const
inline

References m_sDescription.

bool CModInfo::GetHasArgs ( ) const
inline

References m_bHasArgs.

ModLoader CModInfo::GetLoader ( ) const
inline

References m_fLoader.

const CString& CModInfo::GetName ( ) const
inline

References m_sName.

Referenced by operator<().

const CString& CModInfo::GetPath ( ) const
inline

References m_sPath.

const CString& CModInfo::GetWikiPage ( ) const
inline

References m_sWikiPage.

static CString CModInfo::ModuleTypeToString ( EModuleType  eType)
inlinestatic
bool CModInfo::operator< ( const CModInfo Info) const
inline

References GetName().

void CModInfo::SetArgsHelpText ( const CString s)
inline

References m_sArgsHelpText.

void CModInfo::SetDefaultType ( EModuleType  eType)
inline

References m_eDefaultType.

void CModInfo::SetDescription ( const CString s)
inline

References m_sDescription.

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

References m_bHasArgs.

void CModInfo::SetLoader ( ModLoader  fLoader)
inline

References m_fLoader.

void CModInfo::SetName ( const CString s)
inline

References m_sName.

void CModInfo::SetPath ( const CString s)
inline

References m_sPath.

void CModInfo::SetWikiPage ( const CString s)
inline

References m_sWikiPage.

bool CModInfo::SupportsType ( EModuleType  eType) const
inline

References m_seType.

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

Member Data Documentation

bool CModInfo::m_bHasArgs
protected

Referenced by GetHasArgs(), and SetHasArgs().

EModuleType CModInfo::m_eDefaultType
protected

Referenced by GetDefaultType(), and SetDefaultType().

ModLoader CModInfo::m_fLoader
protected

Referenced by GetLoader(), and SetLoader().

CString CModInfo::m_sArgsHelpText
protected

Referenced by GetArgsHelpText(), and SetArgsHelpText().

CString CModInfo::m_sDescription
protected

Referenced by GetDescription(), and SetDescription().

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

Referenced by AddType(), and SupportsType().

CString CModInfo::m_sName
protected

Referenced by GetName(), and SetName().

CString CModInfo::m_sPath
protected

Referenced by GetPath(), and SetPath().

CString CModInfo::m_sWikiPage
protected

Referenced by GetWikiPage(), and SetWikiPage().


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