AlertMessage Struct Reference

#include <TaskInfo.h>

Public Types
enum	AlertType { kGenericMsg, kInformationMsg, kWarningMsg, kErrorMsg }

Public Member Functions
	AlertMessage ()
	AlertMessage (AlertType type, PMString const &message)

Public Attributes
AlertType	fAlertType
PMString	fMessage

Detailed Description

Encapsulates the necessary data so alerts from background tasks can be presented to the user.

Member Enumeration Documentation

enum AlertMessage::AlertType

enumeration of the different types of alerts

Enumerator
kWarningMsg	an alert that needs the users attention
kErrorMsg	an alert representing a failure condition

Constructor & Destructor Documentation

AlertMessage::AlertMessage ( )

inline

Default constructor

AlertMessage::AlertMessage ( AlertType  type, PMString const &  message  )

inline

Construct an AlertMessage

Parameters

[in]	type	AlertType describing the kind of alert message
[in]	message	A translated message

Member Data Documentation

AlertType AlertMessage::fAlertType

the type of alert

PMString AlertMessage::fMessage

the localized message