VR-Exchange 2.5 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Slots | Protected Member Functions | Protected Attributes | Private Member Functions
MAKVrExchange::DtBrokerDialog Class Reference

Responsible for displaying all information about the broker. More...

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

Public Types

enum  { StatusCol = 0, NameCol = 1, IdCol = 2, MarkingTextCol = 3 }

Public Member Functions

virtual ~DtBrokerDialog ()
 Virtual DTOR.
virtual void initialize ()
 Calls other initialization methods to set up the dialog.
virtual void objectDiscovered (const DtBrokerObject *brokerObject)
virtual void objectUpdated (const DtBrokerObject *brokerObject)
virtual void objectRemoved (const DtBrokerObject *brokerObject)
virtual void addTranslator (const char *name, bool readStatus=true, bool writeStatus=true, bool debugging=false)
 Adds the translator to the list of translators.
virtual void updateTranslator (const char *name, bool reflectStatus, bool publishStatus, bool debugging)
 Updates the translator information in the list of translators.
virtual void deleteTranslator (const char *name)
 Removes the translator from the list of translators.
virtual void revertSettings ()
 Load settings from the initializer and populate the GUI.
virtual void clientsUpdated ()
 Only used in dialogs that can display clients, such as WebLVC.
- Public Member Functions inherited from MAKVrExchange::DtDialogPager
 DtDialogPager (QWidget *parent, Qt::WindowFlags f=Qt::Tool)
 CTOR.
virtual ~DtDialogPager ()
 DTOR.
virtual void addPage (QWidget *page, const QIcon &icon, const QString &label, bool showTabs)
 Add a page.
virtual void hidePage (const std::string &name)
 Keep a page hidden from view. By default all pages are shown.
virtual void showPage (const std::string &name)
 Unhide a page. By default all pages are shown.
virtual void setCurrentPage (const std::string &name)
 Set the current page by name.
virtual void setCurrentPage (int index)
 Set the current page by index.

Static Public Member Functions

static DtBrokerDialog * create (DtBroker *broker, DtBrokerInitializer *init, QWidget *parent=0)
 Static creation method.

Protected Types

typedef std::map< QString,
QWidget * > 		QtStringWidgetMap
typedef std::map< const
DtBrokerObject
*, QTreeWidgetItem * > 		BrokerObjectToListView
typedef std::map
< QTreeWidgetItem *, const
DtBrokerObject * > 		ListViewToBrokerObject
- Protected Types inherited from MAKVrExchange::DtDialogPager
typedef std::list
< QListWidgetItem * > 		ListItems
typedef std::map< std::string,
QWidget * > 		PagesByNameMap

Protected Slots

virtual void onMenuAboutToShow ()
 Receives notification that the object context menu is showing.
virtual void onTranslatorsChanged ()
 Updates the broker with the new translator state.
virtual void restartBrokerAction ()
 Tells the broker to reload its settings.
virtual void escPressed ()
 Cancels any changes and closes the dialog.
virtual void enterPressed ()
 Applies any changes and closes the dialog.
virtual void applied ()
 Applies the setting changes that have been made.
virtual void queryForRestart ()
 Query user for broker restart.
virtual void reflectedHeaderRightButtonPressedEventHandler (const QPoint &point)
 Handles a right mouse button press event for the headers of list views.
virtual void publishedHeaderRightButtonPressedEventHandler (const QPoint &point)
virtual void translatorHeaderRightButtonPressedEventHandler (const QPoint &point)
Add / Remove Filter Actions
virtual void addNameFilterAction (bool action)
 Action performed when the user creates a new name filter.
virtual void addNameFilter (const DtString &name)
 Performs name filter addition.
virtual void addTypeFilterAction (bool action)
 Action performed when the user creates a new type filter.
virtual void addTypeFilter (const DtString &entityType)
 Performs type filter addition.
virtual void addMarkingTextFilterAction (bool action)
 Action performed when the user creates a new marking text filter.
virtual void addMarkingTextFilter (const DtString &markingText)
 Performs marking text filter addition.
virtual void removeNameFilterAction (bool action)
 Action performed when the user removes a name filter.
virtual void removeNameFilter (const DtString &name)
 Performs name filter removal.
virtual void removeTypeFilterAction (bool action)
 Action performed when the user removes a type filter.
virtual void removeTypeFilter (const DtString &entityType)
 Performs type filter removal.
virtual void removeMarkingTextFilterAction (bool action)
 Action performed when the user removes a marking text filter.
virtual void removeMarkingTextFilter (const DtString &markingText)
 Performs marking text filter removal.
