VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtUiUniqueNameElement Class Reference

Element for managing a Unique Name variable. More...

Inheritance diagram for DtUiUniqueNameElement:
Inheritance graph
[legend]

Public Member Functions

 DtUiUniqueNameElement (makVrv::DtDe &)
 Constructor. More...
 
virtual ~DtUiUniqueNameElement ()
 Destructor. More...
 
virtual DtString uniqueNameCategory () const
 
virtual void setUniqueNameCategory (const DtString &cat)
 
virtual DtString uniqueIdentifyingName () const
 
virtual void setUniqueIdentifyingName (const DtString &num)
 
virtual bool uniqueNameConflicted () const
 
virtual void setUniqueNameConflicted (bool confl)
 
virtual void setFromSystemParameterData (const DtSystemParameterData *data, const DtComponentSystemDefinition *)
 Sets data of this UiElement from the specified system parameter data. More...
 
virtual void aboutToShow ()
 Called when about to show as part of a properties dialog. More...
 
- Public Member Functions inherited from DtUiElement
 DtUiElement (makVrv::DtDe &)
 Constructor. More...
 
virtual ~DtUiElement ()
 Destructor. More...
 
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 objectParametersModified ()
 This method is called any time that any of the parameters for the object are modified. More...
 
virtual void connectedTo (QObject *)
 Called when this item is connected to any signal emitted by the given item. More...
 
virtual void processUiEvent (const DtUiElementEvent &)
 Process ui event. Default does nothing. More...
 
virtual void setModelModified (DtModelSetEntry *)
 Called when the model is modified. Default is no-op. More...
 
virtual DtString uniqueName () const
 Returns a unique name for this element. More...
 
virtual bool supportsSystems () const
 Returns true if this element supports systems. More...
 
virtual const DtStringplatformType () const
 Returns the type of platform this entity represents. More...
 
virtual void setPlatformType (const DtString &)
 Sets the type of platform for this entity. More...
 
virtual void setObjectTypes (const std::vector< DtObjectType > &)
 Sets the object type this element represents. More...
 
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. More...
 
virtual void decorateElement ()
 Sets element decoration depending on the isModified state of the element. More...
 
virtual void setFromParameters (DtReaderWriter *parentRw)
 Calls setFromParameters with std::vector of parameter. More...
 
virtual void setFromParameters (const std::vector< DtComponentSystemDefinition * > &)
 For those UI elements that work with system definitions this method will be implemented. More...
 
virtual bool restoreFromBackup ()
 Restores this element from a backup created with the specified name. More...
 
QHBoxLayout * findLayoutThatHas (QWidget *w, QBoxLayout *layout)
 iterates through the items in layout to find w. Also checks sub-layouts More...
 
QBoxLayout * findUsableLayoutFor (QWidget *w)
 Returns the existing HBoxLayout owned by w. More...
 
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. More...
 
virtual void setEnabled (bool)
 If this item is not enabled it cannot be modified. More...
 
virtual bool enabled () const
 
virtual void setControllingCheckBox (QCheckBox *)
 
QCheckBoxcontrollingCheckBox ()
 
virtual void populateParentValues (std::string elementName)
 caches the data from the parent file into myParentValues in case the user reverts it More...
 

Static Public Member Functions

static DtUiElementCreatorFunction (makVrv::DtDe &)
 
static DtUniqueNameManageruniqueNameManager ()
 
- Static Public Member Functions inherited from DtUiElement
static void registerUiTypes ()
 Factory methods for creating ui elements. More...
 
static DtUiElementcreateUiElement (makVrv::DtDe &, const DtString &type)
 
static bool hasCreator (const DtString &)
 
static void theNullFunction (DtUiElement *)
 
static UiElementFactoryMapelementFactory ()
 
static QString mixedText ()
 
static void setMixedText (const QString &)
 

Protected Slots

virtual void elementChanged ()
 
virtual void processEditFinished ()
 
- Protected Slots inherited from DtUiElement
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. More...
 
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. More...
 

Protected Member Functions

virtual void createControls (QWidget *)
 If additional widgets or connections need to be made do it here. The parent is the myWidget member. More...
 
virtual void setWidgetValue (const QString &val)
 
virtual void setWidgetConflicted (bool conflicted)
 
virtual void setFromParameters (const std::vector< DtReaderWriter * > &parentRw)
 
- Protected Member Functions inherited from DtUiElement
virtual double sourceToDisplayUnits (double) const
 
virtual double displayToSourceUnits (double) const
 
virtual QString units () const
 
virtual void updateLabelTitle ()
 Updates label title based on valid units. More...
 
virtual QString labelTitle () const
 Returns the unmodified label title. More...
 

Protected Attributes

DtString myUniqueNameCategory
 
bool myUniqueNameNumConflicted
 
DtString mySystemName
 
