DtUiElement Class Reference

Base class of the ui element class chain. More...

Inheritance diagram for DtUiElement:

Public Types
typedef boost::function < DtUiElement *(makVrv::DtDe &)>	CreatorFunction
typedef std::map< std::string, CreatorFunction >	UiElementFactoryMap

Public Slots
virtual void	toggleDisplayed (bool display)

Signals
void	uiEvent (const DtUiElementEvent &)

Public Member Functions
	DtUiElement (makVrv::DtDe &)
	Constructor.
virtual	~DtUiElement ()
	Destructor.
virtual bool	blockSignals (bool)
virtual void	init (QWidget *widget, QWidget *label, DtReaderWriter *originalData, DtReaderWriter *backupData, DtElementChangedCallbackFcn=boost::bind(&DtUiElement::theNullFunction, _1))
virtual void	init (QWidget *widget, QWidget *label, const std::vector< DtReaderWriter * > &originalData, const std::vector< DtReaderWriter * > &backupData, DtElementChangedCallbackFcn=boost::bind(&DtUiElement::theNullFunction, _1))
virtual void	init (QWidget *widget, QWidget *label, const DtObjectType &, const DtString &platformType, DtElementChangedCallbackFcn=boost::bind(&DtUiElement::theNullFunction, _1))
virtual DtString	displayUnits () const
virtual void	setDisplayUnits (const DtString &units)
virtual void	setLabelText (const QString &)
virtual DtString	sourceUnits () const
virtual void	setSourceUnits (const DtString &units)
virtual void	setFromSystemParameterData (const DtSystemParameterData *data, const DtComponentSystemDefinition *)
	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	connectedTo (QObject *)
	Called when this item is connected to any signal emitted by the given item.
virtual void	processUiEvent (const DtUiElementEvent &)
	Process ui event. Default does nothing.
virtual void	setModelModified (DtModelSetEntry *)
	Called when the model is modified. Default is no-op.
virtual DtString	uniqueName () const
	Returns a unique name for this element.
virtual bool	supportsSystems () const
	Returns true if this element supports systes.
virtual const DtString &	platformType () const
	Returns the type of platform this entity represents.
virtual void	setPlatformType (const DtString &)
	Sets the type of platform for this entity.
virtual void	setObjectTypes (const std::vector< DtObjectType > &)
	Sets the object type this element represents.
virtual void	aboutToShow ()
	Called when about to show as part of a properties dialog. Default is no-op.
const std::vector < DtReaderWriter * > &	values () const
const std::vector < DtReaderWriter * > &	backupValues () const
virtual bool	isModified () const
virtual void	decorateElement ()
	Sets element decoration depending on the isModified state of the element.
virtual void	setFromParameters (DtReaderWriter *parentRw)
	Calls setFromParameters with std::vector of parameter.
virtual void	setFromParameters (const std::vector< DtReaderWriter * > &parentRw)
virtual bool	restoreFromBackup ()
	Restores this element from a backup created with the specified name.
const std::vector< DtObjectType > &	objectTypes () const
virtual void	sendEvent (const DtUiElementEvent &)
virtual bool	allValuesTheSame () const
virtual bool	isMixedValue () const
	If widget is line edit and the value is mixedText returns true, else the subclass will need to return this value.
virtual void	setEnabled (bool)
	If this item is not enabled it cannot be modified.
virtual bool	enabled () const

Static Public Member Functions
static void	registerUiTypes ()
	Factory methods for creating ui elements.
static DtUiElement *	createUiElement (makVrv::DtDe &, const DtString &type)
static bool	hasCreator (const DtString &)
static void	theNullFunction (DtUiElement *)
static UiElementFactoryMap &	elementFactory ()
static QString	mixedText ()
static void	setMixedText (const QString &)

Public Attributes
QWidget *	myWidget
QWidget *	myLabel

Protected Slots
virtual void	elementChanged ()
virtual void	enableIfChecked ()
	Connected to if the enable_if_checked property is set, and there is a matching check box for the enable_if_checked property.
virtual void	disableIfChecked ()
	Connected to if the disable_if_checked property is set, and there is a matching check box for the disable_if_checked property.

Protected Member Functions
virtual double	sourceToDisplayUnits (double) const
virtual double	displayToSourceUnits (double) const
virtual QString	units () const
virtual void	updateLabelTitle ()
	Updates label title based on valid units.
virtual QString	labelTitle () const
	Returns the unmodified label title.