- Protected Slots inherited from MAKVrExchange::DtDialogPager
virtual void on_myContentsWidget_currentItemChanged (QListWidgetItem *current, QListWidgetItem *previous)
 Internal Slots.
virtual void on_myPagesWidget_currentChanged (int index)
 Internal Slots.
virtual void escPressed ()
 Internal Slots.
virtual void buttonClicked (QAbstractButton *)
 Internal Slots.
virtual void enterPressed ()
 Internal Slots.
virtual void applied ()
 Internal Slots.

Protected Member Functions

 DtBrokerDialog (DtBroker *broker, DtBrokerInitializer *init, QWidget *parent=0)
 Protected CTOR (Use ::create).
virtual void updateObjectText (const DtBrokerObject *brokerObject, QTreeWidgetItem *item, const QString &status)
 Updates the entry for the object in the reflected/published list.
virtual QTreeWidgetItem * findPublishedTranslatorGroup (const DtBrokerObject *brokerObject)
 Utility method for finding the published group for the given object's type.
virtual QTreeWidgetItem * findReflectedTranslatorGroup (const DtBrokerObject *brokerObject)
 Utility method for finding the reflected group for the given object's type.
virtual bool eventFilter (QObject *obj, QEvent *event)
 Overridden event filter method for displaying context menus.
virtual void publishedItemRightButtonPressed (QTreeWidgetItem *, QPoint)
virtual void reflectedItemRightButtonPressed (QTreeWidgetItem *, QPoint)
Initialization Methods
virtual void initObjectListViews ()
 Initializes the Object List Views (Both Published and Reflected).
virtual void initObjectListViewHeaders ()
 Initialize the headers for the object list views.
virtual void initConnectionWidget ()
 Initializes the Connection Widget.
virtual
DtConnectionSettingsWidget * 		instantiateConnectionSettingsWidget ()
 Instantiate the Connection Settings Widget.
virtual void initSettingsWidget ()
 Initializes the General Settings Widget.
virtual DtGeneralSettingsWidget * instantiateGeneralSettingsWidget ()
 Instantiate the General Settings Widget.
virtual void initFilterWidget ()
 Initializes the filter page.
virtual void initTranslatorListView ()
 Initializes the Translator List.
- Protected Member Functions inherited from MAKVrExchange::DtDialogPager
void setupGui ()
 Sets up the dialog.
void connectToSignals ()
 Connects widget signals to slots.

Protected Attributes

BrokerObjectToListView myObjectListViewMap
ListViewToBrokerObject myListViewObjectMap
QtStringWidgetMap myQStringWidgetMap
QtStringWidgetMap myPublishedTranslatorNameToItemMap
QtStringWidgetMap myReflectedTranslatorNameToItemMap
DtGenericListView * myPublishedObjectsWidget
DtGenericListView * myReflectedObjectsWidget
DtConnectionSettingsWidget * myConnectionSettingsWidget
DtGeneralSettingsWidget * myGeneralSettingsWidget
DtFilterDialog * myFiltersWidget
DtTranslatorDialog * myTranslatorsWidget
DtObjectContextMenu * myPublishedObjectContextMenu
DtObjectContextMenu * myReflectedObjectContextMenu
DtObjectContextMenu * myActiveContextMenu
QTreeWidgetItem * myCurrentRightClickItem
DtBroker * myBroker
DtColumnSelectionContextMenu * myPublishedHeaderPopupMenu
DtColumnSelectionContextMenu * myReflectedHeaderPopupMenu
DtColumnSelectionContextMenu * myTranslatorHeaderPopupMenu
DtBrokerInitializer * myBrokerInitializer
- Protected Attributes inherited from MAKVrExchange::DtDialogPager
PagesByNameMap myPagesByNameMap
QListWidget * myContentsWidget
ListItems myContentItems
QStackedWidget * myPagesWidget
QWidget * myLastWidget
QDialogButtonBox * myButtonBox
QSize myMaxItemSize

Private Member Functions

 DtBrokerDialog (const DtBrokerDialog &other)
 Copy CTOR not implemented – Do Not Copy!
DtBrokerDialog & operator= (const DtBrokerDialog &other)
 Assignment Operator not implemented – Do Not Copy!

Additional Inherited Members

- Signals inherited from MAKVrExchange::DtDialogPager
void closed ()

Detailed Description

Responsible for displaying all information about the broker.

Member Typedef Documentation

