Interface for the settings widget to communicate with its logic. More...

Inheritance diagram for makVrv::DtDisplayUnitsSettingsInterface:

Public Member Functions
virtual	~DtDisplayUnitsSettingsInterface ()
	DTOR. More...

virtual void	addDisplayUnitToUI (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType type)=0
	Add a display unit to the interface. More...

virtual void	updateDisplayUnitUnit (const std::string &displayUnitCollectionName, const std::string &displayUnitName, unsigned int unitEnumValue)=0
	Update the interface to reflect the new unit of measurement a display unit uses. More...

virtual void	updateDisplayUnitDecimals (const std::string &displayUnitCollectionName, const std::string &displayUnitName, unsigned int decimals)=0
	Update the interface to reflect the new number of decimals a display unit uses. More...

virtual void	updateDisplayUnitName (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, const DtUnicode &newDisplayName)=0
	Update the name of a display unit in the UI. More...

virtual void	setDisplayUnitDecimalsQSpinBoxVisible (const std::string &displayUnitCollectionName, const std::string &displayUnitName, bool isVisible)=0
	Update the visibility of a QSpinBox associated with a display unit. More...

virtual void	addSuppressMagneticNorthNotationCheckBox ()=0
	Add a checkbox that toggles the suppression of magnetic north notation to the GUI. More...

virtual void	setSuppressMagneticNorthNotationEnabled (bool enabled)=0
	Set the state of the QCheckBox for suppressing magnetic north notation. More...

virtual void	addObjectTypeToUI (const DtUnicode &objectType)=0
	Add an object type to the interface. More...

virtual std::string	currentObjectType () const =0
	Get the currently selected object type. More...

virtual void	populateDisplayUnitComboBoxes (makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType displayUnitType, const DtUnicode &name, unsigned int unitEnumValue)=0
	Populate the appropriate unit of measurement combo boxes. More...

virtual void	clear ()=0
	Removes all the display units and unit of measurements from the GUI. More...

Public Attributes
boost::signalslib::signal< void()>	signal_currentObjectTypeChanged
	Used to signal the logic class when the currently selected object type, e.g. More...

boost::signalslib::signal < void(const std::string &displayUnitCollectionName, const std::string &displayUnitName, unsigned int unitEnumValue)>	signal_displayUnitUnitChanged
	Used to signal the logic class when the unit of measurement to use for a display unit has changed in the GUI. More...

boost::signalslib::signal < void(const std::string &displayUnitCollectionName, const std::string &displayUnitName, unsigned int decimals)>	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. More...

boost::signalslib::signal < void(bool suppressMagNorthNotation)>	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. More...

Detailed Description

Interface for the settings widget to communicate with its logic.

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

displayUnitCollectionName	The name of the collection the display unit is in.
displayUnitName	The name of the display unit of interest.
type	The 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

displayUnitCollectionName	The name of the collection the display unit is in.
displayUnitName	The name of the display unit of interest.
unitEnumValue	The 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

displayUnitCollectionName	The name of the collection the display unit is in.
displayUnitName	The name of the display unit of interest.
decimals	The 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

displayUnitCollectionName	The name of the collection the display unit is in.
displayUnitName	The name of the display unit of interest.
newDisplayName	The 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

displayUnitCollectionName	The name of the collection the display unit is in.
displayUnitName	The name of the display unit of interest.
newDisplayName	The 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

objectType The 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

displayUnitType	The unsigned integer value that corresponds to a physical quantity, in the DisplayUnitType enumeration, the display unit is measuring.
name	The name of the unit of measurement.
unitEnumValue	The enumeration value corresponding to the unit of measurement being added.

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCoreQt/DtDisplayUnitsSettingsInterface.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation