DtAssistantPopupMsgMgr Class Reference

Processes popup messages from RTI components. More...

Inheritance diagram for DtAssistantPopupMsgMgr:

Collaboration diagram for DtAssistantPopupMsgMgr:

Public Slots
void	processPopupDismiss ()
	Processes a popup dialog dismissal.
void	popup (const MAKRti::DtString &text, int sourceCompId, const MAKRti::DtString &advancedText)
	Displays a message in a popup dialog from the given source component.
void	popup (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText)
	Displays a message in a popup dialog from the given source name.
void	displayPopupsAsNotifications (bool val)
	Updates whether messages should be displayed as notifications instead of in popup dialogs.
Public Slots inherited from DtAssistantMgr
void	displayWarningDialogs ()
	Displays all warning dialogs.

Public Member Functions
	DtAssistantPopupMsgMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter, DtBoost::shared_ptr< DtAssistantComponentMgr > compMgr)
	Constructor.
virtual	~DtAssistantPopupMsgMgr ()
	Destructor.
virtual void	tick ()
	Performs tasks that need to be completed periodically.
Public Member Functions inherited from DtAssistantMgr
	DtAssistantMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtAssistantSignalRouter &signalRouter)
	Constructor.
virtual	~DtAssistantMgr ()
	Destructor.
virtual void	initialize ()
	Initializes this manager just prior to beginning assistant processing.
virtual void	startShutdown ()
	Performs any necessary processing at the start of shutdown.
virtual bool	dialogsVisible () const
	Determines if there are any visible dialogs for which this manager is responsible.
virtual void	configWidget (DtAssistantConfigWidget **widget, QIcon &icon, QString &name, DtPreferencesPage &pageId)
	Retrieves a widget which will be placed in the configuration dialog for configuring user preferences.
virtual void	updateConfigWidget ()
	Forces the configuration widget to be updated.
virtual void	processConfigWidgetAccept ()
	Process the changes that were accepted in the configuration widget.

Protected Attributes
DtAssistantMsgQueue	myPopupMsgQueue
	The queue which holds messages which will produce popup dialogs.
DtBoost::shared_ptr < DtAssistantComponentMgr >	myCompMgr
	The manager that keeps track of all local RTI components.
bool	myDisplayPopupsAsNotifications
	Whether all messages should be displayed as notification instead of in a popup dialog.
DtAssistantPopupDialog *	myPopupDialog
	The dialog used to display popup messages.
Protected Attributes inherited from DtAssistantMgr
DtBoost::shared_ptr < DtRtiAssistantServer >	myServer
	The Assistant server from which new messages will arrive from local RTI components.
DtBoost::shared_ptr < DtRtiAssistantPeer >	myPeer
	The Assistant peer which communicates with other Assistants.
std::set< QDialog * >	myUnparentedDialogs
	All unparented dialogs that are created by the GUI should be added to this set.
std::set< QMainWindow * >	myMainWindows
	All main windows that are created by the GUI should be added to this set.
std::set< QDialog * >	myWarningDialogs
	Set of the popup dialogs, either parented or unparented, which, when active, should cause a warning icon to be displayed.

Private Member Functions
	DtAssistantPopupMsgMgr (DtAssistantPopupMsgMgr const &)
	Copy Constructor not implemented – Copy Not Allowed!
DtAssistantPopupMsgMgr &	operator= (DtAssistantPopupMsgMgr const &)
	Assignment not implemented – Assignment Not Allowed!

Message Callbacks
Callbacks for popup messages
static void	addPopupMsgToQueue (const DtAssistantPopupMsg &msg, void *usr)
	Callback to add popup message to queue.
static void	processPopupMsg (const DtAssistantPopupMsg &msg, void *usr)
	Callback to process a popup message from a client.
virtual void	addPopupMsgToQueue (const DtAssistantPopupMsg &msg)
	Called by the callback function to add a message to the queue.
virtual void	processPopupMsg (const DtAssistantPopupMsg &msg)
	Popup the content of the DtAssistantPopupMsg. Called by the callback fcn.

Additional Inherited Members
Signals inherited from DtAssistantMgr
void	warningDialogDisplayed ()
	Emitted when a warning dialog is displayed.
void	warningDialogDismissed ()
	Emitted when a warning dialog is dismissed.
void	popupRequested (const MAKRti::DtString &text, int sourceCompId, const MAKRti::DtString &advancedText)
	Emitted when a popup dialog should be displayed.
void	popupRequested (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText)
	Emitted when a popup dialog should be displayed.
void	notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId, bool logOnly)
	Emitted when a notification should be displayed.
void	notificationRequested (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source, bool logOnly)
	Emitted when a notification should be displayed.
Protected Member Functions inherited from DtAssistantMgr
void	startDialog (QDialog *dlg, bool inTaskbar, bool warningDialog)
	Sets up the given widget as a dialog.
void	finishDialog (QDialog *dlg)
	Should be called prior to deleting any dialog started with startDialog.
void	showDialog (QDialog *dlg)
	Shows the dialog.
void	startMainWindow (QMainWindow *dlg)
	Sets up a main window dialog.
void	finishMainWindow (QMainWindow *dlg)
	Should be called prior to deleting any dialog started with startMainWindow.
void	showMainWindow (QMainWindow *dlg)
	Shows the dialog.
void	showPopup (const MAKRti::DtString &text, int sourceCompId=-1, const MAKRti::DtString &advancedText=MAKRti::DtString::nullString())
	Displays a popup message with the given text, advanced text, and name of the given source component.
void	showPopup (const MAKRti::DtString &text, const MAKRti::DtString &source, const MAKRti::DtString &advancedText=MAKRti::DtString::nullString())
	Displays a popup message with the given text, advanced text, and source name.
void	displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
	Displays and logs a notification from the given component.
void	displayNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
	Displays and logs notification with the given component name.
void	logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, int sourceCompId=-1)
	Logs a notification from the given component, does not display.
void	logNotification (const MAKRti::DtString &message, MAKRti::DtNotifyLevelType notifyLevel, const MAKRti::DtString &source)
	Logs a notification with the given component name, does not display.
Static Protected Attributes inherited from DtAssistantMgr
static QIcon	theRtiIcon
	The icons used by the RTI Assistant.
static QIcon	theSmallRtiIcon
static QIcon	theWebIcon
static QIcon	theNotifyRtiIcon
static QIcon	theWarningRtiIcon
static QIcon	thePreferencesIcon
static QIcon	theAboutIcon
static QIcon	theHelpIcon
static bool	theIconsAreLoaded
	Whether or not the icons have yet been loaded.

Detailed Description

Processes popup messages from RTI components.

Constructor & Destructor Documentation

DtAssistantPopupMsgMgr::DtAssistantPopupMsgMgr	(	DtBoost::shared_ptr< DtRtiAssistantServer >	server,
		DtBoost::shared_ptr< DtRtiAssistantPeer >	peer,
		DtAssistantSignalRouter &	signalRouter,
		DtBoost::shared_ptr< DtAssistantComponentMgr >	compMgr
	)

Constructor.

virtual DtAssistantPopupMsgMgr::~DtAssistantPopupMsgMgr ( )

virtual

Destructor.

DtAssistantPopupMsgMgr::DtAssistantPopupMsgMgr ( DtAssistantPopupMsgMgr const &  )

private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

static void DtAssistantPopupMsgMgr::addPopupMsgToQueue ( const DtAssistantPopupMsg &  msg, void *  usr  )

staticprotected

Callback to add popup message to queue.

Messages which produce popup notifications should be added to a queue in order to be processed one at a time. Two popups should not be displayed at the same time.

virtual void DtAssistantPopupMsgMgr::addPopupMsgToQueue ( const DtAssistantPopupMsg &  msg )

protectedvirtual

Called by the callback function to add a message to the queue.

void DtAssistantPopupMsgMgr::displayPopupsAsNotifications ( bool  val )

slot

Updates whether messages should be displayed as notifications instead of in popup dialogs.

DtAssistantPopupMsgMgr& DtAssistantPopupMsgMgr::operator= ( DtAssistantPopupMsgMgr const &  )

private

Assignment not implemented – Assignment Not Allowed!

void DtAssistantPopupMsgMgr::popup ( const MAKRti::DtString &  text, int  sourceCompId, const MAKRti::DtString &  advancedText  )

slot

Displays a message in a popup dialog from the given source component.

void DtAssistantPopupMsgMgr::popup ( const MAKRti::DtString &  text, const MAKRti::DtString &  source, const MAKRti::DtString &  advancedText  )

slot

Displays a message in a popup dialog from the given source name.

void DtAssistantPopupMsgMgr::processPopupDismiss ( )

slot

Processes a popup dialog dismissal.

static void DtAssistantPopupMsgMgr::processPopupMsg ( const DtAssistantPopupMsg &  msg, void *  usr  )

staticprotected

Callback to process a popup message from a client.

virtual void DtAssistantPopupMsgMgr::processPopupMsg ( const DtAssistantPopupMsg &  msg )

protectedvirtual

Popup the content of the DtAssistantPopupMsg. Called by the callback fcn.

virtual void DtAssistantPopupMsgMgr::tick ( )

virtual

Performs tasks that need to be completed periodically.

Reimplemented from DtAssistantMgr.

Member Data Documentation

DtBoost::shared_ptr<DtAssistantComponentMgr> DtAssistantPopupMsgMgr::myCompMgr

protected

The manager that keeps track of all local RTI components.

bool DtAssistantPopupMsgMgr::myDisplayPopupsAsNotifications

protected

Whether all messages should be displayed as notification instead of in a popup dialog.

DtAssistantPopupDialog* DtAssistantPopupMsgMgr::myPopupDialog

protected

The dialog used to display popup messages.

DtAssistantMsgQueue DtAssistantPopupMsgMgr::myPopupMsgQueue

protected

The queue which holds messages which will produce popup dialogs.

Only one may be processed at a time, but this should not prevent the processing of other messages.

---

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

• popupMsgMgr.h