OptionEntry Class Reference

#include <OptionEntry.h>

Inheritance diagram for OptionEntry:

List of all members.

Public Types
enum	StandardData { DataDepricated = 128, DataProtected = 256 }
enum	EntryType {   OptionEntryIntType, OptionEntryStringType, OptionEntryTextType,   OptionEntryBoolType, OptionEntryFloatType, OptionEntryFixedType,   OptionEntryVectorType, OptionEntryFixedVectorType, OptionEntryEnumType,   OptionEntryStringEnumType, OptionEntryBoundedIntType }
Public Member Functions
	OptionEntry (std::list< OptionEntry * > &group, const char *name, const char *description, unsigned int data)
virtual	~OptionEntry ()
const char *	getName ()
virtual const char *	getDescription ()
virtual unsigned	getData ()
virtual EntryType	getEntryType ()=0
virtual const char *	getDefaultValueAsString ()=0
virtual const char *	getValueAsString ()=0
virtual bool	isDefaultValue ()=0
virtual bool	isChangedValue ()
virtual bool	setValueFromString (const std::string &string)=0
virtual bool	addToArgParser (ARGParser &parser)=0
virtual void	setNotChanged ()
virtual const char *	getComsBufferValue ()
virtual bool	setComsBufferValue (const char *string)
Protected Attributes
bool	changedValue_
unsigned int	data_
std::string	name_
std::string	description_

---

Detailed Description

Definition at line 31 of file OptionEntry.h.

---

Member Enumeration Documentation

enum OptionEntry::StandardData

Enumerator:

DataDepricated
DataProtected

Definition at line 34 of file OptionEntry.h.

enum OptionEntry::EntryType

Enumerator:

OptionEntryIntType
OptionEntryStringType
OptionEntryTextType
OptionEntryBoolType
OptionEntryFloatType
OptionEntryFixedType
OptionEntryVectorType
OptionEntryFixedVectorType
OptionEntryEnumType
OptionEntryStringEnumType
OptionEntryBoundedIntType

Definition at line 39 of file OptionEntry.h.

---

Constructor & Destructor Documentation

OptionEntry::OptionEntry	(	std::list< OptionEntry * > &	group,
		const char *	name,
		const char *	description,
		unsigned int	data
	)

Definition at line 28 of file OptionEntry.cpp.

OptionEntry::~OptionEntry

(

)

[virtual]

Definition at line 40 of file OptionEntry.cpp.

---

Member Function Documentation

const char* OptionEntry::getName

(

)

[inline]

Definition at line 60 of file OptionEntry.h.

References name_.

Referenced by RulesDialog::addMOTD(), OptionEntryString::addToArgParser(), OptionEntryBool::addToArgParser(), OptionEntryInt::addToArgParser(), OptionsScorched::commitChanges(), ConsoleRuleFnIOptionsAdapter::ConsoleRuleFnIOptionsAdapter(), GLWOptionEntry::createEntry(), OptionEntrySetterUtil::createOtherSetter(), ServerWebServerUtil::generateSettingValue(), OptionEntryHelper::getEntry(), ServerWebServerUtil::getTemplate(), ServerBrowserInfo::processInfoMessage(), ServerWebSettingsHandler::SettingsModHandler::processRequest(), ServerWebSettingsHandler::SettingsAllHandler::processRequest(), ServerWebSettingsHandler::SettingsPlayersHandler::processRequest(), OptionEntryHelper::readFromBuffer(), OptionEntryHelper::readFromXML(), run_main(), setValues(), GLWOptionEntry::updateControls(), GLWOptionEntry::updateEntries(), OptionsScorched::updateLevelOptions(), OptionEntryHelper::writeToBuffer(), and OptionEntryHelper::writeToXML().

virtual const char* OptionEntry::getDescription

(

)

[inline, virtual]

Reimplemented in OptionEntryBoundedInt, OptionEntryEnum, and OptionEntryStringEnum.

Definition at line 61 of file OptionEntry.h.

References description_.

Referenced by OptionEntryString::addToArgParser(), OptionEntryBool::addToArgParser(), OptionEntryInt::addToArgParser(), GLWOptionEntry::createEntry(), OptionEntrySetterUtil::createOtherSetter(), ServerWebSettingsHandler::SettingsAllHandler::processRequest(), run_main(), SettingsFrame::TransferDataToWindow(), ServerSFrame::TransferDataToWindow(), and OptionEntryHelper::writeToXML().

virtual unsigned OptionEntry::getData

(

)

[inline, virtual]

Definition at line 62 of file OptionEntry.h.

References data_.

Referenced by OptionsDisplayConsole::addDisplayToConsole(), OptionsScorched::commitChanges(), ServerWebServerUtil::getTemplate(), OptionsDisplay::loadDefaultValues(), ServerBrowserInfo::processInfoMessage(), ServerWebSettingsHandler::SettingsAllHandler::processRequest(), OptionEntryHelper::readFromBuffer(), OptionEntryHelper::writeToBuffer(), and OptionEntryHelper::writeToXML().

virtual EntryType OptionEntry::getEntryType

(

)

[pure virtual]

Implemented in OptionEntryInt, OptionEntryBoundedInt, OptionEntryEnum, OptionEntryBool, OptionEntryString, OptionEntryStringEnum, OptionEntryFloat, OptionEntryVector, OptionEntryFixed, and OptionEntryFixedVector.

