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

Public Member Functions

 DtUiBooleanElement (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 Constructor.
virtual ~DtUiBooleanElement ()
 Destructor.
 DtUiBooleanElement (const DtUiBooleanElement &orig)
 Copy constructor.
DtUiBooleanElementoperator= (const DtUiBooleanElement &orig)
 Assignment operator.
- Public Member Functions inherited from DtUiElement
 DtUiElement (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 Constructor.
virtual ~DtUiElement ()
 Destructor.
 DtUiElement (const DtUiElement &orig)
 Copy constructor.
DtUiElementoperator= (const DtUiElement &orig)
 Assignment operator.
virtual const DtStringobjectName () const
virtual void setTitle (const DtString &s)
virtual void setObjectName (const DtString &s)
virtual void mergeInto (DtUiForParameter *)
virtual DtUiElementelementNamed (const DtString &)
virtual bool mergeInto (const DtString &readerWriterName, bool after, DtUiElement *element)
virtual void init ()
virtual DtString sourceReaderWriterName () const
virtual void setSourceReaderWriterName (const DtString &name)
virtual DtString displayUnits () const
virtual void setDisplayUnits (const DtString &units)
virtual DtString sourceUnits () const
virtual void setSourceUnits (const DtString &units)
virtual DtString tooltip () const
virtual void setTooltip (const DtString &text)
virtual void setFromSystemParameterData (const DtSystemParameterData *data)
 Sets data of this UiElement from the specified system parameter data.
virtual void objectParametersModified ()
 This method is called any time that any of the parameters for the object are modified.
virtual void processUiEvent (const DtUiElementEvent &)
 Process ui event. Default does nothing.
DtReaderWriterRegistryDatavalue () const
DtReaderWriterRegistryDatabackupValue () const
virtual void initForControls ()
 Initializes element before creating controls. Sets parameter values to NULL.
virtual void setModelModified (DtModelSetEntry *)
 Called when the model is modified. Default is no-op.
DtUiElementSignalHandlersignalHandler ()
virtual void uiState (QMap< QString, QVariant > &state) const
 State is a dictionary of a string that uniquely identifies a control and its state.
virtual void setUiState (const QMap< QString, QVariant > &)
virtual void sendUpdatedUiState ()
 Sends out updated ui state with message.
virtual bool isModified () const
virtual void addElementChangedCallback (DtElementChangedCallbackFcn f, void *usr)
virtual void removeElementChangedCallback (DtElementChangedCallbackFcn f, void *usr)
virtual void removeAllCallbacks ()
virtual
DtReaderWriterRegistryData
createBackup (const DtString &backupName)
 Creates a backup entry in the RW structure for the current value of this element.
virtual bool restoreFromBackup (const DtString &backupName, bool deleteBackup=false)
 Restores this element from a backup created with the specified name.
virtual void deleteBackup (const DtString &backupName)
 Deletes backup entries previously created with createBackup, with the specified name.
const DtCallbackList
< DtUiElement * > & 
elementChangedCallbackList () const
void setElementChangedCallbackList (const DtCallbackList< DtUiElement * > &)
virtual
DtReaderWriterRegistryData
value (DtReaderWriter *parentRw)
 Seeds myValue and myBackupValue if not set.
virtual
DtReaderWriterRegistryData
value (DtReaderWriter *parentRw, const DtString &rw, DtReaderWriterRegistryData **backupValue) const
virtual bool centerElement () const
 Returns whether or not to center the element on the display.
virtual void finalizeSize (QWidget *)
 Adjusts size of child by looking at min/max size. If any values are non-zero, sets to that value.
- 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 getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
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 const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
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 QWidgetcreateLabelWidget (QWidget *parent)
 Create and return the label widget for this element.
virtual QWidgetcreateControls (QWidget *)
 Creates and returns the non-label part of the element.
virtual void setFromParameters (DtReaderWriter *parentRw)
virtual void elementChanged ()
virtual void decorateElement ()
 Sets element decoration depending on the isModified state of the element.
virtual DtUiElementclone ()
- Protected Member Functions inherited from DtUiElement
virtual QWidgetcreateDataEntryElement (QWidget *)
virtual double sourceToDestination (double) const
virtual double destinationToSource (double) const
virtual QString units () const
- 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.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.

Protected Attributes

QCheckBoxmyCheckBox
- Protected Attributes inherited from DtUiElement
DtRwString myReaderWriterName
DtRwString myTitle
DtRwString myDisplayUnits
DtRwString mySourceUnits
DtRwString myObjectName
DtRwString myTooltip
DtRwBoolean myCenterElement
DtRwInt myMaximumWidth
DtRwInt myMaximumHeight
DtRwInt myMinimumWidth
DtRwInt myMinimumHeight
DtReaderWriterRegistryDatamyValue
DtReaderWriterRegistryDatamyBackupValue
DtUiElementSignalHandler mySignalHandler
DtRwBoolean mySetVisible
bool myIsNew
QWidgetmyLabel
DtCallbackList< DtUiElement * > myElementChangedCallbackList
DtUnit mySource
DtUnit myDestination
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.

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 DtUiElement
static void registerUiTypes ()
 Factory methods for creating ui elements.
static DtUiElementcreateUiElement (const DtString &type, const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
static DtReaderWriterFactoryelementFactory ()
- Static Protected Attributes inherited from DtUiElement
static DtReaderWriterFactory theFactory
static DtUnitConverterFactory theConversionFactory

Constructor & Destructor Documentation

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

Constructor.

virtual DtUiBooleanElement::~DtUiBooleanElement ( )
virtual

Destructor.

DtUiBooleanElement::DtUiBooleanElement ( const DtUiBooleanElement orig)

Copy constructor.

Member Function Documentation

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

Assignment operator.

virtual QWidget* DtUiBooleanElement::createLabelWidget ( QWidget parent)
inlineprotectedvirtual

Create and return the label widget for this element.

May return NULL if not special label element is needed.

Reimplemented from DtUiElement.

virtual QWidget* DtUiBooleanElement::createControls ( QWidget parent)
protectedvirtual

Creates and returns the non-label part of the element.

Reimplemented from DtUiElement.

virtual void DtUiBooleanElement::setFromParameters ( DtReaderWriter parentRw)
protectedvirtual

Reimplemented from DtUiElement.

virtual void DtUiBooleanElement::elementChanged ( )
protectedvirtual

Reimplemented from DtUiElement.

virtual void DtUiBooleanElement::decorateElement ( )
protectedvirtual

Sets element decoration depending on the isModified state of the element.

This version changes myLabel font.

Reimplemented from DtUiElement.

virtual DtUiElement* DtUiBooleanElement::clone ( )
protectedvirtual

Implements DtUiElement.

Member Data Documentation

QCheckBox* DtUiBooleanElement::myCheckBox
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)