EnumDef Class Reference

Holds data pertinent to a certain enum. It does not know the enum values themselves, but treat them as integers. More...

Inheritance diagram for EnumDef:

Public Member Functions
	EnumDef ()
	EnumDef (const char *nm, const char *s[])
bool	isValidKey (const char *) const
int	indexOf (const char *s) const
int	indexOf (int enumval) const
int	getEnumValForIndex (int) const
const char *	getKeyForIndex (int i) const
uiString	getUiStringForIndex (int i) const
void	setUiStringForIndex (int, const uiString &)
const BufferStringSet &	keys () const
const uiStringSet &	strings () const
const char *	getIconFileForIndex (int idx) const
void	setIconFileForIndex (int idx, const char *)
int	size () const
void	remove (const char *key)
void	add (const char *key, const uiString &, int enumval, const char *iconfile)
bool	isValidName (const char *key) const
const char *	convert (int idx) const
int	convert (const char *txt) const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual BufferString	getName () const
virtual void	setName (const char *nm)
bool	getNameFromPar (const IOPar &)
void	putNameInPar (IOPar &) const

Protected Member Functions
void	fillUiStrings ()

Protected Attributes
uiStringSet	uistrings_
BufferStringSet	keys_
TypeSet< int >	enums_
BufferStringSet	iconfiles_
Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

Holds data pertinent to a certain enum. It does not know the enum values themselves, but treat them as integers.

In most cases, the inherited EnumDefImpl<ENUM> is used, but a stand-alone EnumDef can be used if one wants to use combinations of enums that are not available as EnumDefImpl.

A stand-alone EnumDef can be created as follows to create a combo box with all enums in Stats::Type without the average. Note: EnumDef is assumed to remain in memory.

EnumDef def = Stats::TypeDef();
def.remove( def.getKey(Stats::Average) );

new uiComboBox( this, def );

Constructor & Destructor Documentation

EnumDef::EnumDef

(

)

EnumDef::EnumDef	(	const char *	nm,
		const char *	s[]
	)

Member Function Documentation

void EnumDef::add	(	const char *	key,
		const uiString &	,
		int	enumval,
		const char *	iconfile
	)

const char* EnumDef::convert

(

int

idx

)

const

int EnumDef::convert

(

const char *

txt

)

const

void EnumDef::fillUiStrings ( )

protected

int EnumDef::getEnumValForIndex

(

int

)

const

const char* EnumDef::getIconFileForIndex

(

int

idx

)

const

const char* EnumDef::getKeyForIndex

(

int

i

)

const

uiString EnumDef::getUiStringForIndex

(

int

i

)

const

int EnumDef::indexOf

(

const char *

s

)

const

int EnumDef::indexOf

(

int

enumval

)

const

bool EnumDef::isValidKey

(

const char *

)

const

bool EnumDef::isValidName

(

const char *

key

)

const

const BufferStringSet& EnumDef::keys ( ) const

inline

void EnumDef::remove

(

const char *

key

)

void EnumDef::setIconFileForIndex	(	int	idx,
		const char *
	)

void EnumDef::setUiStringForIndex	(	int	,
		const uiString &
	)

int EnumDef::size

(

)

const

const uiStringSet& EnumDef::strings ( ) const

inline

Member Data Documentation

TypeSet<int> EnumDef::enums_

protected

BufferStringSet EnumDef::iconfiles_

protected

BufferStringSet EnumDef::keys_

protected

uiStringSet EnumDef::uistrings_

protected