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 Member Functions
	DtAssistantPopupMsgMgr (DtBoost::shared_ptr< DtRtiAssistantServer > server, DtBoost::shared_ptr< DtRtiAssistantPeer > peer, DtBoost::shared_ptr< DtAssistantPreferencesInfoMgr > prefMgr, DtBoost::shared_ptr< DtAssistantComponentMgr > compMgr)
	Constructor.
virtual	~DtAssistantPopupMsgMgr ()
	Destructor.
virtual void	tick ()
	Performs tasks that need to be completed periodically.
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.
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.

Detailed Description

Processes popup messages from RTI components.

Constructor & Destructor Documentation

DtAssistantPopupMsgMgr::DtAssistantPopupMsgMgr	(	DtBoost::shared_ptr< DtRtiAssistantServer >	server,
		DtBoost::shared_ptr< DtRtiAssistantPeer >	peer,
		DtBoost::shared_ptr< DtAssistantPreferencesInfoMgr >	prefMgr,
		DtBoost::shared_ptr< DtAssistantComponentMgr >	compMgr
	)

Constructor.

References DtAssistantPopupMsg::addCallback(), addPopupMsgToQueue(), connect(), displayPopupsAsNotifications(), myPopupDialog, myPopupMsgQueue, DtAssistantMgr::myServer, processPopupDismiss(), processPopupMsg(), and DtAssistantMgr::startDialog().

DtAssistantPopupMsgMgr::~DtAssistantPopupMsgMgr ( ) [virtual]

Destructor.

References addPopupMsgToQueue(), DtAssistantMgr::finishDialog(), myPopupDialog, myPopupMsgQueue, DtAssistantMgr::myServer, processPopupMsg(), and DtAssistantPopupMsg::removeCallback().

DtAssistantPopupMsgMgr::DtAssistantPopupMsgMgr ( DtAssistantPopupMsgMgr const & ) [private]

Copy Constructor not implemented -- Copy Not Allowed!

Member Function Documentation

void DtAssistantPopupMsgMgr::addPopupMsgToQueue	(	const DtAssistantPopupMsg &	msg,
		void *	usr
	)		`[static, protected]`

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.

Referenced by DtAssistantPopupMsgMgr(), and ~DtAssistantPopupMsgMgr().

void DtAssistantPopupMsgMgr::addPopupMsgToQueue ( const DtAssistantPopupMsg & msg ) [protected, virtual]

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

References DtAssistantMsgQueue::addMsg(), DtAssistantPopupMsg::advancedText(), DtAssistantMgr::displayNotification(), myDisplayPopupsAsNotifications, myPopupMsgQueue, DtAssistantMgr::myServer, and DtAssistantPopupMsg::text().

void DtAssistantPopupMsgMgr::displayPopupsAsNotifications ( bool val ) [slot]

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

References myDisplayPopupsAsNotifications.

Referenced by DtAssistantPopupMsgMgr().

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.

References myCompMgr, and DtAssistantComponentInfo::name().

Referenced by processPopupMsg().

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.

References DtAssistantMgr::displayNotification(), myDisplayPopupsAsNotifications, myPopupDialog, DtAssistantPopupDialog::setNotification(), and DtAssistantMgr::showDialog().

void DtAssistantPopupMsgMgr::processPopupDismiss ( ) [slot]

Processes a popup dialog dismissal.

References DtAssistantMsgQueue::finishProcessMsg(), and myPopupMsgQueue.

Referenced by DtAssistantPopupMsgMgr().

void DtAssistantPopupMsgMgr::processPopupMsg	(	const DtAssistantPopupMsg &	msg,
		void *	usr
	)		`[static, protected]`

Callback to process a popup message from a client.

Referenced by DtAssistantPopupMsgMgr(), and ~DtAssistantPopupMsgMgr().

void DtAssistantPopupMsgMgr::processPopupMsg ( const DtAssistantPopupMsg & msg ) [protected, virtual]

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

References DtAssistantPopupMsg::advancedText(), DtAssistantMsgQueue::currentCompId(), myCompMgr, myPopupMsgQueue, DtAssistantComponentInfo::name(), popup(), and DtAssistantPopupMsg::text().

void DtAssistantPopupMsgMgr::tick ( ) [virtual]

Performs tasks that need to be completed periodically.

Reimplemented from DtAssistantMgr.

References DtAssistantMsgQueue::beginProcessMsg(), and myPopupMsgQueue.

Member Data Documentation

DtBoost::shared_ptr<DtAssistantComponentMgr> DtAssistantPopupMsgMgr::myCompMgr [protected]

The manager that keeps track of all local RTI components.

Referenced by popup(), and processPopupMsg().

bool DtAssistantPopupMsgMgr::myDisplayPopupsAsNotifications [protected]

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

Referenced by addPopupMsgToQueue(), displayPopupsAsNotifications(), and popup().

DtAssistantPopupDialog* DtAssistantPopupMsgMgr::myPopupDialog [protected]

The dialog used to display popup messages.

Referenced by DtAssistantPopupMsgMgr(), popup(), and ~DtAssistantPopupMsgMgr().

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.

Referenced by addPopupMsgToQueue(), DtAssistantPopupMsgMgr(), processPopupDismiss(), processPopupMsg(), tick(), and ~DtAssistantPopupMsgMgr().

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

Public Slots

Public Member Functions

Protected Attributes

Private Member Functions

Message Callbacks

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation