Base class of the ui element class chain.
More...
Inherits QObject.
Inherited by DtGuiObjectsThatUseThisSystem, DtGuiSystemSupportsEntityKinds, DtUiAggregateCompositionEditor, DtUiAggregateFormationEditor, DtUiAirborneFuelConsumptionModelDataPoints, DtUiApplicableTargets, DtUiArtPartElement, DtUiAvailableAmmunition, DtUiBooleanElement, DtUiBoundingVolumeElement, DtUiBVSPCalculationElement, DtUiCanAggregate, DtUiCanCreateObject, DtUiDetonationParametersConfigurationWidget, DtUiDiGuyElement, DtUiDisplayWidgetCanvas, DtUiEntityEnumeration, DtUiEntityTypeElement, DtUiEnvironmentalSignatureModifier, DtUiGeneralCanvas, DtUiGuiAmmunitionApplicableTargets, DtUiGuiAmmunitionUsedBySystems, DtUiGuiAmmunitionWarhead, DtUiGuiCreatePalette, DtUiGuiDefaultOverlay, DtUiGuiEntityFile, DtUiGuiKeywords, DtUiGuiLabel, DtUiGuiMenuIcon, DtUiGuiScrollArea, DtUiGuiSystemAvailableParameters, DtUiHealthCheck, DtUiHitProbabilityConfigurationWidget, DtUiListBoxElement, DtUiMapAwareElement, DtUiObjectGeometryElement, DtUiObjectTypeListElement, DtUiPlatformUsed, DtUiPropertiesDisplayContainer, DtUiPropertiesTable, DtUiPushButtonElement, DtUiSensorSensitivityElement, DtUiSensorSignaturesElement, DtUiSimulationObjectCountries, DtUiSimulationObjectGroupElement, DtUiSimulationObjectTags, DtUiSystemElement, DtUiSystemFilename, DtUiSystemTemplateName, DtUiTargetRegion, DtUITrajectoryTableParameterElement, and DtUiVectorElement.
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 bool | isValid () const |
| | Used to enable/disable the OK button.
|
| 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< DtComponentSystemDefinition * > &) |
| | For those UI elements that work with system definitions this method will be implemented.
|
| 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 |
const std::vector
< DtComponentSystemDefinition * > & | systems () 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 |
| virtual void | setControllingCheckBox (QCheckBox *) |
| QCheckBox * | controllingCheckBox () |
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.
|
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
Constructor & Destructor Documentation
| virtual DtUiElement::~DtUiElement |
( |
| ) |
|
|
virtual |
Member Function Documentation
| virtual bool DtUiElement::blockSignals |
( |
bool |
| ) |
|
|
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::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.
Process ui event. Default does nothing.
Reimplemented in DtUiDisplayWidgetCanvas, DtUiGuiIconLists, DtUiPropertiesTable, DtUiHitProbabilityConfigurationWidget, DtUiAggregateCompositionEditor, DtUiAggregateFormationEditor, DtUiDamageTableConfigurationWidget, DtUiDetonationParametersConfigurationWidget, DtUiApplicableTargets, DtUiGuiSystemAvailableParameters, DtUiAvailableAmmunition, DtUiBoundingVolumeElement, DtUiRealElement, DtUiSingleSystemElement, DtUiIntegerElement, DtUiMultiSystemElement, DtUiTargetRegion, DtUiAggregateLoadoutsElement, DtUiPositionElement, DtUiDamageSystemHealth, DtUiDetonationEntityHealth, and DtUiWeaponSystemHealth.
| virtual DtString DtUiElement::uniqueName |
( |
| ) |
const |
|
virtual |
| virtual bool DtUiElement::supportsSystems |
( |
| ) |
const |
|
virtual |
| 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.
Reimplemented in DtUiEntityHealth.
| 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::backupValues |
( |
| ) |
const |
|
inline |
| static void DtUiElement::registerUiTypes |
( |
| ) |
|
|
static |
Factory methods for creating ui elements.
| static void DtUiElement::theNullFunction |
( |
DtUiElement * |
| ) |
|
|
static |
| virtual bool DtUiElement::isModified |
( |
| ) |
const |
|
virtual |
Reimplemented in DtUiGuiIconLists, DtUiGuiMenuIcon, DtUiSimulationObjectCountries, DtUiSimulationObjectTags, DtUiGuiDefaultOverlay, DtUiGuiCreatePalette, DtUiCanAggregate, DtUiCanCreateObject, DtUiSystemTemplateName, DtUiSystemFilename, DtUiEntityEnumeration, DtGuiObjectsThatUseThisSystem, DtUiAggregateFormationEditor, DtUiGuiAmmunitionApplicableTargets, DtGuiSystemSupportsEntityKinds, DtUiAggregateCompositionEditor, DtUiGuiKeywords, DtUiGuiSystemAvailableParameters, DtUiSingleSystemElement, DtUiGuiLabel, DtUiObjectGeometryElement, DtUiSystemTags, and DtUiMultiSystemElement.
| virtual bool DtUiElement::isValid |
( |
| ) |
const |
|
virtual |
| virtual void DtUiElement::decorateElement |
( |
| ) |
|
|
virtual |
Sets element decoration depending on the isModified state of the element.
This version changes myLabel font.
Reimplemented in DtUiSimulationObjectCountries, DtUiSimulationObjectTags, DtUiCanAggregate, DtUiCanCreateObject, DtUiPropertiesTable, DtUiAggregateCompositionEditor, DtUiGuiAmmunitionUsedBySystems, DtUiAggregateFormationEditor, DtUiAvailableAmmunition, DtUiMultiSystemElement, DtUiApplicableTargets, DtUiVectorElement, DtUiRealElement, DtUiTargetRegion, DtUiAirborneFuelConsumptionModelDataPoints, DtUiSensorSignaturesElement, DtUiIntegerElement, and DtUiBooleanElement.
| virtual void DtUiElement::setFromParameters |
( |
DtReaderWriter * |
parentRw | ) |
|
|
virtual |
Calls setFromParameters with std::vector of parameter.
For those UI elements that work with system definitions this method will be implemented.
For those that do not the default is to simply set the member to conatin the systems defined
Reimplemented in DtUiSystemTemplateName, DtUiSystemFilename, DtGuiObjectsThatUseThisSystem, DtGuiSystemSupportsEntityKinds, DtUiDamageTableConfigurationWidget, DtUiGuiSystemAvailableParameters, DtUiApplicableTargets, DtUiAvailableAmmunition, DtUiSystemHealth, DtUiTargetRegion, and DtUiSystemTags.
| virtual void DtUiElement::setFromParameters |
( |
const std::vector< DtReaderWriter * > & |
parentRw | ) |
|
|
virtual |
Reimplemented in DtUiDisplayWidgetCanvas, DtUiGuiScrollArea, DtUiGuiIconLists, DtUiGuiMenuIcon, DtUiSimulationObjectCountries, DtUiSimulationObjectTags, DtUiGuiDefaultOverlay, DtUiGuiCreatePalette, DtUiCanAggregate, DtUiCanCreateObject, DtUiNonPropagatingEntityTypeEnumeration, DtUiPropertiesTable, DtUiEntityEnumeration, DtUiGeneralCanvas, DtUiGuiEntityFile, DtUiGuiAmmunitionApplicableTargets, DtUiPlatformUsed, DtUiAggregateAssembliesElement, DtUiHitProbabilityConfigurationWidget, DtUiAggregateCompositionEditor, DtUiAggregateFormationEditor, DtUiGuiAmmunitionUsedBySystems, DtUiGuiKeywords, DtUiDetonationParametersConfigurationWidget, DtUiDamageTableConfigurationWidget, DtUiApplicableTargets, DtUiDiGuyElement, DtUiSystemElement, DtUiEnvironmentalSignatureModifier, DtUiEntityHealth, DtUiAvailableAmmunition, DtUiSensorSensitivityElement, DtUiArtPartElement, DtUiBoundingVolumeElement, DtUiGuiAmmunitionWarhead, DtUiMultiSystemElement, DtUiGuiLabel, DtUiSensorSignaturesElement, DtUiIntegerElement, DtUiTargetRegion, DtUiBVSPCalculationElement, DtUiSingleSystemElement, DtUiSimulationObjectGroupElement, DtUiObjectTypeListElement, DtUiAirborneFuelConsumptionModelDataPoints, DtUiObjectGeometryElement, DtUiScriptedMovementSystemElement, DtUiListBoxElement, DtUiPositionElement, DtUITrajectoryTableParameterElement, DtUiVectorElement, DtUiAggregateLoadoutsElement, DtUiStringElement, 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.
| const std::vector<DtObjectType>& DtUiElement::objectTypes |
( |
| ) |
const |
|
inline |
| 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, DtUiGuiScrollArea, DtUiPropertiesTable, DtUiHitProbabilityConfigurationWidget, DtUiGeneralCanvas, DtGuiObjectsThatUseThisSystem, DtUiAvailableAmmunition, DtUiDamageTableConfigurationWidget, DtUiGuiSystemAvailableParameters, DtUiDetonationParametersConfigurationWidget, DtUiBoundingVolumeElement, DtUiMultiSystemElement, DtUiSensorSignaturesElement, DtUITrajectoryTableParameterElement, DtUiSingleSystemElement, DtUiVectorElement, and DtUiPropertiesDisplayContainer.
| virtual bool DtUiElement::enabled |
( |
| ) |
const |
|
virtual |
| virtual void DtUiElement::setControllingCheckBox |
( |
QCheckBox * |
| ) |
|
|
virtual |
| QCheckBox* DtUiElement::controllingCheckBox |
( |
| ) |
|
|
inline |
| virtual void DtUiElement::toggleDisplayed |
( |
bool |
display | ) |
|
|
virtualslot |
| virtual void DtUiElement::elementChanged |
( |
| ) |
|
|
protectedvirtualslot |
Reimplemented in DtUiPropertiesTable, DtUiAggregateCompositionEditor, DtUiAggregateFormationEditor, DtUiGuiKeywords, DtUiVectorElement, DtUiMultiSystemElement, DtUiGuiLabel, DtUiBoundingVolumeElement, DtUiSingleSystemElement, DtUiPositionElement, DtUiRealElement, DtUiIntegerElement, DtUiOrientationElement, DtUITrajectoryTableParameterElement, 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
Reimplemented in DtUiNonPropagatingEntityTypeEnumeration.
| 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
Reimplemented in DtUiNonPropagatingEntityTypeEnumeration.
| void DtUiElement::changed |
( |
| ) |
|
|
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 |
| virtual QString DtUiElement::labelTitle |
( |
| ) |
const |
|
protectedvirtual |
| 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, DtUiGuiScrollArea, DtUiGuiIconLists, DtUiGuiMenuIcon, DtUiSimulationObjectCountries, DtUiSimulationObjectTags, DtUiGuiDefaultOverlay, DtUiGuiCreatePalette, DtUiCanAggregate, DtUiCanCreateObject, DtUiSystemTemplateName, DtUiPropertiesTable, DtUiSystemFilename, DtUiEntityEnumeration, DtUiGeneralCanvas, DtGuiObjectsThatUseThisSystem, DtUiGuiEntityFile, DtUiGuiAmmunitionApplicableTargets, DtUiPlatformUsed, DtGuiSystemSupportsEntityKinds, DtUiSystemElement, DtUiHitProbabilityConfigurationWidget, DtUiGuiAmmunitionUsedBySystems, DtUiGuiKeywords, DtUiDamageTableConfigurationWidget, DtUiGuiSystemAvailableParameters, DtUiDetonationParametersConfigurationWidget, DtUiEnvironmentalSignatureModifier, DtUiApplicableTargets, DtUiAggregateFormationEditor, DtUiHealthCheck, DtUiAvailableAmmunition, DtUiGuiAmmunitionWarhead, DtUiMultiSystemElement, DtUiRealElement, DtUiGuiLabel, DtUiDiGuyElement, DtUiSingleSystemElement, DtUiArtPartElement, DtUiSimulationObjectGroupElement, DtUiTargetRegion, DtUiVectorElement, DtUiBoundingVolumeElement, DtUITrajectoryTableParameterElement, DtUiAggregateCompositionEditor, DtUiObjectGeometryElement, DtUiSensorSensitivityElement, DtUiIntegerElement, DtUiObjectTypeListElement, DtUiSensorSignaturesElement, DtUiEntityTypeElement, DtUiStringElement, DtUiAirborneFuelConsumptionModelDataPoints, DtUiListBoxElement, DtUiPositionElement, DtUiPropertiesDisplayContainer, DtUiScriptedMovementSystemElement, DtUiPushButtonElement, DtUiBVSPCalculationElement, DtUiComboBoxElement, DtUiOrientationElement, DtUiBooleanElement, and DtUiRandomizedObjectElement.
Member Data Documentation
| QWidget* DtUiElement::myWidget |
| QWidget* DtUiElement::myLabel |
Assumes 1 - 1 order that original and backup are same index in lists.
| bool DtUiElement::myIsNew |
|
protected |
| DtUnit DtUiElement::myDestination |
|
protected |
| bool DtUiElement::myEnabled |
|
protected |
| std::vector<QObject*> DtUiElement::myConnectedTo |
|
protected |
| int DtUiElement::myUniqueId |
|
protected |
| QCheckBox* DtUiElement::myControllingCheckBox |
|
protected |
The documentation for this class was generated from the following file:
- /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/simulationObjectEditorImpl/uiElement.h