CAlert.h

//========================================================================================
// 
// $File$
// 
// Owner: Tom Taylor
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __CAlert__
#define __CAlert__

#include "PMString.h"
#include "UIDRef.h"


// Common Default String Constants (Don't worry, these get automatically translated)

#define kOKString "OK"
#define kCancelString "Cancel"
#define kYesString "Yes"
#define kNoString "No"

#define kNotManaged -1

#ifdef MACINTOSH
#define kSaveButtonString "Save"
#define kDontSaveButtonString "Don't Save"
#else
#define kSaveButtonString kYesString
#define kDontSaveButtonString kNoString
#endif

class AlertImplementation;

class CAlert
{
public:
 // ----- CAlerts -----
 
 // These functions are truly modal CAlerts. When one of these CAlert
 // function is called, an CAlert is displayed and control isn't returned
 // to the caller until the user dismisses the CAlert.
 
 static void Initialize(AlertImplementation* alertImpl);
 
 static void InformationAlert(const PMString& message);
 static void InformationAlert(const PMString& message, const UIDRef& target, ErrorCode errorCode);

 static void WarningAlert(const PMString& message);
 static void WarningAlert(const PMString& message, const UIDRef& target, ErrorCode errorCode);

 static void ErrorAlert(const PMString& message);
 static void ErrorAlert(const PMString& message, const UIDRef& target, ErrorCode errorCode);
 
 // ----- Flexible Alert Function -----

 typedef enum { eNoIcon, eInformationIcon, eWarningIcon, eErrorIcon, eQuestionIcon } eAlertIcon;
 
 static int16 ModalAlert( const PMString& message,
 const PMString& button1String,
 const PMString& button2String,
 const PMString& button3String,
 int16 defaultButton, 
 int16 iconID 
 );
 
 
 static int16 ModalAlert( const PMString& message,
 const PMString& button1String,
 const PMString& button2String,
 const PMString& button3String,
 int16 defaultButton, 
 int16 iconID, 
 const UIDRef& target,
 const ErrorCode errorCode
 );
 
 

 static int16 WarningAlertWithDontShowAgain(const PMString& message, 
 int32 dontShowID, 
 bool8 bShowCancelButton = kFalse,
 int32 iconID = eWarningIcon, 
 const PMString& title = kNullString,
 const PMString& strOK = kNullString,
 const PMString& strCancel = kNullString,
 const int16 returnValueIfHidden = 1 // OK
 );
 
 static int16 AlertWithApplyToAll(bool16 *applyAllState, // pass the initial state, and get the result of the applyall checkbox
 const PMString& message, 
 const PMString& Button1Str = kNullString,
 const PMString& Button2Str = kNullString,
 const PMString& Button3Str = kNullString,
 const PMString& title = kNullString,
 int32 iconID = eWarningIcon 
 );
 
 static void SetShowAlerts(bool16 showAlerts);
 
 static bool16 GetShowAlerts();
 
 static bool16 GetShowModalStartupUI( );

 static bool16 GetIsAlertShown();

 static void SetLastEventCausedAlert(bool16);

 static bool16 LastEventCausedAlert();
 

 static void StartupErrorAlert(const PMString& message);
 
 static void StartupWarningAlert(const PMString& message);

 // There were only two clients of the old StartupModalAlert and the API is too complex to support
 // given that all they needed were Yes/No and Yes/No/Cancel.
 
 enum { eOKOnly, eYesNo, eOKCancel, eYesNoCancel } eStartupAlertButtonConfig;
 
 static int16 StartupModalAlert( const PMString& message,
 int16 buttonConfig = eOKOnly,
 int16 defaultButton = 1, 
 int16 iconID = eWarningIcon 
 );
 

 static void SetIgnoreRefreshEvent(bool16 val);

 static bool16 GetIgnoreRefreshEvent();
public:
 static IDThreading::ThreadLocal<bool16> tl_AlertShown;
private:
 static IDThreading::ThreadLocal<bool16> tl_ShowAlerts;
 static IDThreading::ThreadLocal<bool16> tl_LastEventCausedAlert;
 static bool16 ts_ShowModalStartupUICookie;
 static bool16 ts_ShowModalStartupUI;
 static IDThreading::ThreadLocal<bool16> tl_IgnoreRefreshEvent; 
 static AlertImplementation* ts_AlertImpl;

};


#endif