ModInfo Class Reference

#include <ModInfo.h>

List of all members.

Public Member Functions
	ModInfo (const std::string &name)
virtual	~ModInfo ()
bool	parse (const std::string &fileName)
const char *	getName ()
const char *	getUrl ()
const char *	getIcon ()
const char *	getDescription ()
const char *	getShortDescription ()
const char *	getProtocolVersion ()
std::list< MenuEntry > &	getMenuEntries ()
Protected Attributes
std::string	name_
std::string	url_
std::string	icon_
std::string	description_
std::string	shortDescription_
std::string	protocolversion_
std::list< MenuEntry >	entries_
Classes
struct	MenuEntry

---

Detailed Description

Definition at line 27 of file ModInfo.h.

---

Constructor & Destructor Documentation

ModInfo::ModInfo

(

const std::string &

name

)

Definition at line 25 of file ModInfo.cpp.

ModInfo::~ModInfo

(

)

[virtual]

Definition at line 31 of file ModInfo.cpp.

---

Member Function Documentation

bool ModInfo::parse

(

const std::string &

fileName

)

Definition at line 35 of file ModInfo.cpp.

References S3D::checkDataFile(), ModInfo::MenuEntry::description, description_, S3D::dialogMessage(), entries_, XMLNode::failChildren(), file, S3D::formatStringBuffer(), ModInfo::MenuEntry::gamefile, S3D::getDataFile(), XMLNode::getNamedChild(), XMLFile::getParserError(), XMLFile::getRootNode(), ModInfo::MenuEntry::icon, icon_, protocolversion_, XMLFile::readFile(), ModInfo::MenuEntry::shortdescription, shortDescription_, and url_.

Referenced by ModSelectDialog::display().

const char* ModInfo::getName

(

)

[inline]

Definition at line 43 of file ModInfo.h.

References name_.

Referenced by ModSelectDialog::buttonDown(), GLWOptionEntry::createEntry(), ModDirs::loadModFile(), ServerWebSettingsHandler::SettingsModHandler::processRequest(), ServerSFrame::TransferDataToWindow(), and updateModList().

const char* ModInfo::getUrl

(

)

[inline]

Definition at line 44 of file ModInfo.h.

References url_.

const char* ModInfo::getIcon

(

)

[inline]

Definition at line 45 of file ModInfo.h.

References icon_.

Referenced by GLWIconListModItem::GLWIconListModItem().

const char* ModInfo::getDescription

(

)

[inline]

Definition at line 46 of file ModInfo.h.

References description_.

Referenced by ServerWebSettingsHandler::SettingsModHandler::processRequest().

const char* ModInfo::getShortDescription

(

)

[inline]

Definition at line 47 of file ModInfo.h.

References shortDescription_.

Referenced by GLWIconListModItem::draw().

const char* ModInfo::getProtocolVersion

(

)

[inline]

Definition at line 48 of file ModInfo.h.

References protocolversion_.

std::list<MenuEntry>& ModInfo::getMenuEntries

(

)

[inline]

Definition at line 49 of file ModInfo.h.

References entries_.

Referenced by ModSubSelectDialog::display(), and ModSelectDialog::display().

---

Member Data Documentation

std::string ModInfo::name_ [protected]

Definition at line 52 of file ModInfo.h.

Referenced by getName().

std::string ModInfo::url_ [protected]

Definition at line 53 of file ModInfo.h.

Referenced by getUrl(), and parse().

std::string ModInfo::icon_ [protected]

Definition at line 54 of file ModInfo.h.

Referenced by getIcon(), and parse().

std::string ModInfo::description_ [protected]

Definition at line 55 of file ModInfo.h.

Referenced by getDescription(), and parse().

std::string ModInfo::shortDescription_ [protected]

Definition at line 56 of file ModInfo.h.

Referenced by getShortDescription(), and parse().

std::string ModInfo::protocolversion_ [protected]

Definition at line 57 of file ModInfo.h.

Referenced by getProtocolVersion(), and parse().

std::list<MenuEntry> ModInfo::entries_ [protected]

Definition at line 58 of file ModInfo.h.

Referenced by getMenuEntries(), and parse().

---

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

• src/common/engine/ModInfo.h
• src/common/engine/ModInfo.cpp

---