OptionEntryHelper Class Reference

#include <OptionEntry.h>

List of all members.

Static Public Member Functions
static bool	writeToBuffer (std::list< OptionEntry * > &options, NetBuffer &buffer, bool useprotected)
static bool	readFromBuffer (std::list< OptionEntry * > &options, NetBufferReader &reader, bool useprotected)
static bool	writeToXML (std::list< OptionEntry * > &options, XMLNode *node)
static bool	readFromXML (std::list< OptionEntry * > &options, XMLNode *node)
static bool	writeToFile (std::list< OptionEntry * > &options, const std::string &fileName)
static bool	readFromFile (std::list< OptionEntry * > &options, const std::string &fileName)
static bool	addToArgParser (std::list< OptionEntry * > &options, ARGParser &parser)
static OptionEntry *	getEntry (std::list< OptionEntry * > &options, const char *name)

---

Detailed Description

Definition at line 85 of file OptionEntry.h.

---

Member Function Documentation

bool OptionEntryHelper::writeToBuffer	(	std::list< OptionEntry * > &	options,
		NetBuffer &	buffer,
		bool	useprotected
	)			[static]

Definition at line 59 of file OptionEntry.cpp.

References NetBuffer::addToBuffer(), OptionEntry::DataProtected, OptionEntry::getComsBufferValue(), OptionEntry::getData(), OptionEntry::getName(), and OptionEntry::isDefaultValue().

Referenced by OptionsTransient::writeToBuffer(), and OptionsGame::writeToBuffer().

bool OptionEntryHelper::readFromBuffer	(	std::list< OptionEntry * > &	options,
		NetBufferReader &	reader,
		bool	useprotected
	)			[static]

Definition at line 89 of file OptionEntry.cpp.

References OptionEntry::DataProtected, S3D::formatStringBuffer(), OptionEntry::getData(), OptionEntry::getDefaultValueAsString(), NetBufferReader::getFromBuffer(), OptionEntry::getName(), OptionEntry::isDefaultValue(), Logger::log(), OptionEntry::setComsBufferValue(), OptionEntry::setValueFromString(), and LangStringUtil::strcmp().

Referenced by OptionsTransient::readFromBuffer(), and OptionsGame::readFromBuffer().

bool OptionEntryHelper::writeToXML	(	std::list< OptionEntry * > &	options,
		XMLNode *	node
	)			[static]

Definition at line 141 of file OptionEntry.cpp.

References XMLNode::addChild(), OptionEntry::DataDepricated, OptionEntry::getData(), OptionEntry::getDefaultValueAsString(), OptionEntry::getDescription(), OptionEntry::getName(), OptionEntry::getValueAsString(), and XMLNode::XMLCommentType.

Referenced by OptionsGame::writeOptionsToXML(), and writeToFile().

bool OptionEntryHelper::readFromXML	(	std::list< OptionEntry * > &	options,
		XMLNode *	node
	)			[static]

Definition at line 187 of file OptionEntry.cpp.

References _strlwr, S3D::dialogMessage(), S3D::formatStringBuffer(), XMLNode::getContent(), OptionEntry::getName(), XMLNode::getNamedChild(), XMLNode::getSource(), and Logger::log().

Referenced by readFromFile(), OptionsGame::readOptionsFromXML(), and LandscapeOptionsType::readXML().

bool OptionEntryHelper::writeToFile	(	std::list< OptionEntry * > &	options,
		const std::string &	fileName
	)			[static]

Definition at line 174 of file OptionEntry.cpp.

References XMLNode::addParameter(), XMLNode::writeToFile(), writeToXML(), and XMLNode::XMLParameterType.

Referenced by NetOptions::writeOptionsToFile(), OptionsMasterListServer::writeOptionsToFile(), OptionsGame::writeOptionsToFile(), and OptionsDisplay::writeOptionsToFile().

bool OptionEntryHelper::readFromFile	(	std::list< OptionEntry * > &	options,
		const std::string &	fileName
	)			[static]

Definition at line 240 of file OptionEntry.cpp.

References S3D::dialogMessage(), file, S3D::formatStringBuffer(), XMLFile::getParserError(), XMLFile::getRootNode(), XMLFile::readFile(), and readFromXML().

Referenced by OptionsDisplay::loadFastestValues(), OptionsDisplay::loadMediumValues(), OptionsDisplay::loadSafeValues(), NetOptions::readOptionsFromFile(), OptionsMasterListServer::readOptionsFromFile(), OptionsGame::readOptionsFromFile(), and OptionsDisplay::readOptionsFromFile().

bool OptionEntryHelper::addToArgParser	(	std::list< OptionEntry * > &	options,
		ARGParser &	parser
	)			[static]

Definition at line 45 of file OptionEntry.cpp.

Referenced by run_main().

OptionEntry * OptionEntryHelper::getEntry	(	std::list< OptionEntry * > &	options,
		const char *	name
	)			[static]

Definition at line 264 of file OptionEntry.cpp.

References OptionEntry::getName(), and LangStringUtil::strcmp().

Referenced by s3d_get_option().

---

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

• src/common/common/OptionEntry.h
• src/common/common/OptionEntry.cpp

---