VR-Exchange 2.4 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Private Member Functions
MAKVrExchange::DtGenericUserInterface Class Reference

An abstract version of a Broker Interface. More...

Inheritance diagram for MAKVrExchange::DtGenericUserInterface:
Inheritance graph
[legend]

Public Member Functions

 DtGenericUserInterface ()
 Constructor.
virtual ~DtGenericUserInterface ()
 Destructor.
Broker Dialog Interface
virtual void show ()=0
 Called when a request has been made to display the UI.
virtual void showConfigurationOnly ()
 Called when a request has been made to display the UI.
virtual void objectDiscovered (const DtBrokerObject *brokerObject)=0
 Function called when an object is discovered.
virtual void objectUpdated (const DtBrokerObject *brokerObject)=0
 Function called when an object is updated.
virtual void objectRemoved (const DtBrokerObject *brokerObject)=0
 Function called when an object is removed.
virtual void addTranslator (const char *name, bool reflectStatus, bool publishStatus, bool debugging)=0
 Called when a translator is added.
virtual void deleteTranslator (const char *name)=0
 Called when a translator is removed.
virtual void updateTranslator (const char *name, bool reflectStatus, bool publishStatus, bool debugging)=0
 Called when a translator's information has changed.
virtual void revertSettings ()=0
 Refreshes the GUI with the saved settings.

Private Member Functions

 DtGenericUserInterface (const DtGenericUserInterface &other)
 Copy constructor not implemented - cannot be copied.
DtGenericUserInterfaceoperator= (const DtGenericUserInterface &other)
 Assignment operator not implemented - cannot be copied.

Detailed Description

An abstract version of a Broker Interface.

Constructor & Destructor Documentation

MAKVrExchange::DtGenericUserInterface::DtGenericUserInterface ( )
inline

Constructor.

virtual MAKVrExchange::DtGenericUserInterface::~DtGenericUserInterface ( )
inlinevirtual

Destructor.

MAKVrExchange::DtGenericUserInterface::DtGenericUserInterface ( const DtGenericUserInterface other)
private

Copy constructor not implemented - cannot be copied.

Member Function Documentation

virtual void MAKVrExchange::DtGenericUserInterface::addTranslator ( const char *  name,
bool  reflectStatus,
bool  publishStatus,
bool  debugging 
)
pure virtual
virtual void MAKVrExchange::DtGenericUserInterface::deleteTranslator ( const char *  name)
pure virtual
virtual void MAKVrExchange::DtGenericUserInterface::objectDiscovered ( const DtBrokerObject brokerObject)
pure virtual

Function called when an object is discovered.

Parameters
[in]brokerObjectThe object discovered.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::objectRemoved ( const DtBrokerObject brokerObject)
pure virtual

Function called when an object is removed.

Parameters
[in]brokerObjectThe object removed.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::objectUpdated ( const DtBrokerObject brokerObject)
pure virtual

Function called when an object is updated.

Parameters
[in]brokerObjectThe object updated.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

DtGenericUserInterface& MAKVrExchange::DtGenericUserInterface::operator= ( const DtGenericUserInterface other)
private

Assignment operator not implemented - cannot be copied.

virtual void MAKVrExchange::DtGenericUserInterface::revertSettings ( )
pure virtual

Refreshes the GUI with the saved settings.

Implemented in MAKVrExchange::DtQtUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::show ( )
pure virtual

Called when a request has been made to display the UI.

Depending on the type of UI, this may be a no-op. Shows all parts of the interface.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::showConfigurationOnly ( )
inlinevirtual

Called when a request has been made to display the UI.

Depending on the type of UI, this may be a no-op. Only shows the configuration relevant of the interface.

Reimplemented in MAKVrExchange::DtQtUserInterface.

virtual void MAKVrExchange::DtGenericUserInterface::updateTranslator ( const char *  name,
bool  reflectStatus,
bool  publishStatus,
bool  debugging 
)
pure virtual

Called when a translator's information has changed.

Implemented in MAKVrExchange::DtQtUserInterface, MAKVrExchange::DtTextUserInterface, and MAKVrExchange::DtNullUserInterface.


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

Document ID: Generated on Thu Jul 23 10:25:22 EDT 2015 from SVN revision 155065
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)