VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtUiForParameter Class Reference
Inheritance diagram for DtUiForParameter:
Inheritance graph
[legend]

Public Member Functions

 DtUiForParameter (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 Constructor.
virtual ~DtUiForParameter ()
 Destructor.
 DtUiForParameter (const DtUiForParameter &orig)
 Copy constructor.
DtUiForParameteroperator= (const DtUiForParameter &orig)
 Assignment operator.
const DtStringparameterType () const
const DtStringobjectTypeTemplate () const
const DtStringinheritFrom () const
const DtStringlabel () const
bool canBeAssigned () const
void setInheritFrom (const DtString &)
virtual QWidgetcreateControls (DtVrfObjectParameters *, DtElementChangedCallbackFcn f, void *usr)
virtual void inheritFrom (DtUiForParameter *)
virtual DtUiElementfindElement (const DtString &) const
virtual bool isModified () const
virtual void mergeInto (const DtString &readerWriterName, bool after, DtUiElement *element)
 Merges the given UI element either before or after the reader-writer-named element.
virtual DtUiForParameterclone ()
virtual void setModelModified (DtModelSetEntry *)
virtual void uiEvent (const DtUiElementEvent &)
virtual QMap< QString, QVariant > uiState () const
virtual void setUiState (const QMap< QString, QVariant > &)
DtUiForParameterSignallersignalHandler ()
- 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 DtRwListoperator= (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 DtReaderWriteroperator= (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 aliasContaineraliases () 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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &)
 This method must be overridden by a subclass.
virtual void emptyList ()
virtual void copyList (const DtUiForParameter &orig)
- 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

DtRwBoolean myCanBeAssigned
DtRwString myParameterType
DtRwString myInheritFrom
DtRwString myLabel
DtRwString myObjectTypeTemplate
DtUiForParameterSignaller mySignalHandler
virtual void processElementChanged (DtUiElement *element)
 Callback invoked whenever one of the elements is modified.
static void elementChangedCallback (DtUiElement *element, void *usr)
 Callback invoked whenever one of the elements is modified.

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
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename & appPath ()
 Gets the current working directory.
static DtReaderWriterFactoryfactory ()
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static DtReaderWriterFactory theFactory

Constructor & Destructor Documentation

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

Constructor.

virtual DtUiForParameter::~DtUiForParameter ( )
virtual

Destructor.

DtUiForParameter::DtUiForParameter ( const DtUiForParameter orig)

Copy constructor.

Member Function Documentation

DtUiForParameter& DtUiForParameter::operator= ( const DtUiForParameter orig)

Assignment operator.

const DtString & DtUiForParameter::parameterType ( ) const
inline

References myParameterType.

const DtString & DtUiForParameter::objectTypeTemplate ( ) const
inline

References myObjectTypeTemplate.

const DtString & DtUiForParameter::inheritFrom ( ) const
inline

References myInheritFrom.

const DtString & DtUiForParameter::label ( ) const
inline

References myLabel.

bool DtUiForParameter::canBeAssigned ( ) const
inline

References myCanBeAssigned.

void DtUiForParameter::setInheritFrom ( const DtString s)
inline

References myInheritFrom.

virtual QWidget* DtUiForParameter::createControls ( DtVrfObjectParameters ,
DtElementChangedCallbackFcn  f,
void *  usr 
)
virtual
virtual void DtUiForParameter::inheritFrom ( DtUiForParameter )
virtual
virtual DtUiElement* DtUiForParameter::findElement ( const DtString ) const
virtual
virtual bool DtUiForParameter::isModified ( ) const
virtual
virtual void DtUiForParameter::mergeInto ( const DtString readerWriterName,
bool  after,
DtUiElement element 
)
virtual

Merges the given UI element either before or after the reader-writer-named element.

virtual DtUiForParameter* DtUiForParameter::clone ( )
virtual
static void DtUiForParameter::elementChangedCallback ( DtUiElement element,
void *  usr 
)
static

Callback invoked whenever one of the elements is modified.

Notifies all other elements (not the one that was just changed) of the change.

virtual void DtUiForParameter::processElementChanged ( DtUiElement element)
virtual

Callback invoked whenever one of the elements is modified.

Notifies all other elements (not the one that was just changed) of the change.

virtual void DtUiForParameter::setModelModified ( DtModelSetEntry )
virtual
virtual void DtUiForParameter::uiEvent ( const DtUiElementEvent )
virtual
virtual QMap<QString, QVariant> DtUiForParameter::uiState ( ) const
virtual
virtual void DtUiForParameter::setUiState ( const QMap< QString, QVariant > &  )
virtual
DtUiForParameterSignaller* DtUiForParameter::signalHandler ( )
inline
virtual DtlObjPtr DtUiForParameter::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
protectedvirtual

This method must be overridden by a subclass.

  Within this method, new instances of the DtReaderWriter subclass
  that is being handled by this list must be created, and then retrieved
  from the mtl stream, using the getSelf member of that item.
  \par
  Here is some sample code that could be used to implement a 
  override of this class:  (This is used in the DtRwIntegerList::getData() method)
  @code 

DtlObjPtr nameObj = DtcCar(args); DtRwInt* value = new DtRwInt(nameObj->pname()); value->getSelf(args, searchPath, variableBindings); this->add(value); return DtcCdr(DtcCdr(args));

Implements DtRwList.

virtual void DtUiForParameter::emptyList ( )
protectedvirtual
virtual void DtUiForParameter::copyList ( const DtUiForParameter orig)
protectedvirtual

Member Data Documentation

DtRwBoolean DtUiForParameter::myCanBeAssigned
protected

Referenced by canBeAssigned().

DtRwString DtUiForParameter::myParameterType
protected

Referenced by parameterType().

DtRwString DtUiForParameter::myInheritFrom
protected

Referenced by inheritFrom(), and setInheritFrom().

DtRwString DtUiForParameter::myLabel
protected

Referenced by label().

DtRwString DtUiForParameter::myObjectTypeTemplate
protected

Referenced by objectTypeTemplate().

DtUiForParameterSignaller DtUiForParameter::mySignalHandler
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)