ITextControlData.h

//========================================================================================
// 
// $File$
// 
// Owner: Frits Habermann
// 
// $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: ITextControlData provides an interface for storing text along with an object, typically a widget. The interface
// is meant to be farily straightforward, with various "Set" methods for different kinds of strings (like numbers
// vs. text), and the ability to retreive the string. 
// 
//========================================================================================

#ifndef __ITEXTCONTROLDATA__
#define __ITEXTCONTROLDATA__

#include "PMTypes.h"
#include "PMString.h"
#include "widgetid.h"

class ITextControlData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITEXTCONTROLDATA };
 
 enum TextControlDataState { kDirty = 1 };

 virtual void SetString(const PMString& newString, bool16 invalidate = kTrue, 
 bool16 notifyOfChange = kTrue, bool16 isGoodString = kTrue) = 0;
 
 virtual const PMString& GetString() const = 0;
};

#endif