makVrv::DtKeyFunctionNameList Class Reference

A serializable list of function names. More...

Public Types
typedef std::list< std::string >	KeyFunctionNameList

Public Member Functions
	DtKeyFunctionNameList ()
	CTOR.
	DtKeyFunctionNameList (const KeyFunctionNameList &list)
	Create using the an existing list.
	~DtKeyFunctionNameList ()
	DTOR.
DtKeyFunctionNameList &	operator= (const DtKeyFunctionNameList &orig)
	Assignment Operator.
	DtKeyFunctionNameList (const DtKeyFunctionNameList &orig)
	Copy Constructor.
void	addKeyFunctionName (const std::string &functionName)
	put a function name onto the list
void	clearFunctionNameList ()
	remove all the function names currently in the list
const KeyFunctionNameList &	functionNameList () const
	get the list of function names
KeyFunctionNameList &	functionNameList ()

Protected Member Functions
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.

Protected Attributes
KeyFunctionNameList	myKeyFunctionNameList

Detailed Description

A serializable list of function names.

There is such a list associated with each key/modifier combo for both key-down and key-up events

Examples

• exampleKeyMap

Member Typedef Documentation

typedef std::list<std::string> makVrv::DtKeyFunctionNameList::KeyFunctionNameList

Constructor & Destructor Documentation

makVrv::DtKeyFunctionNameList::DtKeyFunctionNameList

(

)

CTOR.

makVrv::DtKeyFunctionNameList::DtKeyFunctionNameList

(

const KeyFunctionNameList &

list

)

Create using the an existing list.

makVrv::DtKeyFunctionNameList::~DtKeyFunctionNameList

(

)

DTOR.

makVrv::DtKeyFunctionNameList::DtKeyFunctionNameList

(

const DtKeyFunctionNameList &

orig

)

Copy Constructor.

Member Function Documentation

DtKeyFunctionNameList& makVrv::DtKeyFunctionNameList::operator=

(

const DtKeyFunctionNameList &

orig

)

Assignment Operator.

void makVrv::DtKeyFunctionNameList::addKeyFunctionName

(

const std::string &

functionName

)

put a function name onto the list

void makVrv::DtKeyFunctionNameList::clearFunctionNameList

(

)

remove all the function names currently in the list

const KeyFunctionNameList& makVrv::DtKeyFunctionNameList::functionNameList

(

)

const

get the list of function names

KeyFunctionNameList& makVrv::DtKeyFunctionNameList::functionNameList

(

)

template<class Archive >

void makVrv::DtKeyFunctionNameList::_serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

Declare serialize functions Call via serialize(Archive ar, unsigned int version); Where Archive can be any of : xml_oarchive,xml_iarchive,binary_oarchive binary_iarchive,text_oarchive, or text_iarchive.

References DT_SERIALIZE_MEMBER.

Member Data Documentation

KeyFunctionNameList makVrv::DtKeyFunctionNameList::myKeyFunctionNameList

protected

---

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

• include/vrvCore/DtKeyMap.h