teditor::Option Class Reference

Class to define an option used in the editor. More...

#include <option.h>

Public Types
enum	Type {   Boolean, Integer, Real, String,   Char }

Public Member Functions
	Option (const std::string &n, const std::string &v, const std::string &hm, Type t)
	Define a new option. More...
bool	getBool () const
int	getInt () const
float	getReal () const
std::string	getStr () const
char	getChar () const

Static Public Member Functions
static void	add (const std::string &n, const std::string &v, const std::string &hm, Type t)
	Define a new option. More...
static void	set (const std::string &n, const std::string &val)
static Option &	get (const std::string &n)
static void	dumpAll (const std::string &outfile)
static void	printOpts ()

Detailed Description

Class to define an option used in the editor.

Member Enumeration Documentation

Type

enum teditor::Option::Type

All supported option types

Enumerator
Boolean
Integer
Real
String
Char

Constructor & Destructor Documentation

Option()

teditor::Option::Option ( const std::string &  n, const std::string &  v, const std::string &  hm, Type  t  )

inline

Define a new option.

Parameters

n	name of the option
v	default value
hm	help message for this option
t	type of option

Member Function Documentation

add()

void teditor::Option::add ( const std::string &  n, const std::string &  v, const std::string &  hm, Option::Type  t  )

static

Define a new option.

Parameters

n	name of the option
v	default value
hm	help message for this option
t	type of option

dumpAll()

void teditor::Option::dumpAll ( const std::string &  outfile )

static

dumps all options into the rcfile

get()

Option & teditor::Option::get ( const std::string &  n )

static

gets the named option

printOpts()

void teditor::Option::printOpts ( )

static

prints all options to stdout in form of help message

set()

void teditor::Option::set ( const std::string &  n, const std::string &  val  )

static

sets value for the given option

---

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

• option.h
• option.cpp