DtUiAggregateCompositionEditor Class Reference

Inheritance diagram for DtUiAggregateCompositionEditor:

Public Types
typedef std::list< DtObjectType >	DtObjectTypeList

Public Member Functions
	DtUiAggregateCompositionEditor (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	Constructor.
virtual	~DtUiAggregateCompositionEditor ()
	Destructor.
	DtUiAggregateCompositionEditor (const DtUiAggregateCompositionEditor &orig)
	Copy constructor.
DtUiAggregateCompositionEditor &	operator= (const DtUiAggregateCompositionEditor &orig)
	Assignment operator.
virtual QWidget *	createLabelWidget (QWidget *parent)
	Create and return the label widget for this element.
virtual QWidget *	createControls (QWidget *)
	Creates and returns the non-label part of the element.
virtual bool	canMoveUp () const
virtual bool	canMoveDown () const
Public Member Functions inherited from DtUiElement
	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.
DtReaderWriterRegistryData *	value () const
DtReaderWriterRegistryData *	backupValue () const
virtual void	initForControls ()
	Initializes element before creating controls. Sets parameter values to NULL.
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 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 DtReaderWriter &	operator= (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 aliasContainer &	aliases () 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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions
virtual bool	isModified () const
virtual bool	formationIsModified () const
virtual DtUiElement *	clone ()
virtual void	decorateElement ()
	Sets element decoration depending on the isModified state of the element.
virtual void	setFromParameters (DtReaderWriter *parentRw)
virtual void	elementChanged ()
virtual void	setModelModified (DtModelSetEntry *)
	Called when the model is modified. Default is no-op.
virtual bool	createHierarchy (DtVrfSubObjectParameterList *, QTreeWidgetItem *parent, DtObjectTypeList ancestorList=DtObjectTypeList())
virtual bool	createHierarchy (DtVrfSubObjectParameterEntry *, QTreeWidgetItem *parent, DtObjectTypeList ancestorList=DtObjectTypeList())
virtual DtFormationHierarchyView *	createHierarchy (QWidget *parent) const
	Creates a new aggregate hierarchy list.
virtual QTreeWidgetItem *	addHierarchyItem (const DtObjectType &) const
	Adds a list item to the hierarchy based on the object type.
virtual void	hierarchySelectionChanged ()
	Called when the selection has changed in the hierarchy selection.
virtual void	addToHierarchy ()
	Adds selected element to the hierarchy.
virtual void	replaceInHierarchy ()
	Replaces the currently selected item in the hierarchy with the new one.
virtual void	removeFromHierarchy ()
	Removes the selected element from the hierarchy.
virtual void	editFormation ()
	Brings up a dialog to edit the formation.
virtual void	removeFromHierarchy (DtVrfSubObjectParameterEntry *entry)
	Removes the element referring to the specified entry from the hierarchy.
virtual void	moveUp ()
	Moves the selected item up in the hierarchy.
virtual void	moveDown ()
	Moves the selected item down in the hierarchy.
virtual void	moveInHierarchy (int iFrom, int iTo)
	Moves the item in the hierarchy from position from to position two.
virtual void	resetHierarchyFromList ()
	Recreates hierarchy from list box.
virtual void	editSelectedItem ()
	Changes the interface to edit the item that is currently selected.
virtual void	expandItem (QTreeWidgetItem *)
virtual void	collapseItem (QTreeWidgetItem *)
virtual void	sendEvent (DtUiElementEvent::DtUiElementEventTypes type, QTreeWidgetItem *i)
virtual void	sendEvent (DtUiElementEvent::DtUiElementEventTypes type, const QList< QTreeWidgetItem * > &i)
virtual void	processUiEvent (const DtUiElementEvent &e)
	Process ui event. Default does nothing.
virtual void	updateButtons ()
virtual void	addObjectToHierarchy (const DtObjectType &)
virtual void	replaceObjectInHierarchy (const DtObjectType &)
Protected Member Functions inherited from DtUiElement
virtual QWidget *	createDataEntryElement (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.

Static Protected Member Functions
static void	formationChangedCallback (DtUiElement *, void *usr)

Protected Attributes
QPushButton *	myAddToHierarchy
QPushButton *	myRemoveFromHierarchy
QPushButton *	myReplaceInHierarchy
DtFormationHierarchyView *	myHierarchy
QPushButton *	myEditFormation
QPushButton *	myMoveUp
QPushButton *	myMoveDown
QGroupBox *	myGroupBox
DtUiAggregateCompositionSignalHandler	myAggregateSignalHandler
DtModelSetEntry *	mySelectedModel
DtAddObjectToHierarchy *	myAddToHierarchyDialog
DtObjectType	myObjectType
DtReaderWriter *	myParams
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
DtReaderWriterRegistryData *	myValue
DtReaderWriterRegistryData *	myBackupValue
DtUiElementSignalHandler	mySignalHandler
DtRwBoolean	mySetVisible
bool	myIsNew
QWidget *	myLabel
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.

Friends
class	DtUiAggregateCompositionSignalHandler

Additional Inherited Members
Static Public Member Functions inherited from DtUiElement
static void	registerUiTypes ()
	Factory methods for creating ui elements.
static DtUiElement *	createUiElement (const DtString &type, const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
static DtReaderWriterFactory *	elementFactory ()
Static Protected Attributes inherited from DtUiElement
static DtReaderWriterFactory	theFactory
static DtUnitConverterFactory	theConversionFactory

Member Typedef Documentation

typedef std::list<DtObjectType> DtUiAggregateCompositionEditor::DtObjectTypeList

Constructor & Destructor Documentation

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

Constructor.

virtual DtUiAggregateCompositionEditor::~DtUiAggregateCompositionEditor ( )

virtual

Destructor.

DtUiAggregateCompositionEditor::DtUiAggregateCompositionEditor

(

const DtUiAggregateCompositionEditor &

orig

)

Copy constructor.

Member Function Documentation

DtUiAggregateCompositionEditor& DtUiAggregateCompositionEditor::operator=

(

const DtUiAggregateCompositionEditor &

orig

)

Assignment operator.

virtual QWidget* DtUiAggregateCompositionEditor::createLabelWidget ( QWidget *  parent )

inlinevirtual

Create and return the label widget for this element.

May return NULL if not special label element is needed.

Reimplemented from DtUiElement.

virtual QWidget* DtUiAggregateCompositionEditor::createControls ( QWidget *  parent )

virtual

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

Reimplemented from DtUiElement.

virtual bool DtUiAggregateCompositionEditor::canMoveUp ( ) const

virtual

virtual bool DtUiAggregateCompositionEditor::canMoveDown ( ) const

virtual

virtual bool DtUiAggregateCompositionEditor::isModified ( ) const

protectedvirtual

Reimplemented from DtUiElement.

virtual bool DtUiAggregateCompositionEditor::formationIsModified ( ) const

protectedvirtual

virtual DtUiElement* DtUiAggregateCompositionEditor::clone ( )

protectedvirtual

Implements DtUiElement.

virtual void DtUiAggregateCompositionEditor::decorateElement ( )

protectedvirtual

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

This version changes myLabel font.

Reimplemented from DtUiElement.

virtual void DtUiAggregateCompositionEditor::setFromParameters ( DtReaderWriter *  parentRw )

protectedvirtual

Reimplemented from DtUiElement.

virtual void DtUiAggregateCompositionEditor::elementChanged ( )

protectedvirtual

Reimplemented from DtUiElement.

virtual void DtUiAggregateCompositionEditor::setModelModified ( DtModelSetEntry *  )

protectedvirtual

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

Reimplemented from DtUiElement.

virtual bool DtUiAggregateCompositionEditor::createHierarchy ( DtVrfSubObjectParameterList *  , QTreeWidgetItem *  parent, DtObjectTypeList  ancestorList = DtObjectTypeList()  )

protectedvirtual

Returns

True if successful. False if the new hierarchy is invalid.

virtual bool DtUiAggregateCompositionEditor::createHierarchy ( DtVrfSubObjectParameterEntry *  , QTreeWidgetItem *  parent, DtObjectTypeList  ancestorList = DtObjectTypeList()  )

protectedvirtual

Returns

True if successful. False if the new hierarchy is invalid.

virtual DtFormationHierarchyView* DtUiAggregateCompositionEditor::createHierarchy ( QWidget *  parent ) const

protectedvirtual

Creates a new aggregate hierarchy list.

virtual QTreeWidgetItem* DtUiAggregateCompositionEditor::addHierarchyItem ( const DtObjectType &  ) const

protectedvirtual

Adds a list item to the hierarchy based on the object type.

Will use the currently loaded model set to get name and icon. If no entry exists in the model set, will use the string representation of the object type

virtual void DtUiAggregateCompositionEditor::hierarchySelectionChanged ( )

protectedvirtual

Called when the selection has changed in the hierarchy selection.

virtual void DtUiAggregateCompositionEditor::addToHierarchy ( )

protectedvirtual

Adds selected element to the hierarchy.

If an element is selected in the hierarchy, adds it above the selected element, else appends element to hierarchy

virtual void DtUiAggregateCompositionEditor::replaceInHierarchy ( )

protectedvirtual

Replaces the currently selected item in the hierarchy with the new one.

virtual void DtUiAggregateCompositionEditor::removeFromHierarchy ( )

protectedvirtual

Removes the selected element from the hierarchy.

virtual void DtUiAggregateCompositionEditor::editFormation ( )

protectedvirtual

Brings up a dialog to edit the formation.

virtual void DtUiAggregateCompositionEditor::removeFromHierarchy ( DtVrfSubObjectParameterEntry *  entry )

protectedvirtual

Removes the element referring to the specified entry from the hierarchy.

virtual void DtUiAggregateCompositionEditor::moveUp ( )

protectedvirtual

Moves the selected item up in the hierarchy.

virtual void DtUiAggregateCompositionEditor::moveDown ( )

protectedvirtual

Moves the selected item down in the hierarchy.

virtual void DtUiAggregateCompositionEditor::moveInHierarchy ( int  iFrom, int  iTo  )

protectedvirtual

Moves the item in the hierarchy from position from to position two.

virtual void DtUiAggregateCompositionEditor::resetHierarchyFromList ( )

protectedvirtual

Recreates hierarchy from list box.

virtual void DtUiAggregateCompositionEditor::editSelectedItem ( )

protectedvirtual

Changes the interface to edit the item that is currently selected.

virtual void DtUiAggregateCompositionEditor::expandItem ( QTreeWidgetItem *  )

protectedvirtual

virtual void DtUiAggregateCompositionEditor::collapseItem ( QTreeWidgetItem *  )

protectedvirtual

virtual void DtUiAggregateCompositionEditor::sendEvent ( DtUiElementEvent::DtUiElementEventTypes  type, QTreeWidgetItem *  i  )

protectedvirtual

virtual void DtUiAggregateCompositionEditor::sendEvent ( DtUiElementEvent::DtUiElementEventTypes  type, const QList< QTreeWidgetItem * > &  i  )

protectedvirtual

virtual void DtUiAggregateCompositionEditor::processUiEvent ( const DtUiElementEvent &  )

protectedvirtual

Process ui event. Default does nothing.

Reimplemented from DtUiElement.

virtual void DtUiAggregateCompositionEditor::updateButtons ( )

protectedvirtual

virtual void DtUiAggregateCompositionEditor::addObjectToHierarchy ( const DtObjectType &  )

protectedvirtual

virtual void DtUiAggregateCompositionEditor::replaceObjectInHierarchy ( const DtObjectType &  )

protectedvirtual

static void DtUiAggregateCompositionEditor::formationChangedCallback ( DtUiElement *  , void *  usr  )

staticprotected

Friends And Related Function Documentation

friend class DtUiAggregateCompositionSignalHandler

friend

Member Data Documentation

QPushButton* DtUiAggregateCompositionEditor::myAddToHierarchy

protected

QPushButton* DtUiAggregateCompositionEditor::myRemoveFromHierarchy

protected

QPushButton* DtUiAggregateCompositionEditor::myReplaceInHierarchy

protected

DtFormationHierarchyView* DtUiAggregateCompositionEditor::myHierarchy

protected

QPushButton* DtUiAggregateCompositionEditor::myEditFormation

protected

QPushButton* DtUiAggregateCompositionEditor::myMoveUp

protected

QPushButton* DtUiAggregateCompositionEditor::myMoveDown

protected

QGroupBox* DtUiAggregateCompositionEditor::myGroupBox

protected

DtUiAggregateCompositionSignalHandler DtUiAggregateCompositionEditor::myAggregateSignalHandler

protected

DtModelSetEntry* DtUiAggregateCompositionEditor::mySelectedModel

protected

DtAddObjectToHierarchy* DtUiAggregateCompositionEditor::myAddToHierarchyDialog

protected

DtObjectType DtUiAggregateCompositionEditor::myObjectType

protected

DtReaderWriter* DtUiAggregateCompositionEditor::myParams

protected

---

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

• include/entityEditorImpl/uiAggregateCompositionEditor.h