MAK RTIspy API Documentation for HLA 1.3
List of all members | Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes
DtAssistantNotifyDialog Class Reference

Dialog widget to display important notifications and events by the RTI Assistant. More...

+ Inheritance diagram for DtAssistantNotifyDialog:
+ Collaboration diagram for DtAssistantNotifyDialog:

Public Slots

virtual void fadeDialog ()
 Fades the dialog another step.
virtual void hideDialog ()
 Clears and hides the dialog.

Signals

void showHistorySelected ()
 Signal which is emitted if the user chooses to view the notification history.
void faded ()
 Signal which is emitted if the dialog fades out without user acknowledgment.
void dismissed ()
 Signal which is emitted if the dialog is actively dismissed by the user.

Public Member Functions

 DtAssistantNotifyDialog (QWidget *parent, const QSystemTrayIcon *trayIcon)
 Constructor.
virtual ~DtAssistantNotifyDialog ()
 Destructor.
virtual void showNotification (const QString &notification, QColor color)
 Adds the notification text to the dialog and displays it if not currently visible.

Protected Member Functions

virtual void positionDialog ()
 Repositions the dialog relative to the tray icon.

Protected Attributes

Ui::AssistantNotifyDialog myUiImpl
 The GUI implementation of the widget.
QTimer * myTimer
 Timer used to timeout dialog and perform fading.
const QSystemTrayIcon * myTrayIcon
 The RTI Assistant tray icon is needed in order to determine the position of the notify dialog.
QSize myOriginalSize
 The original size of the dialog.

Detailed Description

Dialog widget to display important notifications and events by the RTI Assistant.

DtAssistantNotifyDialog is used by the Assistant to display brief notifications which may be of interest to the user. These notifications will appear in a temporary dialog near the Assistant tray icon and will fade out after several seconds.

Constructor & Destructor Documentation

DtAssistantNotifyDialog::DtAssistantNotifyDialog ( QWidget parent,
const QSystemTrayIcon *  trayIcon 
)
DtAssistantNotifyDialog::~DtAssistantNotifyDialog ( )
virtual

Destructor.

Member Function Documentation

void DtAssistantNotifyDialog::dismissed ( )
signal

Signal which is emitted if the dialog is actively dismissed by the user.

Referenced by DtAssistantNotifyDialog().

void DtAssistantNotifyDialog::faded ( )
signal

Signal which is emitted if the dialog fades out without user acknowledgment.

Referenced by fadeDialog().

void DtAssistantNotifyDialog::fadeDialog ( )
virtualslot

Fades the dialog another step.

Dialog is hidden and the text is cleared once it reaches full transparency.

References faded(), hideDialog(), and myTimer.

Referenced by DtAssistantNotifyDialog().

void DtAssistantNotifyDialog::hideDialog ( )
virtualslot

Clears and hides the dialog.

References myOriginalSize, myTimer, and myUiImpl.

Referenced by DtAssistantNotifyDialog(), and fadeDialog().

void DtAssistantNotifyDialog::positionDialog ( )
protectedvirtual

Repositions the dialog relative to the tray icon.

References myTrayIcon.

Referenced by showNotification().

void DtAssistantNotifyDialog::showHistorySelected ( )
signal

Signal which is emitted if the user chooses to view the notification history.

Referenced by DtAssistantNotifyDialog().

void DtAssistantNotifyDialog::showNotification ( const QString &  notification,
QColor  color 
)
virtual

Adds the notification text to the dialog and displays it if not currently visible.

References myTimer, myUiImpl, and positionDialog().

Member Data Documentation

QSize DtAssistantNotifyDialog::myOriginalSize
protected

The original size of the dialog.

Referenced by DtAssistantNotifyDialog(), and hideDialog().

QTimer* DtAssistantNotifyDialog::myTimer
protected

Timer used to timeout dialog and perform fading.

Referenced by DtAssistantNotifyDialog(), fadeDialog(), hideDialog(), and showNotification().

const QSystemTrayIcon* DtAssistantNotifyDialog::myTrayIcon
protected

The RTI Assistant tray icon is needed in order to determine the position of the notify dialog.

Referenced by positionDialog().

Ui::AssistantNotifyDialog DtAssistantNotifyDialog::myUiImpl
protected

The GUI implementation of the widget.

Referenced by DtAssistantNotifyDialog(), hideDialog(), and showNotification().


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

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)