typedef std::map<const DtBrokerObject*,QTreeWidgetItem*> MAKVrExchange::DtBrokerDialog::BrokerObjectToListView
protected
typedef std::map<QTreeWidgetItem*,const DtBrokerObject*> MAKVrExchange::DtBrokerDialog::ListViewToBrokerObject
protected
typedef std::map<QString,QWidget*> MAKVrExchange::DtBrokerDialog::QtStringWidgetMap
protected

Member Enumeration Documentation

anonymous enum
Enumerator:
StatusCol 
NameCol 
IdCol 
MarkingTextCol 

Constructor & Destructor Documentation

virtual MAKVrExchange::DtBrokerDialog::~DtBrokerDialog ( )
virtual

Virtual DTOR.

MAKVrExchange::DtBrokerDialog::DtBrokerDialog ( DtBroker *  broker,
DtBrokerInitializer *  init,
QWidget *  parent = 0 
)
protected

Protected CTOR (Use ::create).

MAKVrExchange::DtBrokerDialog::DtBrokerDialog ( const DtBrokerDialog &  other)
private

Copy CTOR not implemented – Do Not Copy!

Member Function Documentation

virtual void MAKVrExchange::DtBrokerDialog::addMarkingTextFilter ( const DtString &  markingText)
protectedvirtualslot

Performs marking text filter addition.

Can be called via the right-click menu or when an add filter message is received.

virtual void MAKVrExchange::DtBrokerDialog::addMarkingTextFilterAction ( bool  action)
protectedvirtualslot

Action performed when the user creates a new marking text filter.

Creates a new marking text filter for the selected entity.

virtual void MAKVrExchange::DtBrokerDialog::addNameFilter ( const DtString &  name)
protectedvirtualslot

Performs name filter addition.

Can be called via the right-click menu or when an add filter message is received.

virtual void MAKVrExchange::DtBrokerDialog::addNameFilterAction ( bool  action)
protectedvirtualslot

Action performed when the user creates a new name filter.

Creates a new name filter for the selected entity.

virtual void MAKVrExchange::DtBrokerDialog::addTranslator ( const char *  name,
bool  readStatus = true,
bool  writeStatus = true,
bool  debugging = false 
)
virtual

Adds the translator to the list of translators.

virtual void MAKVrExchange::DtBrokerDialog::addTypeFilter ( const DtString &  entityType)
protectedvirtualslot

Performs type filter addition.

Can be called via the right-click menu or when an add filter message is received.

virtual void MAKVrExchange::DtBrokerDialog::addTypeFilterAction ( bool  action)
protectedvirtualslot

Action performed when the user creates a new type filter.

Creates a new type filter for the selected entity.

virtual void MAKVrExchange::DtBrokerDialog::applied ( )
protectedvirtualslot

Applies the setting changes that have been made.

Restarts the broker if changed settings require a restart.

virtual void MAKVrExchange::DtBrokerDialog::clientsUpdated ( )
virtual

Only used in dialogs that can display clients, such as WebLVC.

static DtBrokerDialog* MAKVrExchange::DtBrokerDialog::create ( DtBroker *  broker,
DtBrokerInitializer *  init,
QWidget *  parent = 0 
)
static

Static creation method.

Instantiates a new broker dialog.

Reimplemented in MAKVrExchange::DtDdsBroker::DtDdsBrokerDialog, MAKVrExchange::DtTenaBroker::DtTenaBrokerDialog, MAKVrExchange::DtRprBroker::DtHlaBrokerDialog, and MAKVrExchange::DtDisBroker::DtDisBrokerDialog.

virtual void MAKVrExchange::DtBrokerDialog::deleteTranslator ( const char *  name)
virtual

Removes the translator from the list of translators.

virtual void MAKVrExchange::DtBrokerDialog::enterPressed ( )
protectedvirtualslot

Applies any changes and closes the dialog.

virtual void MAKVrExchange::DtBrokerDialog::escPressed ( )
protectedvirtualslot

Cancels any changes and closes the dialog.

virtual bool MAKVrExchange::DtBrokerDialog::eventFilter ( QObject *  obj,
QEvent *  event 
)
protectedvirtual

Overridden event filter method for displaying context menus.

virtual QTreeWidgetItem* MAKVrExchange::DtBrokerDialog::findPublishedTranslatorGroup ( const DtBrokerObject *  brokerObject)
protectedvirtual

Utility method for finding the published group for the given object's type.

virtual QTreeWidgetItem* MAKVrExchange::DtBrokerDialog::findReflectedTranslatorGroup ( const DtBrokerObject *  brokerObject)
protectedvirtual

Utility method for finding the reflected group for the given object's type.

