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::DtResourceSelectionEntryWidget Class Reference

Widget that allows users to select resources for the given entity. More...

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

Public Member Functions

 DtResourceSelectionEntryWidget (makVrv::DtDe &de, QWidget *parent, const Qt::WindowFlags &flags=0, const CreationFlags &cflags=NormalMode)
virtual ~DtResourceSelectionEntryWidget ()
virtual void setLabel (const QString &)
 Display label.
virtual QString label () const
virtual void setRange (double bottom, double top)
 Validation range. Not applicable.
virtual void setDefaultValue (const std::string &)
 Default value to set in control. Will contain initial resource to select.
virtual void setVariableData (const QString &)
 Variable data. Used to determine allowable variable types.
virtual void setupFrom (const std::vector< makVrv::DtSimEntry * > &data)
 Sets up widget with currently selected item. Requests data.
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 *variableName)
 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 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 bool guiElementOnly () const
 Returns true if this is a GUI element only. Default is false.
- Public Member Functions inherited from makVrf::DtVrfResourceRequestor
 DtVrfResourceRequestor (makVrv::DtDe &)
virtual ~DtVrfResourceRequestor ()
virtual void requestResourcesFor (const std::vector< makVrv::DtSimEntry * > &data, bool entitiesOnly=true)
 Requests resources for all items in the vector.
virtual void startMonitoring (const DtUUID &, int rate=-1)
 Start monitoring for this entity.
virtual void stopMonitoring (const DtUUID &)
 Stop monitoring for the specified entity.
virtual void setUpdateRate (const DtUUID &entity, int)
 Sets the update rate for entity being monitored.

Static Public Member Functions

static makVrv::DtUnicode codeVariableType ()
static std::string designerGroup ()
static std::string headerFile ()
static std::string variableName ()
static void initializeForQtDesignerExtension (makVrv::DtDe &, QDesignerFormEditorInterface *)
 Add custom menu item to task menu to be able to edit the entity type created by this object.
- 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.

Public Attributes

QLabelmyResourceLabel
QComboBoxmyResources
QHBoxLayout * myContentLayout
- 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 bool shouldAddResource (const DtResource &) const
 Looks at variable data for: "resourcetypes=<resourcetype>;<...>" "entitytypes=<entitytype>;<...>" Can only be resourcetypes OR entity types.
virtual bool isResourceType (const DtResource &, const std::string &validResources) const
virtual bool isEntityType (const DtResource &, const std::string &validEntityTypes) const
virtual void addResource (const DtResource &)
 Called to add a new resource.
virtual void resourceUpdated (const DtResource &)
 Called when a particular resource has been updated.
virtual void resourcesChanged ()
 Virtual overrides to complete class.
virtual void resourceCheckingDisabled ()
 Called when this item can not longer set resources.
virtual void resourceCheckComplete ()
 Called when resource checking is complete.
virtual
DtTaskSetVariableWidgetExtensionInterface
parameterContents (QWidget *parent, const Qt::WindowFlags &flags) const
 If there are any, returns contents for this variable for variable extension. Default is no extension.
- Protected Member Functions inherited from makVrf::DtVrfResourceRequestor
virtual void slot_resourceResponse (const DtIfServerRequestResponse &)

Protected Attributes

QString myDefaultValue
makVrv::DtDemyDe
- Protected Attributes inherited from makVrf::DtTaskSetVariableWidget
makVrv::DtDemyDe
makVrv::DtSignalConnectionManager myConnections
bool myTopLabelIsCheckable
DtRange myRange
bool myIsInternal
CreationFlags myCreationFlags
QString myVariableData
- Protected Attributes inherited from makVrf::DtVrfResourceRequestor
makVrv::DtDemyDe
std::set< DtUUIDmyResourceRequests
bool myCanSetResources
DtEntityResourceList myResources
makVrv::DtSignalConnectionManager myConnectionManager

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

Widget that allows users to select resources for the given entity.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual void makVrf::DtResourceSelectionEntryWidget::setLabel ( const QString &  )
virtual

Display label.

Reimplemented from makVrf::DtTaskSetVariableWidget.

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

Reimplemented from makVrf::DtTaskSetVariableWidget.

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

