VR-Forces 4.7 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 | Public Attributes | Protected Member Functions | Protected Attributes
makVrf::DtEmbeddedEntitySelectionWidget Class Reference

Selection widget for Embedded Entities. More...

Inheritance diagram for makVrf::DtEmbeddedEntitySelectionWidget:
Inheritance graph
[legend]

Public Member Functions

 DtEmbeddedEntitySelectionWidget (makVrv::DtDe &de, QWidget *parent, const Qt::WindowFlags &flags=0, const CreationFlags &cflags=NormalMode)
virtual ~DtEmbeddedEntitySelectionWidget ()
virtual void setLabel (const QString &text)
 Display label.
virtual QString label () const
virtual void setRange (double bottom, double top)
 Validation range. Not applicable here.
virtual void setDefaultValue (const std::string &def)
 Default value to set in control. Selects the combobox entry corresponding to the given default.
virtual void setupFrom (const std::vector< makVrv::DtSimEntry * > &simEntry)
 Sets up widget with currently selected item by setting myHostObjectType and calling populateEeListCombo() directly if cached data is available.
virtual DtReaderWritercreateBoundVariable (const std::string &variableName)
 Creates the reader/writer variable that will be used as part of the task statement.
virtual void setupFromBoundVariable (const DtReaderWriter *variable)
 Sets up the widget from the given reader/writer variables.
- Public Member Functions inherited from makVrf::DtTaskSetVariableWidget
 DtTaskSetVariableWidget (makVrv::DtDe &de, QWidget *parent, const Qt::WindowFlags &flags=0, const CreationFlags &cflags=NormalMode)
virtual ~DtTaskSetVariableWidget ()
virtual void setToolTip (const QString &)
 Sets the tool tip.
virtual void setLabel (const std::string &)
 Display label.
virtual void setVariableData (const std::string &)
 Calls QString version.
virtual void setVariableData (const QString &)
 QString version calls std::string version.
virtual QString variableData () const
virtual void setIsInternal (bool)
 Whether or not value is internal. Internal values will not be shown to the user on the scripted task dialog.
virtual bool isInternal () const
virtual void setTopLineVisible (bool)
 Hides top line.
virtual bool topLineVisible () const
virtual void createTopLine ()
 Creates top line.
virtual void setIndent (int)
 Sets the indent level for the contents of this widget, except for the title line.
virtual int indent () const
virtual bool isValid () const
 Indicates the current selection is valid.
virtual void setTopLabelChecked (bool)
 Sets the top label to be checked/unchecked and calls topLabelChecked if the check box is visible.
virtual bool topLabelChecked () const
virtual void setRange (const DtRange &)
virtual void setRangeTop (double)
virtual void setRangeTop (int)
virtual double rangeTop () const
virtual void setRangeBottom (double)
virtual void setRangeBottom (int)
virtual double rangeBottom () const
virtual const DtRangegetRange () const
virtual void setTopLabelIsCheckable (bool)
 Sets whether or not the top label is checkable.
virtual bool topLabelIsCheckable () const
virtual void getDefaultSpecificTitles (QString &defaultTitle, QString &specificTitle) const
virtual void setDefaultSpecificTitles (const QString &defaultTitle, const QString &specificTitle)
virtual void setupDefaultSpecificFromVariableData (const DtString &var)
 Format is allowdefault=[defaultTitle],[specificTitle].
virtual std::string variableDataFromUiDesigner (const QDomElement &, const DtScriptedTaskVariableLayoutConverter &) const
 Given the Ui designer properties create a string that will represent the variable data for those properties.
virtual std::string scriptedTaskVariableName () const
 In most cases this is the objectName of the object, however, in some cases (as in radio button) this could be a name that is shared amongst like objects, so, that is returned instead.
- Public Member Functions inherited from makVrf::DtTaskSetVariableWidgetInterface
 DtTaskSetVariableWidgetInterface ()
virtual ~DtTaskSetVariableWidgetInterface ()
virtual void widgetInitializedForDialog (DtScriptedTaskDialog *)
 Called when the widget is initialized from a scripted task dialog. Default implementation is to do nothing.
virtual
DtTaskSetVariableWidgetExtensionInterface
parameterContents (QWidget *parent, const Qt::WindowFlags &flags=0) const
 If there are any, returns contents for this variable for variable extension. Default is no extension.
virtual bool guiElementOnly () const
 Returns true if this is a GUI element only. Default is false.

Static Public Member Functions

static makVrv::DtUnicode codeVariableType ()
static std::string designerGroup ()
static std::string headerFile ()
static std::string variableName ()
- Static Public Member Functions inherited from makVrf::DtTaskSetVariableWidget
static bool includeInQtDesigner ()
- Static Public Member Functions inherited from makVrf::DtTaskSetVariableWidgetInterface
static bool canBeUsedAsWidget ()
 Whether or not this shows up as a usable variable widget.
static void initializeForQtDesignerExtension (makVrv::DtDe &de, QDesignerFormEditorInterface *core)
 Implement at class level to perform Qt Designer custom widget initialization. Please refer to Qt documentation for designer modifications.

Public Attributes

QHBoxLayout * myLayout
QLabelmyLabel
QComboBoxmyEmbeddedEntitiesCombo
QString myDefaultValue
- Public Attributes inherited from makVrf::DtTaskSetVariableWidget
boost::signal< void(bool)> signal_topLevelCheckStateChanged
int myIndent
QVBoxLayout * myVariableWidgetLayout
QHBoxLayout * mySpacedLayout
QVBoxLayout * myVariableContentLayout
 When creating subclasses of this item, use the variable content layout to add your content.