virtual void MAKVrExchange::DtBrokerDialog::initConnectionWidget ( )
protectedvirtual

Initializes the Connection Widget.

virtual void MAKVrExchange::DtBrokerDialog::initFilterWidget ( )
protectedvirtual

Initializes the filter page.

virtual void MAKVrExchange::DtBrokerDialog::initialize ( )
virtual

Calls other initialization methods to set up the dialog.

Called from the dialog's create method.

virtual void MAKVrExchange::DtBrokerDialog::initObjectListViewHeaders ( )
protectedvirtual

Initialize the headers for the object list views.

Reimplemented in MAKVrExchange::DtDdsBroker::DtDdsBrokerDialog, MAKVrExchange::DtTenaBroker::DtTenaBrokerDialog, MAKVrExchange::DtRprBroker::DtHlaBrokerDialog, and MAKVrExchange::DtDisBroker::DtDisBrokerDialog.

virtual void MAKVrExchange::DtBrokerDialog::initObjectListViews ( )
protectedvirtual

Initializes the Object List Views (Both Published and Reflected).

virtual void MAKVrExchange::DtBrokerDialog::initSettingsWidget ( )
protectedvirtual

Initializes the General Settings Widget.

virtual void MAKVrExchange::DtBrokerDialog::initTranslatorListView ( )
protectedvirtual

Initializes the Translator List.

Creates a list of translators the broker knows about. This list contains information regarding the translator's: name; enabled/disabled status; debugging on/off; and generic translation on/off.

virtual DtConnectionSettingsWidget* MAKVrExchange::DtBrokerDialog::instantiateConnectionSettingsWidget ( )
protectedvirtual

Instantiate the Connection Settings Widget.

Reimplemented in MAKVrExchange::DtTenaBroker::DtTenaBrokerDialog, MAKVrExchange::DtRprBroker::DtHlaBrokerDialog, MAKVrExchange::DtDdsBroker::DtDdsBrokerDialog, and MAKVrExchange::DtDisBroker::DtDisBrokerDialog.

virtual DtGeneralSettingsWidget* MAKVrExchange::DtBrokerDialog::instantiateGeneralSettingsWidget ( )
protectedvirtual

Instantiate the General Settings Widget.

Reimplemented in MAKVrExchange::DtTenaBroker::DtTenaBrokerDialog, MAKVrExchange::DtRprBroker::DtHlaBrokerDialog, MAKVrExchange::DtDdsBroker::DtDdsBrokerDialog, and MAKVrExchange::DtDisBroker::DtDisBrokerDialog.

virtual void MAKVrExchange::DtBrokerDialog::objectDiscovered ( const DtBrokerObject *  brokerObject)
virtual
virtual void MAKVrExchange::DtBrokerDialog::objectRemoved ( const DtBrokerObject *  brokerObject)
virtual

Reimplemented in MAKVrExchange::DtTenaBroker::DtTenaBrokerDialog.

virtual void MAKVrExchange::DtBrokerDialog::objectUpdated ( const DtBrokerObject *  brokerObject)
virtual
virtual void MAKVrExchange::DtBrokerDialog::onMenuAboutToShow ( )
protectedvirtualslot

Receives notification that the object context menu is showing.

This method checks the current selection and enables/disables the type and marking text filter menu items.

virtual void MAKVrExchange::DtBrokerDialog::onTranslatorsChanged ( )
protectedvirtualslot

Updates the broker with the new translator state.

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

Assignment Operator not implemented – Do Not Copy!

virtual void MAKVrExchange::DtBrokerDialog::publishedHeaderRightButtonPressedEventHandler ( const QPoint &  point)
protectedvirtualslot
virtual void MAKVrExchange::DtBrokerDialog::publishedItemRightButtonPressed ( QTreeWidgetItem *  ,
QPoint   
)
protectedvirtual
virtual void MAKVrExchange::DtBrokerDialog::queryForRestart ( )
protectedvirtualslot

Query user for broker restart.

virtual void MAKVrExchange::DtBrokerDialog::reflectedHeaderRightButtonPressedEventHandler ( const QPoint &  point)
protectedvirtualslot

Handles a right mouse button press event for the headers of list views.

Displays the column selection context menu. Menu will be created if it doesn't exist yet.

virtual void MAKVrExchange::DtBrokerDialog::reflectedItemRightButtonPressed ( QTreeWidgetItem *  ,
QPoint   
)
protectedvirtual
virtual void MAKVrExchange::DtBrokerDialog::removeMarkingTextFilter ( const DtString &  markingText)
protectedvirtualslot

