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 CString &	GetName () const
const CString &	GetPath () const
const CString &	GetDescription () const
const CString &	GetWikiPage () const
const CString &	GetArgsHelpText () 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< EModuleType >	m_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

enum CModInfo::EModuleType

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

const CString& CModInfo::GetArgsHelpText ( ) const

inline

EModuleType CModInfo::GetDefaultType ( ) const

inline

const CString& CModInfo::GetDescription ( ) const

inline

bool CModInfo::GetHasArgs ( ) const

inline

ModLoader CModInfo::GetLoader ( ) const

inline

const CString& CModInfo::GetName ( ) const

inline

Referenced by operator<().

const CString& CModInfo::GetPath ( ) const

inline

const CString& CModInfo::GetWikiPage ( ) const

inline

static CString CModInfo::ModuleTypeToString ( EModuleType  eType )

inlinestatic

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

inline

References GetName().

void CModInfo::SetArgsHelpText ( const CString &  s )

inline

void CModInfo::SetDefaultType ( EModuleType  eType )

inline

void CModInfo::SetDescription ( const CString &  s )

inline

void CModInfo::SetHasArgs ( bool  b = false )

inline

void CModInfo::SetLoader ( ModLoader  fLoader )

inline

void CModInfo::SetName ( const CString &  s )

inline

void CModInfo::SetPath ( const CString &  s )

inline

void CModInfo::SetWikiPage ( const CString &  s )

inline

bool CModInfo::SupportsType ( EModuleType  eType ) const

inline

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

Member Data Documentation

bool CModInfo::m_bHasArgs

protected

EModuleType CModInfo::m_eDefaultType

protected

ModLoader CModInfo::m_fLoader

protected

CString CModInfo::m_sArgsHelpText

protected

CString CModInfo::m_sDescription

protected

std::set<EModuleType> CModInfo::m_seType

protected

CString CModInfo::m_sName

protected

CString CModInfo::m_sPath

protected

CString CModInfo::m_sWikiPage

protected

---

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

• Modules.h