virtual void	createControls (QWidget *parent)
	If additional widgets or connections need to be made do it here. The parent is the myWidget member.

Protected Attributes
DtString	myDisplayUnits
DtString	mySourceUnits
std::vector< DtReaderWriter * >	myValues
	Assumes 1 - 1 order that original and backup are same index in lists.
std::vector< DtReaderWriter * >	myBackupValues
bool	myIsNew
DtElementChangedCallbackFcn	myElementChangedCallbackFunction
DtUnit	mySource
DtUnit	myDestination
makVrv::DtDe &	myDe
DtString	myPlatformType
std::vector< DtObjectType >	myObjectTypes
const DtComponentSystemDefinition *	mySystemDefinition
bool	myEnabled
std::vector< QObject * >	myConnectedTo
int	myUniqueId

Static Protected Attributes
static UiElementFactoryMap	theFactory

Detailed Description

Base class of the ui element class chain.

Properties available through designer for all ui elements are: display-units (string) - Units to display for this element on the screen, if supported. See unitConversion.h for possible values source-units (string) - Units of the source reader/writer item for this element on the screen, if supported. See unitConversion.h for possible values element-type (string) - Override the element (reader/writer) type of the data element to the given supplied element type enable_if_checked (string) - Name of control (check box) that, if checked, will enable or disable this control item disable_if_checked (string) - Name of control (check box) that, if checked, will disable or enable this control item disable_if_multiple_selection (bool) - If true will disable this item if multiple items are selected

Member Typedef Documentation

typedef boost::function<DtUiElement* (makVrv::DtDe&)> DtUiElement::CreatorFunction

typedef std::map<std::string, CreatorFunction> DtUiElement::UiElementFactoryMap

Constructor & Destructor Documentation

DtUiElement::DtUiElement

(

makVrv::DtDe &

)

Constructor.

virtual DtUiElement::~DtUiElement ( )

virtual

Destructor.

Member Function Documentation

virtual bool DtUiElement::blockSignals ( bool  )

virtual

virtual void DtUiElement::init ( QWidget *  widget, QWidget *  label, DtReaderWriter *  originalData, DtReaderWriter *  backupData, DtElementChangedCallbackFcn  = boost::bind(&DtUiElement::theNullFunction, _1)  )

virtual

Reimplemented in DtUiMapAwareElement.

virtual void DtUiElement::init ( QWidget *  widget, QWidget *  label, const std::vector< DtReaderWriter * > &  originalData, const std::vector< DtReaderWriter * > &  backupData, DtElementChangedCallbackFcn  = boost::bind(&DtUiElement::theNullFunction, _1)  )

virtual

Reimplemented in DtUiMapAwareElement.

virtual void DtUiElement::init ( QWidget *  widget, QWidget *  label, const DtObjectType &  , const DtString &  platformType, DtElementChangedCallbackFcn  = boost::bind(&DtUiElement::theNullFunction, _1)  )

virtual

virtual DtString DtUiElement::displayUnits ( ) const

virtual

virtual void DtUiElement::setDisplayUnits ( const DtString &  units )

virtual

virtual void DtUiElement::setLabelText ( const QString &  )

virtual

virtual DtString DtUiElement::sourceUnits ( ) const

virtual

virtual void DtUiElement::setSourceUnits ( const DtString &  units )

virtual

virtual void DtUiElement::setFromSystemParameterData ( const DtSystemParameterData *  data, const DtComponentSystemDefinition *    )

virtual

Sets data of this UiElement from the specified system parameter data.

Sets things like sourceUnits, displayUnits, etc.

Reimplemented in DtUiPositionElement, DtUiArtPartElement, and DtUiSensorSensitivityElement.

virtual void DtUiElement::objectParametersModified ( )

inlinevirtual

This method is called any time that any of the parameters for the object are modified.

It is not called for the UI element that caused the modification itself, to avoid infinite loops. Default implementation does nothing.

virtual void DtUiElement::connectedTo ( QObject *  )

virtual

Called when this item is connected to any signal emitted by the given item.

Reimplemented in DtUiMapAwareElement.

virtual void DtUiElement::processUiEvent ( const DtUiElementEvent &  )

inlinevirtual

Process ui event. Default does nothing.

Reimplemented in DtUiDisplayWidgetCanvas, DtUiPropertiesTable, DtUiAggregateCompositionEditor, DtUiAggregateFormationEditor, DtUiBoundingVolumeElement, DtUiRealElement, DtUiSingleSystemElement, DtUiIntegerElement, DtUiMultiSystemElement, and DtUiPositionElement.

