enums.h File Reference

Include dependency graph for enums.h:

Go to the source code of this file.

Classes
class	EnumDef
	Holds data pertinent to a certain enum. It does not know the enum values themselves, but treat them as integers. More...
class	EnumDefImpl< ENUM >

Macros
#define	mDeclareEnumUtils(enm)
	Some utilities surrounding the often needed enum <-> string table. More...
#define	mDeclareNameSpaceEnumUtils(mod, enm)
#define	_DefineEnumNames(prefix, enm, deflen, prettynm)
#define	DefineEnumNames(clss, enm, deflen, prettynm)
#define	DefineNameSpaceEnumNames(nmspc, enm, deflen, prettynm)
#define	mDefineEnumUtils(clss, enm, prettynm)   DefineEnumNames(clss,enm,0,prettynm)
#define	mDefineNameSpaceEnumUtils(nmspc, enm, prettynm)   DefineNameSpaceEnumNames(nmspc,enm,0,prettynm)
#define	DeclareEnumUtils(enm)   mDeclareEnumUtils(enm)
#define	DefineEnumUtils(clss, enm, prettynm)   mDefineEnumUtils(clss,enm,prettynm)
#define	DefineNameSpaceEnumUtils(nmspc, enm, prettynm)   mDefineNameSpaceEnumUtils(nmspc,enm,prettynm)
#define	DeclareNameSpaceEnumUtils(mod, enm)   mDeclareNameSpaceEnumUtils(mod,enm)
#define	mEnumTr(str)   tr(str)

Macro Definition Documentation

_DefineEnumNames

#define _DefineEnumNames	(		prefix,
			enm,
			deflen,
			prettynm
	)

DeclareEnumUtils

#define DeclareEnumUtils

(

enm

)

mDeclareEnumUtils(enm)

DeclareNameSpaceEnumUtils

#define DeclareNameSpaceEnumUtils	(		mod,
			enm
	)		mDeclareNameSpaceEnumUtils(mod,enm)

DefineEnumNames

#define DefineEnumNames	(		clss,
			enm,
			deflen,
			prettynm
	)

Value:

ConstPtrMan<EnumDefImpl<clss::enm> > clss::enm##Definition_ = 0; \
_DefineEnumNames( clss, enm, deflen, prettynm )

DefineEnumUtils

#define DefineEnumUtils	(		clss,
			enm,
			prettynm
	)		mDefineEnumUtils(clss,enm,prettynm)

DefineNameSpaceEnumNames

#define DefineNameSpaceEnumNames	(		nmspc,
			enm,
			deflen,
			prettynm
	)

Value:

static ConstPtrMan<EnumDefImpl<nmspc::enm> > enm##Definition_ = 0; \
_DefineEnumNames( nmspc, enm, deflen, prettynm )

DefineNameSpaceEnumUtils

#define DefineNameSpaceEnumUtils	(		nmspc,
			enm,
			prettynm
	)		mDefineNameSpaceEnumUtils(nmspc,enm,prettynm)

mDeclareNameSpaceEnumUtils

#define mDeclareNameSpaceEnumUtils	(		mod,
			enm
	)

Value:

    mExtern(mod) const EnumDefImpl<enm>& enm##Def(); \
    mExtern(mod) const char** enm##Names();\
    extern const char* enm##Keys_[]; \
    mExtern(mod) bool parseEnum(const IOPar&,const char*,enm&); \
    mExtern(mod) bool parseEnum(const char*,enm&); \
    mExtern(mod) bool parseEnum##enm(const char*,enm&); /*legacy */  \
    mExtern(mod) enm parseEnum##enm(const char*); \
    mExtern(mod) const char* toString(enm); \
    mExtern(mod) uiString toUiString(enm); \
    mExtern(mod) const char* get##enm##String(enm); /*legacy */

mDefineEnumUtils

#define mDefineEnumUtils	(		clss,
			enm,
			prettynm
	)		DefineEnumNames(clss,enm,0,prettynm)

mDefineNameSpaceEnumUtils

#define mDefineNameSpaceEnumUtils	(		nmspc,
			enm,
			prettynm
	)		DefineNameSpaceEnumNames(nmspc,enm,0,prettynm)

mEnumTr

#define mEnumTr

(

str

)

tr(str)