IPatientUserPreference.h

//========================================================================================
// 
// $File$
// 
// Owner: Yeming Liu
// 
// $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.
// 
// 
// Purpose: Interface for handling patient user preference. This is a session preference. 
// 
//========================================================================================

#ifndef __IPATIENTUSERPREFERENCE__
#define __IPATIENTUSERPREFERENCE__

#define kMinPatientUserDelay -1

#define kMaxPatientUserDelay 10000

#ifndef __ODFRC__

// ----- Interfaces -----

#include "IPMUnknown.h"

// ----- ID.h files -----

#include "LayoutID.h"

class IPatientUserPreference : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IPATIENTUSERPREFERENCE };
 
 typedef enum { kPatientUserModeOff = -1, 
 kPatientUserWithNoDelay = 0, 
 kPatientUserWithFastDelay = 330, // milliseconds
 kPatientUserWithStandardDelay = 500, // milliseconds
 kPatientUserWithLongDelay = 1000 // milliseconds
 } PatientUserDelayMode;

 virtual void SetPatientUserDelayTime(const int32& milliseconds) = 0;

 virtual int32 GetPatientUserDelayTime() const = 0;
};

#endif // __ODFRC__
#endif //__IPATIENTUSERPREFERENCE__