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

ModLoader

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

Member Enumeration Documentation

EModuleType

enum CModInfo::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

References m_seType.

GetArgsHelpText()

const CString& CModInfo::GetArgsHelpText ( ) const

inline

References m_sWikiPage.

GetDefaultType()

EModuleType CModInfo::GetDefaultType ( ) const

inline

References m_fLoader.

GetDescription()

const CString& CModInfo::GetDescription ( ) const

inline

References m_sPath.

GetHasArgs()

bool CModInfo::GetHasArgs ( ) const

inline

References m_sArgsHelpText.

GetLoader()

ModLoader CModInfo::GetLoader ( ) const

inline

References m_bHasArgs.

GetName()

const CString& CModInfo::GetName ( ) const

inline

Referenced by operator<().

GetPath()

const CString& CModInfo::GetPath ( ) const

inline

References m_sName.

GetWikiPage()

const CString& CModInfo::GetWikiPage ( ) const

inline

References m_sDescription.

ModuleTypeToString()

static CString CModInfo::ModuleTypeToString ( EModuleType  eType )

inlinestatic

References GlobalModule, NetworkModule, and UserModule.

operator<()

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

inline

References GetName().

SetArgsHelpText()

void CModInfo::SetArgsHelpText ( const CString &  s )

inline

References m_sWikiPage.

SetDefaultType()

void CModInfo::SetDefaultType ( EModuleType  eType )

inline

References m_fLoader.

SetDescription()

void CModInfo::SetDescription ( const CString &  s )

inline

References m_sPath.

SetHasArgs()

void CModInfo::SetHasArgs ( bool  b = false )

inline

References m_sArgsHelpText.

SetLoader()

void CModInfo::SetLoader ( ModLoader  fLoader )

inline

References m_bHasArgs.

SetName()

void CModInfo::SetName ( const CString &  s )

inline

SetPath()

void CModInfo::SetPath ( const CString &  s )

inline

References m_sName.

SetWikiPage()

void CModInfo::SetWikiPage ( const CString &  s )

inline

References m_sDescription.

SupportsType()

bool CModInfo::SupportsType ( EModuleType  eType ) const

inline

References m_seType.

t_s()

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

Member Data Documentation

m_bHasArgs

bool CModInfo::m_bHasArgs

protected

Referenced by GetLoader(), and SetLoader().

m_eDefaultType

EModuleType CModInfo::m_eDefaultType

protected

m_fLoader

ModLoader CModInfo::m_fLoader

protected

Referenced by GetDefaultType(), and SetDefaultType().

m_sArgsHelpText

CString CModInfo::m_sArgsHelpText

protected

Referenced by GetHasArgs(), and SetHasArgs().

m_sDescription

CString CModInfo::m_sDescription

protected

Referenced by GetWikiPage(), and SetWikiPage().

m_seType

std::set<EModuleType> CModInfo::m_seType

protected

Referenced by AddType(), and SupportsType().

m_sName

CString CModInfo::m_sName

protected

Referenced by GetPath(), and SetPath().

m_sPath

CString CModInfo::m_sPath

protected

Referenced by GetDescription(), and SetDescription().

m_sWikiPage

CString CModInfo::m_sWikiPage

protected

Referenced by GetArgsHelpText(), and SetArgsHelpText().

---

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

• Modules.h