std::vector< DtStringmyOrigUniqueNames
 
const DtSystemParameterDatamyLastParamData
 
const DtComponentSystemDefinitionmyLastDef
 
bool myAddedToManager
 
- Protected Attributes inherited from DtUiElement
DtString myDisplayUnits
 
DtString mySourceUnits
 
std::vector< DtReaderWriter * > myValues
 Assumes 1 - 1 order that original and backup are same index in lists. More...
 
std::vector< DtReaderWriter * > myBackupValues
 
DtReaderWritermyParentValue
 
bool myIsNew
 
DtElementChangedCallbackFcn myElementChangedCallbackFunction
 
DtUnit mySource
 
DtUnit myDestination
 
makVrv::DtDemyDe
 
DtString myPlatformType
 
std::vector< DtObjectTypemyObjectTypes
 
std::vector
< DtComponentSystemDefinition * > 
mySystems
 
const DtComponentSystemDefinitionmySystemDefinition
 
bool myEnabled
 
std::vector< QObject * > myConnectedTo
 
int myUniqueId
 
QCheckBoxmyControllingCheckBox
 
QPushButtonmyRevertToParentButton
 

Static Protected Attributes

static DtUniqueNameManagertheUniqueNameManager
 
static const int theMixedVal
 
- Static Protected Attributes inherited from DtUiElement
static UiElementFactoryMap theFactory
 

Additional Inherited Members

- Public Types inherited from DtUiElement
typedef boost::function
< DtUiElement *(makVrv::DtDe &)> 
CreatorFunction
 
typedef std::map< std::string,
CreatorFunction
UiElementFactoryMap
 
- Public Slots inherited from DtUiElement
virtual void toggleDisplayed (bool display)
 
- Signals inherited from DtUiElement
void uiEvent (const DtUiElementEvent &)
 
void changed ()
 
- Public Attributes inherited from DtUiElement
QWidget * myWidget
 
QWidget * myLabel
 

Detailed Description

Element for managing a Unique Name variable.

It hooks to the DtUniqueNameManager to auto-assign a unique name to avoid conflicts with other names in the same category.

Constructor & Destructor Documentation

DtUiUniqueNameElement::DtUiUniqueNameElement ( makVrv::DtDe )

Constructor.

virtual DtUiUniqueNameElement::~DtUiUniqueNameElement ( )
virtual

Destructor.

Member Function Documentation

virtual DtString DtUiUniqueNameElement::uniqueNameCategory ( ) const
virtual
virtual void DtUiUniqueNameElement::setUniqueNameCategory ( const DtString cat)
virtual
virtual DtString DtUiUniqueNameElement::uniqueIdentifyingName ( ) const
virtual
virtual void DtUiUniqueNameElement::setUniqueIdentifyingName ( const DtString num)
virtual
virtual bool DtUiUniqueNameElement::uniqueNameConflicted ( ) const
virtual
virtual void DtUiUniqueNameElement::setUniqueNameConflicted ( bool  confl)
virtual
virtual void DtUiUniqueNameElement::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 from DtUiElement.

virtual void DtUiUniqueNameElement::aboutToShow ( )
virtual

Called when about to show as part of a properties dialog.

Reimplemented from DtUiElement.

static DtUniqueNameManager* DtUiUniqueNameElement::uniqueNameManager ( )
static
virtual void DtUiUniqueNameElement::createControls ( QWidget *  parent)
protectedvirtual

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

Reimplemented from DtUiElement.

virtual void DtUiUniqueNameElement::setWidgetValue ( const QString &  val)
protectedvirtual
virtual void DtUiUniqueNameElement::setWidgetConflicted ( bool  conflicted)
protectedvirtual
virtual void DtUiUniqueNameElement::elementChanged ( )
protectedvirtualslot
virtual void DtUiUniqueNameElement::processEditFinished ( )
protectedvirtualslot
virtual void DtUiUniqueNameElement::setFromParameters ( const std::vector< DtReaderWriter * > &  parentRw)
protectedvirtual

Reimplemented from DtUiElement.

Member Data Documentation

DtString DtUiUniqueNameElement::myUniqueNameCategory
protected
bool DtUiUniqueNameElement::myUniqueNameNumConflicted
protected
DtString DtUiUniqueNameElement::mySystemName
protected
std::vector<DtString> DtUiUniqueNameElement::myOrigUniqueNames
protected
const DtSystemParameterData* DtUiUniqueNameElement::myLastParamData
protected
const DtComponentSystemDefinition* DtUiUniqueNameElement::myLastDef
protected
bool DtUiUniqueNameElement::myAddedToManager
protected
DtUniqueNameManager* DtUiUniqueNameElement::theUniqueNameManager
staticprotected
const int DtUiUniqueNameElement::theMixedVal
staticprotected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)