virtual void DtUiElement::setModelModified ( DtModelSetEntry *  )

virtual

Called when the model is modified. Default is no-op.

Reimplemented in DtUiAggregateCompositionEditor.

virtual DtString DtUiElement::uniqueName ( ) const

virtual

Returns a unique name for this element.

If there is a myValue returns the name of that value, else returns "DtUiElement"

Reimplemented in DtUiDisplayWidgetCanvas, DtUiGeneralCanvas, and DtUiSystemElement.

virtual bool DtUiElement::supportsSystems ( ) const

virtual

Returns true if this element supports systes.

Reimplemented in DtUiSystemElement.

virtual const DtString& DtUiElement::platformType ( ) const

virtual

Returns the type of platform this entity represents.

virtual void DtUiElement::setPlatformType ( const DtString &  )

virtual

Sets the type of platform for this entity.

virtual void DtUiElement::setObjectTypes ( const std::vector< DtObjectType > &  )

virtual

Sets the object type this element represents.

virtual void DtUiElement::aboutToShow ( )

virtual

Called when about to show as part of a properties dialog. Default is no-op.

Reimplemented in DtUiPositionElement.

const std::vector<DtReaderWriter*>& DtUiElement::values ( ) const

inline

const std::vector<DtReaderWriter*>& DtUiElement::backupValues ( ) const

inline

static void DtUiElement::registerUiTypes ( )

static

Factory methods for creating ui elements.

static DtUiElement* DtUiElement::createUiElement ( makVrv::DtDe &  , const DtString &  type  )

static

static bool DtUiElement::hasCreator ( const DtString &  )

static

static void DtUiElement::theNullFunction ( DtUiElement *  )

static

virtual bool DtUiElement::isModified ( ) const

virtual

Reimplemented in DtUiAggregateFormationEditor, DtUiAggregateCompositionEditor, DtUiSingleSystemElement, DtUiObjectGeometryElement, and DtUiMultiSystemElement.

virtual void DtUiElement::decorateElement ( )

virtual

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

This version changes myLabel font.

Reimplemented in DtUiAggregateCompositionEditor, DtUiAggregateFormationEditor, DtUiRealElement, DtUiVectorElement, DtUiSensorSignaturesElement, DtUiIntegerElement, and DtUiBooleanElement.

virtual void DtUiElement::setFromParameters ( DtReaderWriter *  parentRw )

virtual

Calls setFromParameters with std::vector of parameter.

virtual void DtUiElement::setFromParameters ( const std::vector< DtReaderWriter * > &  parentRw )

virtual

Reimplemented in DtUiDisplayWidgetCanvas, DtUiPropertiesTable, DtUiGeneralCanvas, DtUiAggregateCompositionEditor, DtUiAggregateFormationEditor, DtUiAggregateAssembliesElement, DtUiSystemElement, DtUiEnvironmentalSignatureModifier, DtUiSensorSensitivityElement, DtUiArtPartElement, DtUiBoundingVolumeElement, DtUiMultiSystemElement, DtUiSensorSignaturesElement, DtUiIntegerElement, DtUiBVSPCalculationElement, DtUiSingleSystemElement, DtUiSimulationObjectGroupElement, DtUiObjectGeometryElement, DtUiScriptedMovementSystemElement, DtUiListBoxElement, DtUiPositionElement, DtUiStringElement, DtUiVectorElement, DtUiEntityTypeElement, DtUiOrientationElement, DtUiBooleanElement, and DtUiRealElement.

virtual bool DtUiElement::restoreFromBackup ( )

virtual

Restores this element from a backup created with the specified name.

Optionally deletes the backup entry after restoring.

Returns

True if successfully restored.

static UiElementFactoryMap& DtUiElement::elementFactory ( )

inlinestatic

const std::vector<DtObjectType>& DtUiElement::objectTypes ( ) const

inline

virtual void DtUiElement::sendEvent ( const DtUiElementEvent &  )

virtual

virtual bool DtUiElement::allValuesTheSame ( ) const

virtual

static QString DtUiElement::mixedText ( )

static

static void DtUiElement::setMixedText ( const QString &  )

static

virtual bool DtUiElement::isMixedValue ( ) const

virtual

If widget is line edit and the value is mixedText returns true, else the subclass will need to return this value.

virtual void DtUiElement::setEnabled ( bool  )

virtual

If this item is not enabled it cannot be modified.

