VR-Forces 5.0.2 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes
makVrv::DtDisplayUnitsSettingsInterface Class Referenceabstract

Interface for the settings widget to communicate with its logic.

Inheritance diagram for makVrv::DtDisplayUnitsSettingsInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtDisplayUnitsSettingsInterface ()
 
virtual void addDisplayUnitToUI (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType type)=0
 
virtual void updateDisplayUnitUnit (const std::string &displayUnitCollectionName, const std::string &displayUnitName, unsigned int unitEnumValue)=0
 
virtual void updateDisplayUnitDecimals (const std::string &displayUnitCollectionName, const std::string &displayUnitName, unsigned int decimals)=0
 
virtual void updateDisplayUnitName (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, const DtUnicode &newDisplayName)=0
 
virtual void setDisplayUnitDecimalsQSpinBoxVisible (const std::string &displayUnitCollectionName, const std::string &displayUnitName, bool isVisible)=0
 
virtual void addSuppressMagneticNorthNotationCheckBox ()=0
 
virtual void setSuppressMagneticNorthNotationEnabled (bool enabled)=0
 
virtual void addObjectTypeToUI (const DtUnicode &objectType)=0
 
virtual std::string currentObjectType () const =0
 
virtual void populateDisplayUnitComboBoxes (makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType displayUnitType, const DtUnicode &name, unsigned int unitEnumValue)=0
 
virtual void removeUnitOfMeasurementEntryByDisplayUnit (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, const DtUnicode &unitOfMeasurementName)=0
 
virtual void clear ()=0
 

Public Attributes

boost::signalslib::signal< void()> signal_currentObjectTypeChanged
 
boost::signalslib::signal
< void(const std::string
&displayUnitCollectionName,
const std::string
&displayUnitName, unsigned int
unitEnumValue)> 
signal_displayUnitUnitChanged
 
boost::signalslib::signal
< void(const std::string
&displayUnitCollectionName,
const std::string
&displayUnitName, unsigned int
decimals)> 
signal_displayUnitDecimalsChanged
 
boost::signalslib::signal
< void(bool
suppressMagNorthNotation)> 
signal_suppressMagneticNorthNotationChanged
 

Constructor & Destructor Documentation

virtual makVrv::DtDisplayUnitsSettingsInterface::~DtDisplayUnitsSettingsInterface ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtDisplayUnitsSettingsInterface::addDisplayUnitToUI ( const DtUnicode displayUnitCollectionName,
const DtUnicode displayUnitName,
makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType  type 
)
pure virtual

Add a display unit to the interface.

Parameters
displayUnitCollectionNameThe name of the collection the display unit is in.
displayUnitNameThe name of the display unit of interest.
typeThe display unit type this display unit measures.

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::updateDisplayUnitUnit ( const std::string &  displayUnitCollectionName,
const std::string &  displayUnitName,
unsigned int  unitEnumValue 
)
pure virtual

Update the interface to reflect the new unit of measurement a display unit uses.

Parameters
displayUnitCollectionNameThe name of the collection the display unit is in.
displayUnitNameThe name of the display unit of interest.
unitEnumValueThe enumeration value of the specific unit of measurement to use.

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::updateDisplayUnitDecimals ( const std::string &  displayUnitCollectionName,
const std::string &  displayUnitName,
unsigned int  decimals 
)
pure virtual

Update the interface to reflect the new number of decimals a display unit uses.

Parameters
displayUnitCollectionNameThe name of the collection the display unit is in.
displayUnitNameThe name of the display unit of interest.
decimalsThe number of decimals the display unit now uses.

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::updateDisplayUnitName ( const DtUnicode displayUnitCollectionName,
const DtUnicode displayUnitName,
const DtUnicode newDisplayName 
)
pure virtual

Update the name of a display unit in the UI.

Parameters
displayUnitCollectionNameThe name of the collection the display unit is in.
displayUnitNameThe name of the display unit of interest.
newDisplayNameThe name of the display unit as shown in the GUI

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::setDisplayUnitDecimalsQSpinBoxVisible ( const std::string &  displayUnitCollectionName,
const std::string &  displayUnitName,
bool  isVisible 
)
pure virtual

Update the visibility of a QSpinBox associated with a display unit.

Parameters
displayUnitCollectionNameThe name of the collection the display unit is in.
displayUnitNameThe name of the display unit of interest.
newDisplayNameThe name of the display unit as shown in the GUI

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::addSuppressMagneticNorthNotationCheckBox ( )
pure virtual

Add a checkbox that toggles the suppression of magnetic north notation to the GUI.

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::setSuppressMagneticNorthNotationEnabled ( bool  enabled)
pure virtual

Set the state of the QCheckBox for suppressing magnetic north notation.

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::addObjectTypeToUI ( const DtUnicode objectType)
pure virtual

Add an object type to the interface.

Parameters
objectTypeThe string representation for the object type

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual std::string makVrv::DtDisplayUnitsSettingsInterface::currentObjectType ( ) const
pure virtual

Get the currently selected object type.

Returns
The string representation for the object type

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::populateDisplayUnitComboBoxes ( makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType  displayUnitType,
const DtUnicode name,
unsigned int  unitEnumValue 
)
pure virtual

Populate the appropriate unit of measurement combo boxes. This function populates the dropdown boxes of all display units that measure the specified display unit type with the unit of measurement information that is passed in.

Parameters
displayUnitTypeThe unsigned integer value that corresponds to a physical quantity, in the DisplayUnitType enumeration, the display unit is measuring.
nameThe name of the unit of measurement.
unitEnumValueThe enumeration value corresponding to the unit of measurement being added.

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::removeUnitOfMeasurementEntryByDisplayUnit ( const DtUnicode displayUnitCollectionName,
const DtUnicode displayUnitName,
const DtUnicode unitOfMeasurementName 
)
pure virtual

Removes a particular unit of measurement entry from a display unit.

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

virtual void makVrv::DtDisplayUnitsSettingsInterface::clear ( )
pure virtual

Removes all the display units and unit of measurements from the GUI.

Implemented in makVrv::DtDisplayUnitsSettingsWidget.

Member Data Documentation

boost::signalslib::signal<void ( )> makVrv::DtDisplayUnitsSettingsInterface::signal_currentObjectTypeChanged

Used to signal the logic class when the currently selected object type, e.g. Fixed Wing, has changed in the GUI.

boost::signalslib::signal<void ( const std::string& displayUnitCollectionName, const std::string& displayUnitName, unsigned int unitEnumValue )> makVrv::DtDisplayUnitsSettingsInterface::signal_displayUnitUnitChanged

Used to signal the logic class when the unit of measurement to use for a display unit has changed in the GUI.

boost::signalslib::signal<void ( const std::string& displayUnitCollectionName, const std::string& displayUnitName, unsigned int decimals )> makVrv::DtDisplayUnitsSettingsInterface::signal_displayUnitDecimalsChanged

Used to signal the logic class when the number of decimal places to use for a display unit has changed in the GUI.

boost::signalslib::signal<void ( bool suppressMagNorthNotation )> makVrv::DtDisplayUnitsSettingsInterface::signal_suppressMagneticNorthNotationChanged

Used to signal the logic class when the checkbox indicating whether or not to suppress magnetic north notation has changed in the GUI.


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

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)