Referenced by ConsoleRuleFnIOptionsAdapter::ConsoleRuleFnIOptionsAdapter(), GLWOptionEntry::createEntry(), OptionEntrySetterUtil::createOtherSetter(), ServerWebServerUtil::generateSettingValue(), ConsoleRuleFnIOptionsAdapter::getNumberParam(), ConsoleRuleFnIOptionsAdapter::setNumberParam(), OptionEntrySetterUtil::updateControls(), GLWOptionEntry::updateControls(), OptionEntrySetterUtil::updateEntries(), and GLWOptionEntry::updateEntries().

virtual const char* OptionEntry::getDefaultValueAsString

(

)

[pure virtual]

Implemented in OptionEntryInt, OptionEntryEnum, OptionEntryBool, OptionEntryString, OptionEntryFloat, OptionEntryVector, OptionEntryFixed, and OptionEntryFixedVector.

Referenced by OptionsDisplayConsole::addDisplayToConsole(), OptionsDisplay::loadDefaultValues(), ServerWebSettingsHandler::SettingsAllHandler::processRequest(), OptionEntryHelper::readFromBuffer(), and OptionEntryHelper::writeToXML().

virtual const char* OptionEntry::getValueAsString

(

)

[pure virtual]

Implemented in OptionEntryInt, OptionEntryEnum, OptionEntryBool, OptionEntryString, OptionEntryFloat, OptionEntryVector, OptionEntryFixed, and OptionEntryFixedVector.

Referenced by RulesDialog::addMOTD(), OptionsScorched::commitChanges(), ServerWebServerUtil::generateSettingValue(), getComsBufferValue(), ServerWebServerUtil::getTemplate(), ServerBrowserInfo::processInfoMessage(), ServerWebSettingsHandler::SettingsAllHandler::processRequest(), ServerWebSettingsHandler::SettingsPlayersHandler::processRequest(), s3d_get_option(), OptionEntrySetterUtil::updateControls(), GLWOptionEntry::updateControls(), OptionsScorched::updateLevelOptions(), and OptionEntryHelper::writeToXML().

virtual bool OptionEntry::isDefaultValue

(

)

[pure virtual]

Implemented in OptionEntryInt, OptionEntryBool, OptionEntryString, OptionEntryFloat, OptionEntryVector, OptionEntryFixed, and OptionEntryFixedVector.

Referenced by RulesDialog::addMOTD(), OptionEntryHelper::readFromBuffer(), and OptionEntryHelper::writeToBuffer().

virtual bool OptionEntry::isChangedValue

(

)

[inline, virtual]

Definition at line 68 of file OptionEntry.h.

References changedValue_.

Referenced by RulesDialog::addMOTD(), and OptionsScorched::updateLevelOptions().

virtual bool OptionEntry::setValueFromString

(

const std::string &

string

)

[pure virtual]

Implemented in OptionEntryInt, OptionEntryEnum, OptionEntryBool, OptionEntryString, OptionEntryStringEnum, OptionEntryFloat, OptionEntryVector, OptionEntryFixed, and OptionEntryFixedVector.

Referenced by OptionsDisplayConsole::addDisplayToConsole(), OptionsScorched::commitChanges(), OptionsDisplay::loadDefaultValues(), OptionEntryHelper::readFromBuffer(), setComsBufferValue(), setValues(), OptionEntrySetterUtil::updateEntries(), GLWOptionEntry::updateEntries(), and OptionsScorched::updateLevelOptions().

virtual bool OptionEntry::addToArgParser

(

ARGParser &

parser

)

[pure virtual]

Implemented in OptionEntryInt, OptionEntryBool, OptionEntryString, OptionEntryFloat, OptionEntryVector, OptionEntryFixed, and OptionEntryFixedVector.

virtual void OptionEntry::setNotChanged

(

)

[inline, virtual]

Definition at line 71 of file OptionEntry.h.

References changedValue_.

Referenced by OptionsScorched::updateLevelOptions().

virtual const char* OptionEntry::getComsBufferValue

(

)

[inline, virtual]

Reimplemented in OptionEntryEnum.

Definition at line 73 of file OptionEntry.h.

References getValueAsString().

Referenced by OptionEntryHelper::writeToBuffer().

virtual bool OptionEntry::setComsBufferValue

(

const char *

string

)

[inline, virtual]

Reimplemented in OptionEntryEnum.

Definition at line 75 of file OptionEntry.h.

References setValueFromString().

Referenced by OptionEntryHelper::readFromBuffer().

---

Member Data Documentation

bool OptionEntry::changedValue_ [protected]

Definition at line 79 of file OptionEntry.h.

Referenced by isChangedValue(), setNotChanged(), OptionEntryFixedVector::setValue(), OptionEntryFixed::setValue(), OptionEntryVector::setValue(), OptionEntryFloat::setValue(), OptionEntryString::setValue(), OptionEntryBool::setValue(), and OptionEntryInt::setValue().

unsigned int OptionEntry::data_ [protected]

Definition at line 80 of file OptionEntry.h.

Referenced by getData().

std::string OptionEntry::name_ [protected]

Definition at line 81 of file OptionEntry.h.

Referenced by getName().

std::string OptionEntry::description_ [protected]

Definition at line 82 of file OptionEntry.h.

Referenced by getDescription(), OptionEntryStringEnum::getDescription(), OptionEntryEnum::getDescription(), and OptionEntryBoundedInt::getDescription().

---

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

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

---