QWidget * myTopLine
QLabelmyTopLabel
QWidget * myChoiceCanvas
QRadioButton * myUseDefault
QRadioButton * myUseSpecific
QSpacerItem * myTopSeparator
QHBoxLayout * myTopLineLayout
QSpacerItem * mySpacerItem

Protected Member Functions

virtual void populateEeListCombo ()
 Populates the selection combo box using cached data in the DtEmbeddedEntitiesListRequestor singleton.
virtual void slot_onInfoCacheUpdated (const DtObjectType &updatedType)
 Disconnects itself from the requestor's signal and calls populateEeListCombo()

Protected Attributes

DtObjectType myHostObjectType
 Type of the object that was in context when this dialog was created.
- Protected Attributes inherited from makVrf::DtTaskSetVariableWidget
makVrv::DtDemyDe
makVrv::DtSignalConnectionManager myConnections
bool myTopLabelIsCheckable
DtRange myRange
bool myIsInternal
CreationFlags myCreationFlags
QString myVariableData

Additional Inherited Members

- Public Types inherited from makVrf::DtTaskSetVariableWidgetInterface
enum  CreationFlags { NormalMode = 0x00000000, QtDesignerMode = 0x00000001 }
- Signals inherited from makVrf::DtTaskSetVariableWidget
void validityUpdated ()
 Signal which can be emitted to indicate the validity of the current widget selection has changed.
- Protected Slots inherited from makVrf::DtTaskSetVariableWidget
virtual void topLabelCheckStateChanged ()
- Properties inherited from makVrf::DtTaskSetVariableWidget
QString label
bool isInternal
int indent
QString variableData

Detailed Description

Selection widget for Embedded Entities.

Serves the Embedded Entity type for auto-generated task dialogs. Will automatically issue data a cache update for the object type in context for the task and populate the selection box with the names of the available embedded entities.

Constructor & Destructor Documentation

makVrf::DtEmbeddedEntitySelectionWidget::DtEmbeddedEntitySelectionWidget ( makVrv::DtDe de,
QWidget *  parent,
const Qt::WindowFlags &  flags = 0,
const CreationFlags cflags = NormalMode 
)
virtual makVrf::DtEmbeddedEntitySelectionWidget::~DtEmbeddedEntitySelectionWidget ( )
virtual

Member Function Documentation

virtual void makVrf::DtEmbeddedEntitySelectionWidget::setLabel ( const QString &  text)
virtual

Display label.

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual QString makVrf::DtEmbeddedEntitySelectionWidget::label ( ) const
virtual

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual void makVrf::DtEmbeddedEntitySelectionWidget::setRange ( double  bottom,
double  top 
)
virtual

Validation range. Not applicable here.

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual void makVrf::DtEmbeddedEntitySelectionWidget::setDefaultValue ( const std::string &  def)
virtual

Default value to set in control. Selects the combobox entry corresponding to the given default.

Implements makVrf::DtTaskSetVariableWidgetInterface.

virtual void makVrf::DtEmbeddedEntitySelectionWidget::setupFrom ( const std::vector< makVrv::DtSimEntry * > &  simEntry)
virtual

Sets up widget with currently selected item by setting myHostObjectType and calling populateEeListCombo() directly if cached data is available.

Otherwise hooks slot_onInfoCacheUpdated() to the requestor's update recieved signal and requests an update from the backend.

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual DtReaderWriter* makVrf::DtEmbeddedEntitySelectionWidget::createBoundVariable ( const std::string &  variableName)
virtual

Creates the reader/writer variable that will be used as part of the task statement.

Implements makVrf::DtTaskSetVariableWidgetInterface.

virtual void makVrf::DtEmbeddedEntitySelectionWidget::setupFromBoundVariable ( const DtReaderWriter variable)
virtual

Sets up the widget from the given reader/writer variables.

Implements makVrf::DtTaskSetVariableWidgetInterface.

static makVrv::DtUnicode makVrf::DtEmbeddedEntitySelectionWidget::codeVariableType ( )
inlinestatic
static std::string makVrf::DtEmbeddedEntitySelectionWidget::designerGroup ( )
inlinestatic
static std::string makVrf::DtEmbeddedEntitySelectionWidget::headerFile ( )
inlinestatic
static std::string makVrf::DtEmbeddedEntitySelectionWidget::variableName ( )
inlinestatic
virtual void makVrf::DtEmbeddedEntitySelectionWidget::populateEeListCombo ( )
protectedvirtual

Populates the selection combo box using cached data in the DtEmbeddedEntitiesListRequestor singleton.

virtual void makVrf::DtEmbeddedEntitySelectionWidget::slot_onInfoCacheUpdated ( const DtObjectType updatedType)
protectedvirtual

Disconnects itself from the requestor's signal and calls populateEeListCombo()

Member Data Documentation

DtObjectType makVrf::DtEmbeddedEntitySelectionWidget::myHostObjectType
protected

Type of the object that was in context when this dialog was created.

QHBoxLayout* makVrf::DtEmbeddedEntitySelectionWidget::myLayout
QLabel* makVrf::DtEmbeddedEntitySelectionWidget::myLabel
QComboBox* makVrf::DtEmbeddedEntitySelectionWidget::myEmbeddedEntitiesCombo
QString makVrf::DtEmbeddedEntitySelectionWidget::myDefaultValue

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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)