DtUiElement Class Reference

Inheritance diagram for DtUiElement:

List of all members.

Public Member Functions
	DtUiElement (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	Constructor.
virtual	~DtUiElement ()
	Destructor.
	DtUiElement (const DtUiElement &orig)
	Copy constructor.
DtUiElement &	operator= (const DtUiElement &orig)
	Assignment operator.
virtual const DtString &	objectName () const
virtual void	setTitle (const DtString &s)
virtual void	setObjectName (const DtString &s)
virtual void	mergeInto (DtUiForParameter *)
virtual DtUiElement *	elementNamed (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.
DtReaderWriterRegistryData *	value () const
DtReaderWriterRegistryData *	backupValue () 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.
DtUiElementSignalHandler *	signalHandler ()
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 DtUiElement *	clone ()=0
virtual bool	isModified () const
virtual void	decorateElement ()
	Sets element decoration depending on the isModified state of the element.
virtual QWidget *	createLabelWidget (QWidget *parent)
	Create and return the label widget for this element.
virtual QWidget *	createControls (QWidget *parent)
	Creates and returns the non-label part of the element.
virtual void	setFromParameters (DtReaderWriter *parentRw)
virtual void	elementChanged ()
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)
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.
Static Public Member Functions
static void	registerUiTypes ()
	Factory methods for creating ui elements.
static DtUiElement *	createUiElement (const DtString &type, const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
static DtReaderWriterFactory *	elementFactory ()
Protected Member Functions
virtual QWidget *	createDataEntryElement (QWidget *)
virtual double	sourceToDestination (double) const
virtual double	destinationToSource (double) const
virtual QString	units () const
Protected Attributes
DtRwString	myReaderWriterName
DtRwString	myTitle
DtRwString	myDisplayUnits
DtRwString	mySourceUnits
DtRwString	myObjectName
DtRwString	myTooltip
DtRwBoolean	myCenterElement
DtRwInt	myMaximumWidth
DtRwInt	myMaximumHeight
DtRwInt	myMinimumWidth
DtRwInt	myMinimumHeight
DtReaderWriterRegistryData *	myValue
DtReaderWriterRegistryData *	myBackupValue
DtUiElementSignalHandler	mySignalHandler
DtRwBoolean	mySetVisible
bool	myIsNew
QWidget *	myLabel
DtCallbackList< DtUiElement * >	myElementChangedCallbackList
DtUnit	mySource
DtUnit	myDestination
Static Protected Attributes
static DtReaderWriterFactory	theFactory
static DtUnitConverterFactory	theConversionFactory

---

Constructor & Destructor Documentation

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

Constructor.

virtual DtUiElement::~DtUiElement

(

)

[virtual]

Destructor.

DtUiElement::DtUiElement

(

const DtUiElement &

orig

)

Copy constructor.

---

Member Function Documentation

DtUiElement& DtUiElement::operator=

(

const DtUiElement &

orig

)

Assignment operator.

virtual const DtString& DtUiElement::objectName

(

)

const [virtual]

Reimplemented in DtUiLayoutElement.

virtual void DtUiElement::setTitle

(

const DtString &

s

)

[virtual]

Reimplemented in DtLayoutElement.

virtual void DtUiElement::setObjectName

(

const DtString &

s

)

[virtual]

virtual void DtUiElement::mergeInto

(

DtUiForParameter *

)

[virtual]

Reimplemented in DtUiAddItemElement, DtUiAddToLayoutElement, and DtUiLayoutElement.

virtual DtUiElement* DtUiElement::elementNamed

(

const DtString &

)

[virtual]

Reimplemented in DtUiLayoutElement.

virtual bool DtUiElement::mergeInto	(	const DtString &	readerWriterName,
		bool	after,
		DtUiElement *	element
	)		[virtual]

Reimplemented in DtUiLayoutElement.

virtual void DtUiElement::init

(

)

[virtual]

Reimplemented in DtUiSystemElement.

virtual DtString DtUiElement::sourceReaderWriterName

(

)

const [virtual]

virtual void DtUiElement::setSourceReaderWriterName

(

const DtString &

name

)

[virtual]

virtual DtString DtUiElement::displayUnits

(

)

const [virtual]

virtual void DtUiElement::setDisplayUnits

(

const DtString &

units

)

[virtual]

virtual DtString DtUiElement::sourceUnits

(

)

const [virtual]

virtual void DtUiElement::setSourceUnits

(

const DtString &

units

)

[virtual]

virtual DtString DtUiElement::tooltip

(

)

const [virtual]

virtual void DtUiElement::setTooltip

(

const DtString &

text

)

[virtual]

virtual void DtUiElement::setFromSystemParameterData

(

const DtSystemParameterData *

data

)

[virtual]

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

Sets things like sourceUnits, displayUnits, etc.

Reimplemented in DtUiPositionElement, and DtUiArtPartElement.

virtual void DtUiElement::objectParametersModified

(

)

[inline, virtual]

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.

Reimplemented in DtUiLayoutElement, DtUiAutoContactFusionElement, DtUiModelResolutionConfigurationElement, DtUiAutoConnectionElement, and DtUiAutoTargetSelectionElement.

virtual void DtUiElement::processUiEvent

(

const DtUiElementEvent &

)

[inline, virtual]

Process ui event. Default does nothing.

Reimplemented in DtUiLayoutElement, DtUiAggregateCompositionEditor, DtUiAggregateFormationEditor, DtUiMultiSystemElement, DtUiBoundingVolumeElement, DtUiSingleSystemElement, DtUiPositionElement, DtUiItemComponent, and DtUiDIGuyElement.

DtReaderWriterRegistryData * DtUiElement::value

(

)

const [inline]

References myValue.

DtReaderWriterRegistryData * DtUiElement::backupValue

(

)

const [inline]

References myBackupValue.

virtual void DtUiElement::initForControls

(

)

[virtual]

Initializes element before creating controls. Sets parameter values to NULL.

virtual void DtUiElement::setModelModified

(

DtModelSetEntry *

)

[virtual]

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

Reimplemented in DtUiLayoutElement, DtUiAggregateFormationEditor, and DtUiAggregateCompositionEditor.

DtUiElementSignalHandler* DtUiElement::signalHandler

(

)

[inline]

virtual void DtUiElement::uiState

(

QMap< QString, QVariant > &

state

)

const [virtual]

State is a dictionary of a string that uniquely identifies a control and its state.

Reimplemented in DtUiLayoutElement, and DtUiAggregateFormationEditor.

virtual void DtUiElement::setUiState

(

const QMap< QString, QVariant > &

)

[virtual]

Reimplemented in DtUiLayoutElement, and DtUiAggregateFormationEditor.

virtual void DtUiElement::sendUpdatedUiState

(

)

[virtual]

Sends out updated ui state with message.

static void DtUiElement::registerUiTypes

(

)

[static]

Factory methods for creating ui elements.

static DtUiElement* DtUiElement::createUiElement	(	const DtString &	type,
		const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		[static]

virtual DtUiElement* DtUiElement::clone

(

)

[pure virtual]

Implemented in DtUiAddItemElement, DtUiAddToLayoutElement, DtUiLayoutElement, DtVerticalLayoutElement, DtHorizontalLayoutElement, DtUiAggregateFormationEditor, DtGridLayoutElement, DtUiAutoConnectionElement, DtUiAutoContactFusionElement, DtUiSystemElement, DtUiAutoTargetSelectionElement, DtUiMultiSystemElement, DtUiAggregateCompositionEditor, DtUiModelResolutionConfigurationElement, DtUiPositionElement, DtUiOccupancyDirectorController, DtUiSingleSystemElement, DtUiOrientationElement, DtUiItemComponent, DtUiArtPartElement, DtUiItemRadio, DtUiCombatRangeControllerElement, DtUiDIGuyElement, DtUiRealElement, DtUiSensorSignaturesElement, DtUiBooleanElement, DtUiBoundingVolumeElement, DtUiComboBoxElement, DtUiIntegerElement, DtUiStringElement, DtUiVectorElement, DtUiResourcesElement, and DtUiFrameElement.

virtual bool DtUiElement::isModified

(

)

const [virtual]

Reimplemented in DtUiLayoutElement, DtUiAggregateFormationEditor, DtUiSystemElement, DtUiOccupancyDirectorController, DtUiDIGuyElement, DtUiMultiSystemElement, DtUiItemComponent, DtUiItemRadio, DtUiCombatRangeControllerElement, and DtUiSingleSystemElement.

virtual void DtUiElement::decorateElement

(

)

[virtual]

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

This version changes myLabel font.

Reimplemented in DtUiAggregateFormationEditor, DtUiAggregateCompositionEditor, DtUiPositionElement, DtUiMultiSystemElement, DtUiOrientationElement, DtUiDIGuyElement, DtUiSensorSignaturesElement, DtUiBoundingVolumeElement, DtUiVectorElement, DtUiBooleanElement, and DtUiFrameElement.

virtual QWidget* DtUiElement::createLabelWidget

(

QWidget *

parent

)

[virtual]

Create and return the label widget for this element.

May return NULL if not special label element is needed.

Reimplemented in DtUiLayoutElement, DtUiAggregateFormationEditor, DtUiAggregateCompositionEditor, DtUiMultiSystemElement, DtUiOccupancyDirectorController, DtLayoutElement, DtUiPositionElement, DtUiOrientationElement, DtUiItemComponent, DtUiItemRadio, DtUiCombatRangeControllerElement, DtUiSensorSignaturesElement, DtUiBoundingVolumeElement, DtUiDIGuyElement, and DtUiBooleanElement.

virtual QWidget* DtUiElement::createControls

(

QWidget *

parent

)

[virtual]

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

Reimplemented in DtUiLayoutElement, DtVerticalLayoutElement, DtHorizontalLayoutElement, DtUiAggregateFormationEditor, DtGridLayoutElement, DtUiAggregateCompositionEditor, DtUiMultiSystemElement, DtUiOccupancyDirectorController, DtUiModelResolutionConfigurationElement, DtUiPositionElement, DtUiAutoContactFusionElement, DtUiOrientationElement, DtUiAutoConnectionElement, DtUiAutoTargetSelectionElement, DtUiItemComponent, DtUiItemRadio, DtUiCombatRangeControllerElement, DtUiSensorSignaturesElement, DtUiBoundingVolumeElement, DtUiDIGuyElement, DtUiBooleanElement, DtUiVectorElement, DtUiResourcesElement, DtUiFrameElement, and DtUiLoadPositionElement.

virtual void DtUiElement::setFromParameters

(

DtReaderWriter *

parentRw

)

[virtual]

Reimplemented in DtUiLayoutElement, DtUiAggregateFormationEditor, DtUiAutoConnectionElement, DtUiSystemElement, DtUiAutoContactFusionElement, DtUiAutoTargetSelectionElement, DtUiAggregateCompositionEditor, DtUiModelResolutionConfigurationElement, DtUiMultiSystemElement, DtUiOccupancyDirectorController, DtUiArtPartElement, DtUiPositionElement, DtUiDIGuyElement, DtUiOrientationElement, DtUiSensorSignaturesElement, DtUiBoundingVolumeElement, DtUiItemComponent, DtUiSingleSystemElement, DtUiIntegerElement, DtUiItemRadio, DtUiCombatRangeControllerElement, DtUiVectorElement, DtUiStringElement, DtUiBooleanElement, DtUiComboBoxElement, and DtUiRealElement.

virtual void DtUiElement::elementChanged

(

)

[virtual]

Reimplemented in DtUiAggregateFormationEditor, DtUiAggregateCompositionEditor, DtUiMultiSystemElement, DtUiOccupancyDirectorController, DtUiPositionElement, DtUiOrientationElement, DtUiSingleSystemElement, DtUiDIGuyElement, DtUiSensorSignaturesElement, DtUiBoundingVolumeElement, DtUiItemComponent, DtUiIntegerElement, DtUiItemRadio, DtUiCombatRangeControllerElement, DtUiStringElement, DtUiVectorElement, DtUiRealElement, DtUiBooleanElement, and DtUiComboBoxElement.

virtual void DtUiElement::addElementChangedCallback	(	DtElementChangedCallbackFcn	f,
		void *	usr
	)		[virtual]

Reimplemented in DtUiLayoutElement.

virtual void DtUiElement::removeElementChangedCallback	(	DtElementChangedCallbackFcn	f,
		void *	usr
	)		[virtual]

Reimplemented in DtUiLayoutElement.

virtual void DtUiElement::removeAllCallbacks

(

)

[virtual]

Reimplemented in DtUiLayoutElement.

virtual DtReaderWriterRegistryData* DtUiElement::createBackup

(

const DtString &

backupName

)

[virtual]

Creates a backup entry in the RW structure for the current value of this element.

The backup is named with the specified name.

Returns:

The pointer to the backup RW entry.

Reimplemented in DtUiPositionElement.

virtual bool DtUiElement::restoreFromBackup	(	const DtString &	backupName,
		bool	deleteBackup = false
	)		[virtual]

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

Optionally deletes the backup entry after restoring.

Returns:

True if successfully restored.

virtual void DtUiElement::deleteBackup

(

const DtString &

backupName

)

[virtual]

Deletes backup entries previously created with createBackup, with the specified name.

Reimplemented in DtUiPositionElement.

const DtCallbackList< DtUiElement * > & DtUiElement::elementChangedCallbackList

(

)

const [inline]

References myElementChangedCallbackList.

void DtUiElement::setElementChangedCallbackList

(

const DtCallbackList< DtUiElement * > &

lst

)

[inline]

References myElementChangedCallbackList.

virtual DtReaderWriterRegistryData* DtUiElement::value

(

DtReaderWriter *

parentRw

)

[virtual]

Seeds myValue and myBackupValue if not set.

Returns myValue based on myReaderWriterName

Reimplemented in DtUiAutoConnectionElement, DtUiSystemElement, DtUiAutoContactFusionElement, DtUiAutoTargetSelectionElement, DtUiMultiSystemElement, and DtUiSingleSystemElement.

virtual DtReaderWriterRegistryData* DtUiElement::value	(	DtReaderWriter *	parentRw,
		const DtString &	rw,
		DtReaderWriterRegistryData **	backupValue
	)		[virtual]

static DtReaderWriterFactory* DtUiElement::elementFactory

(

)

[static]

virtual bool DtUiElement::centerElement

(

)

const [virtual]

Returns whether or not to center the element on the display.

virtual void DtUiElement::finalizeSize

(

QWidget *

)

[virtual]

Adjusts size of child by looking at min/max size. If any values are non-zero, sets to that value.

virtual QWidget* DtUiElement::createDataEntryElement

(

QWidget *

)

[protected, virtual]

Reimplemented in DtUiAutoContactFusionElement, DtUiAutoConnectionElement, DtUiAutoTargetSelectionElement, DtUiArtPartElement, DtUiSingleSystemElement, DtUiRealElement, DtUiIntegerElement, DtUiComboBoxElement, and DtUiStringElement.

virtual double DtUiElement::sourceToDestination

(

double

)

const [protected, virtual]

virtual double DtUiElement::destinationToSource

(

double

)

const [protected, virtual]

virtual QString DtUiElement::units

(

)

const [protected, virtual]

---

Member Data Documentation

DtReaderWriterFactory DtUiElement::theFactory [static, protected]

Reimplemented from DtReaderWriter.

DtRwString DtUiElement::myReaderWriterName [protected]

DtRwString DtUiElement::myTitle [protected]

Reimplemented in DtLayoutElement.

Referenced by DtLayoutElement::title().

DtRwString DtUiElement::myDisplayUnits [protected]

DtRwString DtUiElement::mySourceUnits [protected]

DtRwString DtUiElement::myObjectName [protected]

DtRwString DtUiElement::myTooltip [protected]

DtRwBoolean DtUiElement::myCenterElement [protected]

DtRwInt DtUiElement::myMaximumWidth [protected]

DtRwInt DtUiElement::myMaximumHeight [protected]

DtRwInt DtUiElement::myMinimumWidth [protected]

DtRwInt DtUiElement::myMinimumHeight [protected]

DtReaderWriterRegistryData* DtUiElement::myValue [protected]

Referenced by value().

DtReaderWriterRegistryData* DtUiElement::myBackupValue [protected]

Referenced by backupValue().

DtUiElementSignalHandler DtUiElement::mySignalHandler [protected]

DtRwBoolean DtUiElement::mySetVisible [protected]

bool DtUiElement::myIsNew [protected]

QWidget* DtUiElement::myLabel [protected]

Reimplemented in DtUiMultiSystemElement.

DtCallbackList<DtUiElement*> DtUiElement::myElementChangedCallbackList [protected]

Referenced by elementChangedCallbackList(), and setElementChangedCallbackList().

DtUnit DtUiElement::mySource [protected]

DtUnit DtUiElement::myDestination [protected]

DtUnitConverterFactory DtUiElement::theConversionFactory [static, protected]

---

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

• include/entityEditorImpl/uiElement.h