Performs marking text filter removal.

Can be called via the right-click menu or when a remove filter message is received.

virtual void MAKVrExchange::DtBrokerDialog::removeMarkingTextFilterAction ( bool  action)
protectedvirtualslot

Action performed when the user removes a marking text filter.

Removes the marking text filter for the selected entity (if present).

virtual void MAKVrExchange::DtBrokerDialog::removeNameFilter ( const DtString &  name)
protectedvirtualslot

Performs name filter removal.

Can be called via the right-click menu or when a remove filter message is received.

virtual void MAKVrExchange::DtBrokerDialog::removeNameFilterAction ( bool  action)
protectedvirtualslot

Action performed when the user removes a name filter.

Removes the name filter for the selected entity (if present).

virtual void MAKVrExchange::DtBrokerDialog::removeTypeFilter ( const DtString &  entityType)
protectedvirtualslot

Performs type filter removal.

Can be called via the right-click menu or when a remove filter message is received.

virtual void MAKVrExchange::DtBrokerDialog::removeTypeFilterAction ( bool  action)
protectedvirtualslot

Action performed when the user removes a type filter.

Removes the type filter for the selected entity (if present).

virtual void MAKVrExchange::DtBrokerDialog::restartBrokerAction ( )
protectedvirtualslot

Tells the broker to reload its settings.

virtual void MAKVrExchange::DtBrokerDialog::revertSettings ( )
virtual

Load settings from the initializer and populate the GUI.

virtual void MAKVrExchange::DtBrokerDialog::translatorHeaderRightButtonPressedEventHandler ( const QPoint &  point)
protectedvirtualslot
virtual void MAKVrExchange::DtBrokerDialog::updateObjectText ( const DtBrokerObject *  brokerObject,
QTreeWidgetItem *  item,
const QString &  status 
)
protectedvirtual

Updates the entry for the object in the reflected/published list.

Reimplemented in MAKVrExchange::DtDdsBroker::DtDdsBrokerDialog, and MAKVrExchange::DtTenaBroker::DtTenaBrokerDialog.

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

Updates the translator information in the list of translators.

Member Data Documentation

DtObjectContextMenu* MAKVrExchange::DtBrokerDialog::myActiveContextMenu
protected
DtBroker* MAKVrExchange::DtBrokerDialog::myBroker
protected
DtBrokerInitializer* MAKVrExchange::DtBrokerDialog::myBrokerInitializer
protected
DtConnectionSettingsWidget* MAKVrExchange::DtBrokerDialog::myConnectionSettingsWidget
protected
QTreeWidgetItem* MAKVrExchange::DtBrokerDialog::myCurrentRightClickItem
protected
DtFilterDialog* MAKVrExchange::DtBrokerDialog::myFiltersWidget
protected
DtGeneralSettingsWidget* MAKVrExchange::DtBrokerDialog::myGeneralSettingsWidget
protected
ListViewToBrokerObject MAKVrExchange::DtBrokerDialog::myListViewObjectMap
protected
BrokerObjectToListView MAKVrExchange::DtBrokerDialog::myObjectListViewMap
protected
DtColumnSelectionContextMenu* MAKVrExchange::DtBrokerDialog::myPublishedHeaderPopupMenu
protected
DtObjectContextMenu* MAKVrExchange::DtBrokerDialog::myPublishedObjectContextMenu
protected
DtGenericListView* MAKVrExchange::DtBrokerDialog::myPublishedObjectsWidget
protected
QtStringWidgetMap MAKVrExchange::DtBrokerDialog::myPublishedTranslatorNameToItemMap
protected
QtStringWidgetMap MAKVrExchange::DtBrokerDialog::myQStringWidgetMap
protected
DtColumnSelectionContextMenu* MAKVrExchange::DtBrokerDialog::myReflectedHeaderPopupMenu
protected
DtObjectContextMenu* MAKVrExchange::DtBrokerDialog::myReflectedObjectContextMenu
protected
DtGenericListView* MAKVrExchange::DtBrokerDialog::myReflectedObjectsWidget
protected
QtStringWidgetMap MAKVrExchange::DtBrokerDialog::myReflectedTranslatorNameToItemMap
protected
DtColumnSelectionContextMenu* MAKVrExchange::DtBrokerDialog::myTranslatorHeaderPopupMenu
protected
DtTranslatorDialog* MAKVrExchange::DtBrokerDialog::myTranslatorsWidget
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Wed Dec 21 15:05:11 EST 2016 from SVN revision 171891
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)