DtBehaviorUi Class Reference

Inheritance diagram for DtBehaviorUi:

Public Member Functions
	DtBehaviorUi ()
	default constructor
	DtBehaviorUi (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtBehaviorUi ()
	destructor
	DtBehaviorUi (const DtBehaviorUi &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtBehaviorUi &	operator= (const DtBehaviorUi &orig)
	assignment operator
virtual bool	load (const DtFilename &)
virtual bool	load (const QString &)
	Loads from a string that contains ui context.
virtual bool	load (DtlInputStream *f)
virtual QWidget *	createControlsFor (DtVrfObjectParameters *) const
virtual void	setModelModified (DtModelSetEntry *m)
void	setElementChangedCallback (DtElementChangedCallbackFcn f, void *u)
virtual bool	isModified () const
virtual void	mergeInto (DtUiForParameter *, const QString &intoParameter, const QString &nearReaderWriterType, bool after)
	Merges the given DtUiForParameter* into specified parameters (blank means all)
virtual QStringList	uiSupportedParameters () const
	Returns a list of all parameter descriptor types supported.
virtual DtUiForParameter *	uiForParameter (DtVrfObjectParameters *parameters) const
	Returns the ui for the specified parameter. Do not delete return value.
virtual QMap< QString, QVariant >	uiState () const
virtual void	setUiState (const QMap< QString, QVariant > &)
DtUiForParameter *	displaying ()
virtual void	setUiStateFor (const DtString &param, const QMap< QString, QVariant > &uiState)
	Saved ui states to be used for seeding parameter pages of same type.
virtual QMap< QString, QVariant >	uiStateFor (const DtString &param) const
virtual void	clearContents ()
virtual void	sendEvent (const DtUiElementEvent &)
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter *data, DtListItem *item)
	Remove an element from the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
	Add element to the list just after the indicated item.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static void	addParameterType (const char *baseParameterType, const char *matchingType)
static DtBehaviorUi *	create (const DtString &)

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs a DtRwString item, and then retrieves it from the stream.
virtual void	emptyList ()
virtual void	copyList (const DtBehaviorUi &orig)
virtual DtUiForParameter *	uiForParameter (const DtString &) const
virtual void	mergeParameters (DtUiForParameter *) const
virtual DtUiForParameter *	createUiForParameter (const DtString &s)
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtElementChangedCallbackFcn	myElementChangedCallback
void *	myUserVariable
DtUiForParameter *	myDisplaying
QHash< QString, QMap< QString, QVariant > >	myUiStates

Static Protected Attributes
static QHash< QString, QString >	theParameterMatches

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

Constructor & Destructor Documentation

DtBehaviorUi::DtBehaviorUi

(

)

default constructor

DtBehaviorUi::DtBehaviorUi	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtBehaviorUi::~DtBehaviorUi ( )

virtual

destructor

DtBehaviorUi::DtBehaviorUi	(	const DtBehaviorUi &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

Member Function Documentation

DtBehaviorUi& DtBehaviorUi::operator=

(

const DtBehaviorUi &

orig

)

assignment operator

virtual bool DtBehaviorUi::load ( const DtFilename &  )

virtual

virtual bool DtBehaviorUi::load ( const QString &  )

virtual

Loads from a string that contains ui context.

virtual bool DtBehaviorUi::load ( DtlInputStream *  f )

virtual

virtual QWidget* DtBehaviorUi::createControlsFor ( DtVrfObjectParameters *  ) const

virtual

virtual void DtBehaviorUi::setModelModified ( DtModelSetEntry *  m )

virtual

void DtBehaviorUi::setElementChangedCallback ( DtElementChangedCallbackFcn  f, void *  u  )

inline

virtual bool DtBehaviorUi::isModified ( ) const

virtual

virtual void DtBehaviorUi::mergeInto ( DtUiForParameter *  , const QString &  intoParameter, const QString &  nearReaderWriterType, bool  after  )

virtual

Merges the given DtUiForParameter* into specified parameters (blank means all)

virtual QStringList DtBehaviorUi::uiSupportedParameters ( ) const

virtual

Returns a list of all parameter descriptor types supported.

static void DtBehaviorUi::addParameterType ( const char *  baseParameterType, const char *  matchingType  )

static

static DtBehaviorUi* DtBehaviorUi::create ( const DtString &  )

static

virtual DtUiForParameter* DtBehaviorUi::uiForParameter ( DtVrfObjectParameters *  parameters ) const

virtual

Returns the ui for the specified parameter. Do not delete return value.

virtual QMap<QString, QVariant> DtBehaviorUi::uiState ( ) const

virtual

virtual void DtBehaviorUi::setUiState ( const QMap< QString, QVariant > &  )

virtual

DtUiForParameter* DtBehaviorUi::displaying ( )

inline

virtual void DtBehaviorUi::setUiStateFor ( const DtString &  param, const QMap< QString, QVariant > &  uiState  )

virtual

Saved ui states to be used for seeding parameter pages of same type.

virtual QMap<QString, QVariant> DtBehaviorUi::uiStateFor ( const DtString &  param ) const

virtual

virtual void DtBehaviorUi::clearContents ( )

virtual

virtual void DtBehaviorUi::sendEvent ( const DtUiElementEvent &  )

virtual

virtual DtlObjPtr DtBehaviorUi::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

protectedvirtual

Constructs a DtRwString item, and then retrieves it from the stream.

Implements DtRwList.

virtual void DtBehaviorUi::emptyList ( )

protectedvirtual

virtual void DtBehaviorUi::copyList ( const DtBehaviorUi &  orig )

protectedvirtual

virtual DtUiForParameter* DtBehaviorUi::uiForParameter ( const DtString &  ) const

protectedvirtual

virtual void DtBehaviorUi::mergeParameters ( DtUiForParameter *  ) const

protectedvirtual

virtual DtUiForParameter* DtBehaviorUi::createUiForParameter ( const DtString &  s )

protectedvirtual

Member Data Documentation

DtElementChangedCallbackFcn DtBehaviorUi::myElementChangedCallback

protected

void* DtBehaviorUi::myUserVariable

protected

DtUiForParameter* DtBehaviorUi::myDisplaying

mutableprotected

QHash<QString, QString> DtBehaviorUi::theParameterMatches

staticprotected

QHash<QString, QMap<QString, QVariant> > DtBehaviorUi::myUiStates

protected

---

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

• include/entityEditorImpl/behaviorUi.h