Reimplemented in DtUiDisplayWidgetCanvas, DtUiPropertiesTable, DtUiGeneralCanvas, DtUiBoundingVolumeElement, DtUiMultiSystemElement, DtUiSensorSignaturesElement, DtUiSingleSystemElement, DtUiVectorElement, and DtUiPropertiesDisplayContainer.

virtual bool DtUiElement::enabled ( ) const

virtual

virtual void DtUiElement::toggleDisplayed ( bool  display )

virtualslot

virtual void DtUiElement::elementChanged ( )

protectedvirtualslot

Reimplemented in DtUiAggregateCompositionEditor, DtUiAggregateFormationEditor, DtUiMultiSystemElement, DtUiVectorElement, DtUiBoundingVolumeElement, DtUiSingleSystemElement, DtUiPositionElement, DtUiRealElement, DtUiIntegerElement, DtUiOrientationElement, DtUiEntityTypeElement, DtUiScriptedMovementSystemElement, DtUiListBoxElement, DtUiBooleanElement, and DtUiStringElement.

virtual void DtUiElement::enableIfChecked ( )

protectedvirtualslot

Connected to if the enable_if_checked property is set, and there is a matching check box for the enable_if_checked property.

Will enable/disable the item based on the check state of the sender

virtual void DtUiElement::disableIfChecked ( )

protectedvirtualslot

Connected to if the disable_if_checked property is set, and there is a matching check box for the disable_if_checked property.

Will enable/disable the item based on the check state of the sender

void DtUiElement::uiEvent ( const DtUiElementEvent &  )

signal

virtual double DtUiElement::sourceToDisplayUnits ( double  ) const

protectedvirtual

virtual double DtUiElement::displayToSourceUnits ( double  ) const

protectedvirtual

virtual QString DtUiElement::units ( ) const

protectedvirtual

virtual void DtUiElement::updateLabelTitle ( )

protectedvirtual

Updates label title based on valid units.

Reimplemented in DtUiVectorElement.

virtual QString DtUiElement::labelTitle ( ) const

protectedvirtual

Returns the unmodified label title.

Reimplemented in DtUiVectorElement.

virtual void DtUiElement::createControls ( QWidget *  parent )

protectedvirtual

If additional widgets or connections need to be made do it here. The parent is the myWidget member.

Reimplemented in DtUiDisplayWidgetCanvas, DtUiPropertiesTable, DtUiGeneralCanvas, DtUiSystemElement, DtUiEnvironmentalSignatureModifier, DtUiAggregateFormationEditor, DtUiMultiSystemElement, DtUiRealElement, DtUiSingleSystemElement, DtUiArtPartElement, DtUiSimulationObjectGroupElement, DtUiBoundingVolumeElement, DtUiAggregateCompositionEditor, DtUiObjectGeometryElement, DtUiSensorSensitivityElement, DtUiVectorElement, DtUiSensorSignaturesElement, DtUiIntegerElement, DtUiEntityTypeElement, DtUiStringElement, DtUiListBoxElement, DtUiPositionElement, DtUiPropertiesDisplayContainer, DtUiScriptedMovementSystemElement, DtUiPushButtonElement, DtUiBVSPCalculationElement, DtUiComboBoxElement, DtUiOrientationElement, DtUiBooleanElement, and DtUiRandomizedObjectElement.

Member Data Documentation

QWidget* DtUiElement::myWidget

QWidget* DtUiElement::myLabel

UiElementFactoryMap DtUiElement::theFactory

staticprotected

DtString DtUiElement::myDisplayUnits

protected

DtString DtUiElement::mySourceUnits

protected

std::vector<DtReaderWriter*> DtUiElement::myValues

protected

Assumes 1 - 1 order that original and backup are same index in lists.

std::vector<DtReaderWriter*> DtUiElement::myBackupValues

protected

bool DtUiElement::myIsNew

protected

DtElementChangedCallbackFcn DtUiElement::myElementChangedCallbackFunction

protected

DtUnit DtUiElement::mySource

protected

DtUnit DtUiElement::myDestination

protected

makVrv::DtDe& DtUiElement::myDe

protected

DtString DtUiElement::myPlatformType

protected

std::vector<DtObjectType> DtUiElement::myObjectTypes

protected

const DtComponentSystemDefinition* DtUiElement::mySystemDefinition

protected

bool DtUiElement::myEnabled

protected

std::vector<QObject*> DtUiElement::myConnectedTo

protected

int DtUiElement::myUniqueId

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/simulationObjectEditorImpl/uiElement.h