ITextDataValidation.h

//========================================================================================
// 
// $File$
// 
// Owner: ???
// 
// $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.
// 
// 
// [f************************************************************************
// ITextDataValidation.h 
// 
// f]**********************************************************************
// 
//========================================================================================

#ifndef __ITextDataValidation__
#define __ITextDataValidation__

#include "IPMUnknown.h"
#include "PMString.h"
#include "widgetid.h"

class ITextDataValidation : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_ITEXTDATAVALIDATION };

 typedef enum
 {
 kNoError = 0,
 kNoEntryWhenRequired, 
 kInvalidValue, 
 kValueOutOfRange,
 kInvalidStartPage,
 kInvalidEndPage,
 kUnknownPagesInRange,
 kAmbiguousPage
 } RangeError;

 virtual void EnableRangeChecking(const bool16& checkingOn) = 0;

 virtual bool16 RangeCheckingEnabled() const = 0;

 virtual bool16 IsBlankEntryAllowed() const = 0;

 virtual void AllowBlankEntry(const bool16& blankAllowed) = 0;

 virtual bool16 IsEntryLegal() = 0; 

 virtual PMString GetErrorString() = 0; 

 virtual PMReal GetUpperLimit() const = 0;

 virtual void SetUpperLimit(const PMReal& limit) = 0;

 virtual PMReal GetLowerLimit() const = 0;

 virtual void SetLowerLimit(const PMReal& limit) = 0;

 virtual bool16 GetRestoreLastValueOnError() const = 0;

 virtual void SetRestoreLastValueOnError(const bool16& restoreValue) = 0;
}; 



#endif // __ITextDataValidation__