OptionEntryString Class Reference

#include <OptionEntry.h>

Inheritance diagram for OptionEntryString:

List of all members.

Public Member Functions
	OptionEntryString (std::list< OptionEntry * > &group, const char *name, const char *description, unsigned int data, const char *defaultValue, bool multiline=false)
virtual	~OptionEntryString ()
virtual EntryType	getEntryType ()
virtual const char *	getValueAsString ()
virtual const char *	getDefaultValueAsString ()
virtual bool	setValueFromString (const std::string &string)
virtual const char *	getValue ()
virtual bool	setValue (const std::string &value)
virtual bool	addToArgParser (ARGParser &parser)
virtual bool	setStringArgument (const char *value)
	operator const char * ()
virtual bool	isDefaultValue ()
Protected Attributes
std::string	value_
std::string	defaultValue_
bool	multiline_

---

Detailed Description

Definition at line 233 of file OptionEntry.h.

---

Constructor & Destructor Documentation

OptionEntryString::OptionEntryString	(	std::list< OptionEntry * > &	group,
		const char *	name,
		const char *	description,
		unsigned int	data,
		const char *	defaultValue,
		bool	multiline = false
	)

Definition at line 528 of file OptionEntry.cpp.

OptionEntryString::~OptionEntryString

(

)

[virtual]

Definition at line 540 of file OptionEntry.cpp.

---

Member Function Documentation

virtual EntryType OptionEntryString::getEntryType

(

)

[inline, virtual]

Implements OptionEntry.

Reimplemented in OptionEntryStringEnum.

Definition at line 244 of file OptionEntry.h.

References multiline_, OptionEntry::OptionEntryStringType, and OptionEntry::OptionEntryTextType.

const char * OptionEntryString::getValueAsString

(

)

[virtual]

Implements OptionEntry.

Definition at line 545 of file OptionEntry.cpp.

References value_.

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

const char * OptionEntryString::getDefaultValueAsString

(

)

[virtual]

Implements OptionEntry.

Definition at line 550 of file OptionEntry.cpp.

References defaultValue_.

Referenced by addToArgParser(), and ClientParams::reset().

bool OptionEntryString::setValueFromString

(

const std::string &

string

)

[virtual]

Implements OptionEntry.

Reimplemented in OptionEntryStringEnum.

Definition at line 555 of file OptionEntry.cpp.

References setValue().

Referenced by ClientParams::reset().

const char * OptionEntryString::getValue

(

)

[virtual]

Definition at line 560 of file OptionEntry.cpp.

References value_.

Referenced by ServerWebServerUtil::generateSettingValue(), ClientParams::getClientFile(), ClientParams::getConnect(), ClientParams::getNonParam(), ClientParams::getPassword(), ClientParams::getSaveFile(), ServerParams::getServerFile(), OptionsParameters::getSettingsDir(), ClientParams::getUserName(), and SettingsFrame::TransferDataToWindow().

bool OptionEntryString::setValue

(

const std::string &

value

)

[virtual]

Reimplemented in OptionEntryStringEnum.

Definition at line 565 of file OptionEntry.cpp.

References OptionEntry::changedValue_, and value_.

Referenced by SettingsSubSelectDialog::buttonDown(), PlayerDialog::buttonDown(), LandscapeDefinitions::checkEnabled(), main(), ServerWebSettingsHandler::SettingsLandscapeHandler::processRequest(), ClientParams::setClientFile(), ClientParams::setConnect(), ClientParams::setPassword(), ClientParams::setSaveFile(), ServerParams::setServerFile(), setStringArgument(), ClientParams::setUserName(), OptionEntryStringEnum::setValue(), setValueFromString(), BuyAccessoryDialog::stateChange(), SettingsFrame::TransferDataFromWindow(), ServerSFrame::TransferDataFromWindow(), and DisplayFrame::TransferDataFromWindow().

bool OptionEntryString::addToArgParser

(

ARGParser &

parser

)

[virtual]

Implements OptionEntry.

Definition at line 577 of file OptionEntry.cpp.

References ARGParser::addEntry(), getDefaultValueAsString(), OptionEntry::getDescription(), OptionEntry::getName(), and snprintf.

bool OptionEntryString::setStringArgument

(

const char *

value

)

[virtual]

Implements ARGParserStringI.

Definition at line 572 of file OptionEntry.cpp.

References setValue().

OptionEntryString::operator const char *

(

)

[inline]

Definition at line 255 of file OptionEntry.h.

References value_.

virtual bool OptionEntryString::isDefaultValue

(

)

[inline, virtual]

Implements OptionEntry.

Definition at line 256 of file OptionEntry.h.

References defaultValue_, and value_.

---

Member Data Documentation

std::string OptionEntryString::value_ [protected]

Definition at line 259 of file OptionEntry.h.

Referenced by getValue(), getValueAsString(), isDefaultValue(), operator const char *(), and setValue().

std::string OptionEntryString::defaultValue_ [protected]

Definition at line 260 of file OptionEntry.h.

Referenced by getDefaultValueAsString(), and isDefaultValue().

bool OptionEntryString::multiline_ [protected]

Definition at line 261 of file OptionEntry.h.

Referenced by getEntryType().

---

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

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

---