CP_Alerts::CP_OSAlert Class Reference

The alerts in this class use the native OS alert handling APIs to display the alerts, and not CPLAT UI elements. More...

List of all members.

Public Types
enum	{ kCP_AlertType_StopAlert = 0, kCP_AlertType_NoteAlert = 1, kCP_AlertType_CautionAlert = 2, kCP_AlertType_PlainAlert = 3 }
Static Public Member Functions
static void	ShowAlert (const CP_String &inMessage, const CP_String &inDescription)
static SInt16	ShowAlert (const CP_String &inMessage, SInt16 inAlertType, bool inShowCancel)
Static Private Member Functions
static void	ShowAlert_Imp (const CP_String &inMessage, const CP_String &inDescription)
static SInt16	ShowAlert_Imp (const CP_String &inMessage, SInt16 inAlertType, bool inShowCancel)

---

Detailed Description

        void DisplayMessage()
        {
            CP_String       message( CP_T("My message goes here") );
            CP_String       description( CP_T("This is where I would display a description to the user.") );
            
            CP_Alerts::CP_OSAlert::ShowAlert( message, inDescription );
        }

---

Member Enumeration Documentation

anonymous enum

Enumeration values: kCP_AlertType_StopAlert  Stop icon is displayed for this alert. kCP_AlertType_NoteAlert  Note icon is displayed for this alert. kCP_AlertType_CautionAlert  Caution icon is displayed for this alert. kCP_AlertType_PlainAlert  No icon is displayed for this alert.

---

Member Function Documentation

static void CP_Alerts::CP_OSAlert::ShowAlert (  const CP_String &  inMessage, const CP_String &  inDescription )  [static]

static SInt16 CP_Alerts::CP_OSAlert::ShowAlert (  const CP_String &  inMessage, SInt16  inAlertType, bool  inShowCancel )  [static]

static void CP_Alerts::CP_OSAlert::ShowAlert_Imp (  const CP_String &  inMessage, const CP_String &  inDescription )  [static, private]

static SInt16 CP_Alerts::CP_OSAlert::ShowAlert_Imp (  const CP_String &  inMessage, SInt16  inAlertType, bool  inShowCancel )  [static, private]

---

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

• CP_Alerts.h

---