Validation range. Not applicable.

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual void makVrf::DtResourceSelectionEntryWidget::setDefaultValue ( const std::string &  )
virtual

Default value to set in control. Will contain initial resource to select.

Implements makVrf::DtTaskSetVariableWidgetInterface.

virtual void makVrf::DtResourceSelectionEntryWidget::setVariableData ( const QString &  )
virtual
virtual void makVrf::DtResourceSelectionEntryWidget::setupFrom ( const std::vector< makVrv::DtSimEntry * > &  data)
virtual

Sets up widget with currently selected item. Requests data.

Reimplemented from makVrf::DtTaskSetVariableWidget.

virtual DtReaderWriter* makVrf::DtResourceSelectionEntryWidget::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::DtResourceSelectionEntryWidget::setupFromBoundVariable ( const DtReaderWriter variableName)
virtual

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

Implements makVrf::DtTaskSetVariableWidgetInterface.

static makVrv::DtUnicode makVrf::DtResourceSelectionEntryWidget::codeVariableType ( )
inlinestatic
static std::string makVrf::DtResourceSelectionEntryWidget::designerGroup ( )
inlinestatic
static std::string makVrf::DtResourceSelectionEntryWidget::headerFile ( )
inlinestatic
static std::string makVrf::DtResourceSelectionEntryWidget::variableName ( )
inlinestatic
static void makVrf::DtResourceSelectionEntryWidget::initializeForQtDesignerExtension ( makVrv::DtDe ,
QDesignerFormEditorInterface *   
)
static

Add custom menu item to task menu to be able to edit the entity type created by this object.

Reimplemented from makVrf::DtTaskSetVariableWidgetInterface.

virtual bool makVrf::DtResourceSelectionEntryWidget::shouldAddResource ( const DtResource ) const
protectedvirtual

Looks at variable data for: "resourcetypes=<resourcetype>;<...>" "entitytypes=<entitytype>;<...>" Can only be resourcetypes OR entity types.

Not both

virtual bool makVrf::DtResourceSelectionEntryWidget::isResourceType ( const DtResource ,
const std::string &  validResources 
) const
protectedvirtual
virtual bool makVrf::DtResourceSelectionEntryWidget::isEntityType ( const DtResource ,
const std::string &  validEntityTypes 
) const
protectedvirtual
virtual void makVrf::DtResourceSelectionEntryWidget::addResource ( const DtResource )
protectedvirtual

Called to add a new resource.

Implements makVrf::DtVrfResourceRequestor.

virtual void makVrf::DtResourceSelectionEntryWidget::resourceUpdated ( const DtResource )
protectedvirtual

Called when a particular resource has been updated.

Implements makVrf::DtVrfResourceRequestor.

virtual void makVrf::DtResourceSelectionEntryWidget::resourcesChanged ( )
protectedvirtual

Virtual overrides to complete class.

Called when resources received has changed

Implements makVrf::DtVrfResourceRequestor.

virtual void makVrf::DtResourceSelectionEntryWidget::resourceCheckingDisabled ( )
protectedvirtual

Called when this item can not longer set resources.

This will happen when multiple requests are made through this class and there are no common resources

Implements makVrf::DtVrfResourceRequestor.

virtual void makVrf::DtResourceSelectionEntryWidget::resourceCheckComplete ( )
protectedvirtual

Called when resource checking is complete.

Implements makVrf::DtVrfResourceRequestor.

virtual DtTaskSetVariableWidgetExtensionInterface* makVrf::DtResourceSelectionEntryWidget::parameterContents ( QWidget *  parent,
const Qt::WindowFlags &  flags 
) const
protectedvirtual

If there are any, returns contents for this variable for variable extension. Default is no extension.

Reimplemented from makVrf::DtTaskSetVariableWidgetInterface.

Member Data Documentation

QLabel* makVrf::DtResourceSelectionEntryWidget::myResourceLabel
QComboBox* makVrf::DtResourceSelectionEntryWidget::myResources
QHBoxLayout* makVrf::DtResourceSelectionEntryWidget::myContentLayout
QString makVrf::DtResourceSelectionEntryWidget::myDefaultValue
protected
makVrv::DtDe& makVrf::DtResourceSelectionEntryWidget::myDe
protected

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)