IEditBoxAttributes.h

//========================================================================================
// 
// $File$
// 
// Owner: Lance Bushore
// 
// $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 __IEditBoxAttributes__
#define __IEditBoxAttributes__

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

#ifdef MACINTOSH
 const int32 kEndOfRange = 32767;
#endif
#ifdef WINDOWS
 const int32 kEndOfRange = -1;
#endif

class IEditBoxAttributes : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IEDITBOXATTRIBUTES };

 virtual void SetNudgeButtonWidgetID(const WidgetID& nudgeButton) = 0;

 virtual WidgetID GetNudgeButtonWidgetID() const = 0;

 virtual void SetSmallNudgeAmount(const PMReal& increment) = 0;

 virtual PMReal GetSmallNudgeAmount() const = 0;
 
 virtual void SetLargeNudgeAmount(const PMReal& increment) = 0;

 virtual PMReal GetLargeNudgeAmount() const = 0;

 virtual CharCounter GetMaxNumChars() const = 0;

 virtual void SetMaxNumChars(const CharCounter& maxNumChars) = 0;

 virtual bool16 IsEditboxReadOnly() const = 0;

 virtual void SetEditboxReadOnly(const bool16& readOnly) = 0;

 virtual bool16 ShouldNotifyEveryStroke() const = 0;

 virtual void SetNotifyEveryStroke(const bool16& flag) = 0;
 
 virtual void SelectRange(const CharCounter& startOfRange, const CharCounter& endOfRange = kEndOfRange) = 0;
 
 
 virtual CharCounter GetStartOfSelection() const = 0;

 virtual CharCounter GetEndOfSelection() const = 0;

 virtual bool16 IsMultiLine() const = 0;
}; 

#endif // __IEditBoxAttributes__